Modifications

Refund a captured payment

Refunds a payment that has previously been captured, returning a unique reference for this request. Refunding can be done on the full captured amount or a partial amount. Multiple (partial) refunds will be accepted as long as their sum doesn't exceed the captured amount. Payments which have been authorised, but not captured, cannot be refunded, use the /cancel method instead.

Some payment methods/gateways do not support partial/multiple refunds. A margin above the captured limit can be configured to cover shipping/handling costs.

For more information, refer to Refund.

This endpoint is inactive and is no longer supported for new integrations.

The Checkout API enables your online payments integration to accept all supported payment methods, use the latest features, and access more benefits.

post/refund

Request body

additionalDataobject

This field contains additional data, which may be required for a particular modification request.

The additionalData object consists of entries, each of which includes the key and value.

merchantAccountstring required

The merchant account that is used to process the payment.

originalReferencestring required

The original pspReference of the payment to modify. This reference is returned in:

  • authorisation response
  • authorisation notification
referencestring

Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

tenderReferencestring

The transaction reference provided by the PED. For point-of-sale integrations only.

uniqueTerminalIdstring

Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

Response

OK - the request has succeeded.

additionalDataobject

This field contains additional data, which may be returned in a particular modification response.

pspReferencestring required

Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

response'[capture-received]' | '[cancel-received]' | '[refund-received]' | '[cancelOrRefund-received]' | '[adjustAuthorisation-received]' | '[donation-received]' | '[technical-cancel-received]' | '[voidPendingRefund-received]' | 'Authorised' | 'Refused' | 'Error' required

Indicates if the modification request has been received for processing.

Changes

Changed in 4 of the 51 revisions of this API.1633

    • added the new Error enum value to the response response property for the response status 200

      response-property-enum-value-added

    • added the new Refused enum value to the response response property for the response status 200

      response-property-enum-value-added

    • added the new Authorised enum value to the response response property for the response status 200

      response-property-enum-value-added

    • the request's body type/format changed from / to object/

      request-body-type-changed

    • the modificationAmount request property type/format changed from / to object/

      request-property-type-changed

    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 403

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 422

      response-body-type-changed

    • the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

  • v25da6633eb75e183See the full diff
    • the request's body type/format changed from object/ to /

      request-body-type-changed

    • the modificationAmount request property type/format changed from object/ to /

      request-property-type-changed

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • the response's body type/format changed from object/ to / for status 400

      response-body-type-changed

    • the response's body type/format changed from object/ to / for status 401

      response-body-type-changed

    • the response's body type/format changed from object/ to / for status 403

      response-body-type-changed

    • the response's body type/format changed from object/ to / for status 422

      response-body-type-changed

    • the response's body type/format changed from object/ to / for status 500

      response-body-type-changed

    • removed the Authorised enum value from the response response property for the response status 200

      response-property-enum-value-removed

    • removed the Error enum value from the response response property for the response status 200

      response-property-enum-value-removed

    • removed the Refused enum value from the response response property for the response status 200

      response-property-enum-value-removed

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