Update BillPay Number Status

Deprecated. Use PATCH /billpay/ with body instead. Updates the status of a BillPay reference. Inactive references will be rejected during verification and confirmation.

PUT /billpay/update-status

cURL

cURL

curl --request PUT \
  --url https://api.clickpesa.com/third-parties/billpay/update-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billPayNumber": "55042914871931",
  "status": "INACTIVE"
}
'

200

{
  "billPayNumber": "55042914871931",
  "status": "INACTIVE"
}

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

Body

application/json

billPayNumber · string · required

The BillPay reference number to update

Example:

"55042914871931"

status · enum<string> · required

The status to set for the BillPay reference. ACTIVE allows payments to be processed, INACTIVE prevents payments from being processed.

Available options: ACTIVE, INACTIVE

Example:

"INACTIVE"

Response

200

application/json

Successfully updated BillPay reference status

billPayNumber · string

The BillPay reference number that was updated

Example:

"55042914871931"

status · enum<string>

The updated status of the BillPay reference

Available options: ACTIVE, INACTIVE

Example:

"INACTIVE"