Sign in

v1

latestOpenAPI 3.1.02026-07-2022194782.1 KB
Modifications

Refund a captured payment

Refunds a payment that has been captured, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a 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, iDEAL, or Klarna.

If you want to refund a payment but are not sure whether it has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead.

For more information, refer to Refund.

post/payments/{paymentPspReference}/refunds

Path parameters

paymentPspReferencestring required

The pspReference of the payment that you want to refund.

Headers

Idempotency-Keystring

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

Request body

capturePspReferencestring

This is only available for PayPal refunds. The pspReference of the specific capture to refund.

merchantAccountstring required

The merchant account that is used to process the payment.

merchantRefundReason'FRAUD' | 'CUSTOMER REQUEST' | 'RETURN' | 'DUPLICATE' | 'OTHER' nullable

The reason for the refund request.

Possible values:

  • FRAUD

  • CUSTOMER REQUEST

  • RETURN

  • DUPLICATE

  • OTHER

referencestring

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

storestring

The online store or physical store that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.

Response

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

capturePspReferencestring

This is only available for PayPal refunds. The pspReference of the specific capture to refund.

merchantAccountstring required

The merchant account that is used to process the payment.

merchantRefundReason'FRAUD' | 'CUSTOMER REQUEST' | 'RETURN' | 'DUPLICATE' | 'OTHER' nullable

Your reason for the refund request.

paymentPspReferencestring required

The pspReference of the payment to refund.

pspReferencestring required

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

referencestring

Your reference for the refund request.

status'received' required

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

storestring

The online store or physical store that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails.