Cancel or refund a payment

POST

/cancelOrRefund

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 part of our classic API integration. If using a newer integration, use the /payments/{paymentPspReference}/reversals endpoint under Checkout API instead.

Request

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/cancelOrRefund' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{
    "additionalData": {
        "property1": "string",
        "property2": "string"
    },
    "pspReference": "string",
    "response": "[capture-received]"
}

Modified at 2023-08-15 08:20:06

Cancel an authorisation

Capture an authorisation