POST /payments/{paymentPspReference}/reversals

Refunds a payment if it has already been captured, and cancels a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCEL_OR_REFUND webhook.

The reversed amount is always the full payment amount.

Do not use this request for payments that involve multiple partial captures.

For more information, refer to Reversal.

Servers

https://checkout-test.adyen.com/v71

Path parameters

Name	Type	Required	Description
`paymentPspReference`	String	Yes	The `pspReference` of the payment that you want to reverse.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Idempotency-Key`	String	No	A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Request body fields

Name	Type	Required	Description
`applicationInfo`	Object	No	Information about your application. For more details, see Building Adyen solutions.
`applicationInfo.merchantApplication`	Object	No	Merchant developed software, such as cashier application, used to interact with the Adyen API.
`applicationInfo.merchantApplication.name`	String	No	Name of the field. For example, Name of External Platform.
`applicationInfo.merchantApplication.version`	String	No	Version of the field. For example, Version of External Platform.
`applicationInfo.externalPlatform`	Object	No	Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.
`applicationInfo.externalPlatform.integrator`	String	No	External platform integrator.
`applicationInfo.externalPlatform.name`	String	No	Name of the field. For example, Name of External Platform.
`applicationInfo.externalPlatform.version`	String	No	Version of the field. For example, Version of External Platform.
`applicationInfo.merchantDevice`	Object	No	Merchant device information.
`applicationInfo.merchantDevice.osVersion`	String	No	Version of the operating system on the merchant device.
`applicationInfo.merchantDevice.os`	String	No	Operating system running on the merchant device.
`applicationInfo.merchantDevice.reference`	String	No	Merchant device reference.
`applicationInfo.adyenLibrary`	Object	No	Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.
`applicationInfo.adyenLibrary.name`	String	No	Name of the field. For example, Name of External Platform.
`applicationInfo.adyenLibrary.version`	String	No	Version of the field. For example, Version of External Platform.
`applicationInfo.shopperInteractionDevice`	Object	No	Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.
`applicationInfo.shopperInteractionDevice.osVersion`	String	No	Version of the operating system on the shopper interaction device.
`applicationInfo.shopperInteractionDevice.locale`	String	No	Locale on the shopper interaction device.
`applicationInfo.shopperInteractionDevice.os`	String	No	Operating system running on the shopper interaction device.
`applicationInfo.adyenPaymentSource`	Object	No	Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.
`applicationInfo.adyenPaymentSource.name`	String	No	Name of the field. For example, Name of External Platform.
`applicationInfo.adyenPaymentSource.version`	String	No	Version of the field. For example, Version of External Platform.
`merchantAccount`	String	Yes	The merchant account that is used to process the payment.
`reference`	String	No	Your reference for the reversal request. Maximum length: 80 characters.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.