Sign in

v1

latestOpenAPI 3.1.02026-07-2691531.2 KB
Payment Channels

Update payment channel

Updates the name, account number, or default status of an existing channel. Only the fields you include in the request body are updated.

patch/payment-wallet/channels/{id}

Path parameters

idstring uuid required

The channel ID.

Request body

namestring
accountNumberstring nullable
isDefaultboolean

Example request

{
  "name": "Primary Collections Paybill",
  "accountNumber": "ACCOUNT002",
  "isDefault": true
}

Response

Channel updated successfully.

successboolean required
requestIdstring uuid required

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

Example response

{
  "success": true,
  "data": {
    "category": "PAYMENT_WALLET",
    "shortcode": "123456",
    "name": "Main Collections Paybill",
    "accountNumber": "ACCOUNT001",
    "isDefault": true
  },
  "requestId": "c1b2a3d4-e5f6-7890-abcd-ef1234567890"
}