Cancel payment using a PSP reference

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

Cancels the authorisation on a payment that has not yet been captured, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCELLATION webhook. If you want to cancel a payment but don't have the pspReference, use the /cancels endpoint instead. If you want to cancel a payment but are not sure whether it has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead. For more information, refer to Cancel.

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"}