Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB

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

put/billpay/update-status

Request body

billPayNumberstring required

The BillPay reference number to update

status'ACTIVE' | 'INACTIVE' required

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

Example request

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

Response

Successfully updated BillPay reference status

billPayNumberstring

The BillPay reference number that was updated

status'ACTIVE' | 'INACTIVE'

The updated status of the BillPay reference

Example response

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