Sign in
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.

Changes

Changed in 6 of the 54 revisions of this API.18

  • v70e74b6569ea743See the full diff
    • ○

      added the new optional request property enhancedSchemeData/carRental

      new-optional-request-property

    • ○

      added the new optional request property enhancedSchemeData/lodging

      new-optional-request-property

    • ○

      added the new optional request property enhancedSchemeData/temporaryServices

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v70d5c50d69824f1See the full diff
    • ○

      added the new optional request property enhancedSchemeData/levelTwoThree

      new-optional-request-property

  • v7037689fc71cc91See the full diff
    • ○

      added the new optional request property enhancedSchemeData

      new-optional-request-property

  • v7006d28363fdd01See the full diff
    • ○

      added the new optional request property capturePspReference

      new-optional-request-property

  • v70f07184e939471See the full diff
    • ○

      added the optional property capturePspReference to the response with the 201 status

      response-optional-property-added

  • v70f62d8d53b8e011See the full diff
    • ●

      added the new TopUp enum value to the splits/items/type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new TopUp enum value to the request property splits/items/type

      request-property-enum-value-added