Cancel bill payment

Allows you to cancel a bill payment. Use the canBeCancelled property of the bill object to check whether the bill payment can be canceled.
Once canceled, the bill payment will not be made.

Cancels a bill payment that is still eligible for cancellation.

Before requesting the cancellation, retrieve the payment and check canBeCancelled. The fact that the payment exists does not mean it can still be canceled.

When the cancellation is completed, the payment will not be executed and changes to the CANCELLED status.

📘

Tracking the cancellation

Use the BILL_CANCELLED event to sync the status change in your integration.

See the Bill Payment events.

To check the payment before the operation, use Retrieve a single bill payment.

Related content

Guides

Error Library

Path Params
string
required

Unique identifier of the bill payment to be cancelled

Body Params
Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json