Cancel an authorisation

POST

/cancel

Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.

For more information, refer to Cancel.

This endpoint is part of our classic API integration. If using a newer integration, use the /payments/{paymentPspReference}/cancels 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 '/cancel' \
--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

Change the authorised amount

Cancel or refund a payment