Skip to main content
PATCH
cURL

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

Target/expected bill payment amount (positive, max 2 decimal places)

Required range: x >= 0.01
billMaxCollectionAmount
number

New max total that can be collected. Remaining is recalculated from what was already paid. Only with ALLOW_PARTIAL_AND_OVER_PAYMENT.

billDescription
string

Description of the bill

Maximum string length: 500
billPaymentMode
enum<string>

Payment mode. Switching to EXACT removes the collection limit.

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

Target/expected bill payment amount

billMaxCollectionAmount
number

Max total this control number can collect

billRemainingAmount
number

How much can still be collected

billDescription
string

Description of the bill

billPaymentMode
enum<string>

Payment mode

Available options:
ALLOW_PARTIAL_AND_OVER_PAYMENT,
EXACT