Refund a captured payment

post /payments/{paymentPspReference}/refunds

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.

Endpoint destination URL

https://checkout-test.adyen.com/v69/payments/{paymentPspReference}/refunds
Click to copy

Header parameters

Idempotency-Key string

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

Path parameters

paymentPspReference string Required

The pspReference of the payment that you want to refund.

Request parameters

amount Required

The amount that you want to refund. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.

lineItems [LineItem] array

Price and product information of the refunded items, required for partial refunds.

This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Zip and Atome.

merchantAccount string Required

The merchant account that is used to process the payment.

reference string

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

splits [Split] array

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to Providing split information.

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.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 201 - Created

    The request has been fulfilled and has resulted in one or more new resources being created.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less