Cancel an authorised payment

POST

/cancels

Cancels the authorisation on a payment that has not yet been captured, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a TECHNICAL_CANCEL webhook.

If you want to cancel a payment using the pspReference, use the /payments/{paymentPspReference}/cancels endpoint instead.

If you want to cancel a payment but are not sure whether it has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead.

For more information, refer to Cancel.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟢201Created - the request has been fulfilled and has resulted in one or more new resources being created.

🟠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 '/cancels' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantAccount": "string",
    "paymentReference": "string",
    "reference": "string"
}'

Response Example

200 - Example 1

{
    "merchantAccount": "string",
    "paymentReference": "string",
    "pspReference": "string",
    "reference": "string",
    "status": "received"
}

Modified at 2023-08-15 09:16:27

Update an authorised amount