Skip to main content
PATCH
/
billpay
/
{billPayNumber}
cURL
curl --request PATCH \
  --url https://api.clickpesa.com/third-parties/billpay/{billPayNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billAmount": 50000,
  "billDescription": "Updated order description"
}
'
{
  "billPayNumber": "55042914871931",
  "billStatus": "ACTIVE",
  "billAmount": 123,
  "billDescription": "<string>",
  "billPaymentMode": "ALLOW_PARTIAL_AND_OVER_PAYMENT"
}

Authorizations

​
Authorization
string
header
required

Authorization header containing the JWT access token returned from the generate token endpoint. The token already includes the Bearer prefix. Example: Authorization: Bearer eyJhbGciOi...

Path Parameters

​
billPayNumber
string
required

BillPay number to update

Body

application/json
​
billStatus
enum<string>

Status of the BillPay reference

Available options:
ACTIVE,
INACTIVE
​
billAmount
number

Amount of the bill (positive, max 2 decimal places)

Required range: x >= 0.01
​
billDescription
string

Description of the bill

Maximum string length: 500
​
billPaymentMode
enum<string>

Payment mode

Available options:
ALLOW_PARTIAL_AND_OVER_PAYMENT,
EXACT

Response

Successfully updated BillPay reference

​
billPayNumber
string

The BillPay reference number that was updated

Example:

"55042914871931"

​
billStatus
enum<string>

The updated status of the BillPay reference

Available options:
ACTIVE,
INACTIVE
​
billAmount
number

Amount of the bill

​
billDescription
string

Description of the bill

​
billPaymentMode
enum<string>

Payment mode

Available options:
ALLOW_PARTIAL_AND_OVER_PAYMENT,
EXACT