Cancel or refund a payment
Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).
Do not use this endpoint for payments that involve:
- Multiple partial captures.
- Split data either at time of payment or capture for Adyen for Platforms.
Instead, check if the payment has been captured and make a corresponding /refund or /cancel call.
For more information, refer to Cancel or refund.
This endpoint is part of our classic API integration. If using a newer integration, use the
/payments/{paymentPspReference}/reversalsendpoint 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
Defines how to book chargebacks when using Adyen for Platforms.
Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.
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.