Modifications

Cancel or refund a payment

Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).

Do not use this endpoint for payments that involve:

Multiple partial captures.
Split data either at time of payment or capture for Adyen for Platforms.

Instead, check if the payment has been captured and make a corresponding /refund or /cancel call.

For more information, refer to Cancel or refund.

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

If you are building a new integration, use the Checkout API /payments/{paymentPspReference}/reversals endpoint instead.

If you have an existing integration using this endpoint, reach out to your Adyen contact and migrate to the Checkout API.

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

post/cancelOrRefund

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.

Indicates if the modification request has been received for processing.

Changes

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

Feb 17, 2026v2520c98153769d2See the full diff
- ●
  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
Oct 21, 2024v2527588197cceb1See the full diff
- ●
  added the new Authorised enum value to the response response property for the response status 200
  response-property-enum-value-added
Feb 24, 2023v256522ce018f707See the full diff
- ▲
  the request's body type/format changed from / to object/
  request-body-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
Dec 5, 2022v25da6633eb75e173See the full diff
- ▲
  the request's body type/format changed from object/ to /
  request-body-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

Full history