Cancel an authorisation
Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.
For more information, refer to Cancel.
This endpoint is part of our classic API integration. If using a newer integration, use the
/payments/{paymentPspReference}/cancelsendpoint under Checkout API instead.
Request Parameters
This field contains additional data, which may be required for a particular modification request.
The additionalData object consists of entries, each of which includes the key and value.
The merchant account that is used to process the payment.
Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
The original merchant reference to cancel.
The original pspReference of the payment to modify. This reference is returned in:
- authorisation response
- authorisation notification
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to split payments for platforms.
The transaction reference provided by the PED. For point-of-sale integrations only.
Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.
Response parameters
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.