Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Transactions

Cancel Bill Payment

Use the Cancel Bill Payment endpoint to cancel the following types of billpay transactions:

  • Paper transactions in status N, W or P.
  • Electronic (RPPS) transactions in status N
  • Non-recurring paper or electronic transactions that are scheduled for a future date

If the transaction is in another status, the endpoint returns status_code: 435-02See <a href="doc:managing-billpay-transactions" target="_blank">Managing Billpay Transactions</a> for instructions on using this endpoint.

post/cancelBillPayment

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed