Cancel a Payment

POST

/v1/payments/{payment_id}/cancel

Requires API Key scope payment:write.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

Payment cancelled, or current status returned for a repeated cancellation

Headers

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/payments//cancel' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "activated_at": "2019-08-24T14:15:22.123Z",
    "created_at": "2019-08-24T14:15:22.123Z",
    "order_ref": "string",
    "payment_expires_at": "2019-08-24T14:15:22.123Z",
    "payment_id": "string",
    "source_amount": {
        "amount_raw": "string",
        "currency": "string",
        "decimals": 0,
        "kind": "fiat"
    },
    "status": "string",
    "status_version": 0,
    "updated_at": "2019-08-24T14:15:22.123Z"
}

Get Payment status

Disable Checkout access