Skip to main content
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",
    "type": "PAYBILL",
    "shortcode": "123456",
    "name": "Main Collections Paybill",
    "accountNumber": "ACCOUNT001",
    "isDefault": true,
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "requestId": "c1b2a3d4-e5f6-7890-abcd-ef1234567890"
}

​
Partial updates

Only the fields you include in the request body are updated. Omit fields you do not want to change. 
# 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

Use your API key as the username. Leave the password field empty.

Authorization: Basic <base64(apikey:)>

You can also pass the raw API key:

Authorization: Basic <apikey>

Path Parameters

​
id
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.

​
requestId
string<uuid>
required

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

Example:

"c1b2a3d4-e5f6-7890-abcd-ef1234567890"