CheckoutModifications

Refund or cancel a payment

POST
/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 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.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

paymentPspReference*string

The pspReference of the payment that you want to reverse.

Header Parameters

Idempotency-Key?string

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request Body

application/json

applicationInfo?

Information about your application. For more details, see Building Adyen solutions.

enhancedSchemeData?
merchantAccount*string

The merchant account that is used to process the payment.

reference?string

Your reference for the reversal request. Maximum length: 80 characters.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/payments/string/reversals" \  -H "Idempotency-Key: 37ca9c97-d1d1-4c62-89e8-706891a563ed" \  -H "Content-Type: application/json" \  -d '{    "reference": "YOUR_UNIQUE_REFERENCE",    "merchantAccount": "YOUR_MERCHANT_ACCOUNT"  }'

Example response when a payment reversal was requested

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

Refund a captured payment POST

Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook). You can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount. > Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). If you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead. For more information, refer to [Refund](https://docs.adyen.com/online-payments/refund).

Forward stored payment details POST

Forwards the payment details you stored with Adyen to a third-party that you specify and returns the response from the third-party. Supports forwarding stored card details or [network tokens](https://docs.adyen.com/online-payments/network-tokenization). For more information, see [Forward stored payment details](https://docs.adyen.com/online-payments/tokenization/forward-payment-details).