Update Payment Channel

curl --request PATCH \
  --url https://api.palpluss.com/v1/payment-wallet/channels/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Collections Paybill"
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "PAYMENT_WALLET",
    "shortcode": "123456",
    "name": "Main Collections Paybill",
    "accountNumber": "ACCOUNT001",
    "isDefault": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "requestId": "c1b2a3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "success": false,
  "error": {
    "message": "Invalid phone number format.",
    "code": "INVALID_PHONE",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

{
  "success": false,
  "error": {
    "message": "Invalid or revoked API key.",
    "code": "INVALID_API_KEY",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

{
  "success": false,
  "error": {
    "message": "Transaction not found.",
    "code": "TRANSACTION_NOT_FOUND",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

PATCH

payment-wallet

channels

{id}

curl --request PATCH \
  --url https://api.palpluss.com/v1/payment-wallet/channels/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Collections Paybill"
}
'

{
  "success": true,
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "category": "PAYMENT_WALLET",
    "shortcode": "123456",
    "name": "Main Collections Paybill",
    "accountNumber": "ACCOUNT001",
    "isDefault": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "requestId": "c1b2a3d4-e5f6-7890-abcd-ef1234567890"
}

{
  "success": false,
  "error": {
    "message": "Invalid phone number format.",
    "code": "INVALID_PHONE",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

{
  "success": false,
  "error": {
    "message": "Invalid or revoked API key.",
    "code": "INVALID_API_KEY",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

{
  "success": false,
  "error": {
    "message": "Transaction not found.",
    "code": "TRANSACTION_NOT_FOUND",
    "details": {}
  },
  "requestId": "a1b2c3d4-0000-0000-0000-000000000000"
}

Update channel metadata without affecting active transactions.

Partial updates

Send only the fields you want to change. Omit everything else.

# Rename a channel
curl -X PATCH "https://api.palpluss.com/v1/payment-wallet/channels/CHANNEL_ID" \
  -u "$PALPLUSS_API_KEY:" \
  -H "Content-Type: application/json" \
  -d '{"name": "Primary Collections Paybill"}'

# Set a channel as default
curl -X PATCH "https://api.palpluss.com/v1/payment-wallet/channels/CHANNEL_ID" \
  -u "$PALPLUSS_API_KEY:" \
  -H "Content-Type: application/json" \
  -d '{"isDefault": true}'

The shortcode and type fields cannot be changed after creation. Delete and recreate the channel if you need to update these.

Authorizations

Authorization

string

header

required

Paste your PalPluss API key in the username field and leave the password field empty — it is ignored.

Get your key from console → Settings → API Keys (starts with pk_live_ or pk_test_).

In your own code, send the key directly: Authorization: Basic YOUR_API_KEY

Path Parameters

string<uuid>

required

The channel ID.

Body

application/json

All fields are optional. Only provided fields are updated.

name

string

Example:

"Primary Collections Paybill"

accountNumber

string | null

Example:

"ACCOUNT002"

isDefault

boolean

Example:

true

Response

Channel updated successfully.

success

boolean

required

Example:

true

data

object

required

Response payload. Shape varies by endpoint.

Show child attributes

requestId

string<uuid>

required

Unique identifier for this API request. Include in support tickets.

Example:

"c1b2a3d4-e5f6-7890-abcd-ef1234567890"

Create Payment Channel Delete Payment Channel

Get Started

Guides

SDKs

STK Push

Transactions

B2C Payouts

Service Wallet

Payment Channels

Update Payment Channel

Partial updates

Authorizations

Path Parameters

Body

Response

​Partial updates

Authorizations

Path Parameters

Body

Response

Partial updates