v1

latestOpenAPI 3.1.02026-07-2022194782.1 KB

Modifications

Refund or cancel a payment

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.

post/payments/{paymentPspReference}/reversals

Path parameters

paymentPspReferencestring required

The pspReference of the payment that you want to reverse.

Headers

Idempotency-Keystring

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

Request body

merchantAccountstring required

The merchant account that is used to process the payment.

referencestring

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

Response

Created - the request has been fulfilled and has resulted in one or more new resources being created.

merchantAccountstring required

The merchant account that is used to process the payment.

paymentPspReferencestring required

The pspReference of the payment to reverse.

pspReferencestring required

Adyen's 16-character reference associated with the reversal request.

referencestring

Your reference for the reversal request.

status'received' required

The status of your request. This will always have the value received.