Refund or cancel a payment
Refunds a payment if it has already been captured, and cancels a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCEL_OR_REFUND webhook.
The reversed amount is always the full payment amount.
Do not use this request for payments that involve multiple partial captures.
For more information, refer to Reversal.
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
The merchant account that is used to process the payment.
Your reference for the reversal request. Maximum length: 80 characters.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
201 - Created
The request has been fulfilled and has resulted in one or more new resources being created.Show more
400 - Bad Request
A problem reading or understanding the request.Show more
401 - Unauthorized
Authentication required.Show more
403 - Forbidden
Insufficient permissions to process the request.Show more
422 - Unprocessable Entity
A request validation error.Show more
500 - Internal Server Error
The server could not process the request.Show more