Reverse (cancel or refund) a payment

POST {{baseUrl}}/payments/:paymentPspReference/reversals

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 CANCELORREFUND 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.

Request Body

{"reference"=>"YOUR_UNIQUE_REFERENCE", "merchantAccount"=>"{{YOUR_MERCHANT_ACCOUNT}}"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring
Idempotency-KeynullA unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

RESPONSES

status: Created

{"merchantAccount":"YOUR_MERCHANT_ACCOUNT","paymentPspReference":"993617894903480A","reference":"YOUR_UNIQUE_REFERENCE","pspReference":"993617894906488A","status":"received"}