Payment: Cancel Authorized Amount
Overview
Cancellation of the Authorised Amount is an API request used to cancel a payment that was previously authorised. It instructs the system to interrupt the payment flow, release all previously authorised funds and return them to the payer’s account.
Preconditions
- The payment method used must support manual capture
- The payment must not be already captured or cancelled
- Payment must be authorized
Payment Status = "AUTHORIZED" - The authorisation must still be valid (i.e. within the capture window)
Use Cases
| Step | Description |
|---|---|
| Step 1 | You initiate a payment with auto-capture OFF |
| Step 2 | The system authorises the amount and holds it on the payer’s account |
| Step 3 | You must send a cancellation request within the allowed window |
| Step 4 | If you don’t, the payment becomes expired and is marked as cancelled in the system automatically |
How it Works
Endpoints
| Endpoint | Short Name |
|---|---|
PATCH /api/v1/payments/{id} | Initiate the cancellation of the payment and the release of the authorised amount |
Possible Results
Full Status Model is available on the page Payment: Overview
Error Reasons
| Error Code | Description |
|---|---|
| CODE_PT0000 | Unknown error |
| CODE_PT0001 | Request processing time expired |
| CODE_PT0002 | Invalid payment details |
| CODE_PT0003 | Sender data error |
| CODE_PT0004 | Recipient data error |
| CODE_PT0005 | Internal processing failure |
Updated 5 days ago