--- title: Cancel a payment slug: reference/cancel-a-payment docTags: createdAt: 2026-08-23T06:01:06.452Z --- { "id": "i3IJfD4Nhu6tjxG9M1o0A", "type": "api-oas-v2", "data": { "method": "POST", "url": "/api/payments/{id}/cancel", "servers": [], "name": "Cancel a payment", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "id", "type": "string", "description": "" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "Idempotency-Key", "type": "string", "description": "

Client-supplied key to safely retry the request without duplicating the operation.

" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "CancelPaymentDTO", "schema": [ { "name": "reason", "kind": "optional", "type": "string", "description": "Reason for canceling the payment", "example": "duplicate", "enum": [ "duplicate", "fraudulent", "requested_by_customer", "requested_by_merchant", "abandoned" ] }, { "name": "amount", "kind": "optional", "type": "number", "description": "

Amount of the authorization to void, leaving the remainder capturable. Omit to void the full authorization. Only supported by some processors.

", "example": 2999, "minimum": 1 } ], "modelRef": "#/components/schemas/CancelPaymentDTO", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Payment canceled", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Payment response", "customType": "PaymentResponseDTO", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the payment" }, { "name": "orderId", "kind": "required", "type": "string", "description": "The Forter order ID associated with this payment", "example": "order-abc-123" }, { "name": "amount", "kind": "required", "type": "number", "description": "The total amount for the payment", "example": 9876 }, { "name": "capturedAmount", "kind": "optional", "type": "number", "description": "The total amount captured for the payment", "example": 9876 }, { "name": "authorizedAmount", "kind": "optional", "type": "number", "description": "

The amount still held by the authorization and available to capture. Zero once the authorization is concluded, whether captured or voided

", "example": 9876 }, { "name": "refundedAmount", "kind": "optional", "type": "number", "description": "The total amount refunded for the payment", "example": 0 }, { "name": "capturedAt", "kind": "optional", "type": "string", "description": "

When the payment was captured (latest successful capture)

", "format": "date-time" }, { "name": "refundedAt", "kind": "optional", "type": "string", "description": "

When the payment was refunded (latest successful refund).

", "format": "date-time" }, { "name": "authorizedAt", "kind": "optional", "type": "string", "description": "When the payment was authorized.", "format": "date-time" }, { "name": "authorizationExpiresAt", "kind": "optional", "type": "string", "description": "

When the authorization hold expires (capture deadline).

", "format": "date-time" }, { "name": "createdAt", "kind": "optional", "type": "string", "description": "Date and time when the payment was created", "example": "2025-07-14T12:34:56.789Z", "format": "date-time" }, { "name": "currency", "kind": "required", "type": "string", "description": "The currency code for the payment", "example": "GBP", "enum": [ "AED", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BWP", "BYN", "BZD", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SEK", "SGD", "SHP", "SLE", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SZL", "THB", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "YER", "ZAR", "ZMW" ] }, { "name": "status", "kind": "required", "type": "string", "description": "Current status of the payment", "example": "succeeded", "enum": [ "requires_payment_method", "requires_confirmation", "requires_action", "processing", "requires_capture", "canceled", "succeeded", "failed" ] }, { "name": "nextAction", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentNextActionDTO", "description": "", "modelRef": "#/components/schemas/PaymentNextActionDTO", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "Type of action required", "example": "use_sdk", "enum": [ "use_sdk" ] }, { "name": "useSdk", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "UseSdkActionDTO", "description": "", "modelRef": "#/components/schemas/UseSdkActionDTO", "schema": [ { "name": "token", "kind": "required", "type": "string", "description": "

SDK token for client-side authentication

", "example": "sdk_token_123" } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "captureMethod", "kind": "optional", "type": "string", "description": "The capture method for the payment", "example": "automatic", "default": "automatic", "enum": [ "automatic", "manual" ] }, { "name": "paymentMethod", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentMethodResponseDTO", "description": "", "modelRef": "#/components/schemas/PaymentMethodResponseDTO", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "Payment method type used for authorization.", "example": "card", "enum": [ "token", "card", "network_token" ] }, { "name": "card", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentMethodCardDTO", "description": "", "modelRef": "#/components/schemas/PaymentMethodCardDTO", "schema": [ { "name": "brand", "kind": "required", "type": "string", "description": "Card brand. 'unknown' when the brand could not be determined.", "example": "visa" }, { "name": "last4", "kind": "required", "type": "string", "description": "Last four digits of the card", "example": "4242" }, { "name": "expirationMonth", "kind": "required", "type": "string", "description": "Card expiration month", "example": "03" }, { "name": "expirationYear", "kind": "required", "type": "string", "description": "Card expiration year", "example": "2026" }, { "name": "cardholderName", "kind": "optional", "type": "string", "description": "Cardholder name", "example": "Jane Doe" }, { "name": "networkToken", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "NetworkTokenDTO", "description": "", "modelRef": "#/components/schemas/NetworkTokenDTO", "schema": [ { "name": "used", "kind": "required", "type": "boolean", "description": "

Whether a network token (rather than the PAN) was used to authorize. Always false until network tokenization is used at the PSP.

", "example": false } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "processorToken", "kind": "optional", "type": "string", "description": "

Processor vault token for stored-credential reuse. Present only when the processor returned a stored-credential token.

", "example": "f28v7s" } ] } ], "schema": [] }, { "name": "processor", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ProcessorDTO", "description": "", "modelRef": "#/components/schemas/ProcessorDTO", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "Processor used for the payment", "enum": [ "stripe", "adyen", "braintree", "airwallex", "connexpay", "echo", "fiserv" ] }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "

Processor-assigned transaction id

", "example": "pi_abc123" }, { "name": "chargeId", "kind": "optional", "type": "string", "description": "

Processor-assigned charge id

", "example": "ch_xyz789" } ] } ], "schema": [] }, { "name": "authorization", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AuthorizationDTO", "description": "", "modelRef": "#/components/schemas/AuthorizationDTO", "schema": [ { "name": "authorizationCode", "kind": "optional", "type": "string", "description": "Processor authorization code", "example": "AUTH123" }, { "name": "rawResponseCode", "kind": "optional", "type": "string", "description": "Raw processor response code", "example": "card_declined" }, { "name": "rawResponseMessage", "kind": "optional", "type": "string", "description": "Raw processor response message", "example": "Your card was declined." }, { "name": "processorResponseCode", "kind": "optional", "type": "string", "description": "

Processor response code normalized into a canonical cross-PSP vocabulary. Omitted when the raw code has no normalized mapping.

", "example": "insufficient_funds", "enum": [ "approved", "do_not_honor", "generic_decline", "insufficient_funds", "limit_exceeded", "expired_card", "invalid_card_number", "cvv_mismatch", "avs_mismatch", "invalid_account", "call_issuer", "lost_or_stolen_card", "fraudulent", "pickup_card", "transaction_not_allowed", "processor_unavailable", "duplicate_transaction", "invalid_amount", "invalid_request", "card_type_not_supported", "configuration_error" ] }, { "name": "checks", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "CardChecksDTO", "description": "", "modelRef": "#/components/schemas/CardChecksDTO", "schema": [ { "name": "addressCheck", "kind": "optional", "type": "string", "description": "

AVS (address) check result

", "enum": [ "pass", "fail", "unavailable", "unchecked" ] }, { "name": "cvcCheck", "kind": "optional", "type": "string", "description": "

CVV/CVC check result

", "enum": [ "pass", "fail", "unavailable", "unchecked" ] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "authentication", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "AuthenticationDTO", "description": "", "modelRef": "#/components/schemas/AuthenticationDTO", "schema": [ { "name": "threeDSecure", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "ThreeDSecureResultsDTO", "description": "", "modelRef": "#/components/schemas/ThreeDSecureResultsDTO", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "3DS authentication outcome", "enum": [ "authenticated", "attempted", "failed", "rejected", "challenge_required", "unavailable" ] }, { "name": "version", "kind": "optional", "type": "string<1.0.2 | 2.1.0 | 2.2.0 | 2.3.1>", "description": "3DS protocol version", "example": "2.2.0", "enum": [ "1.0.2", "2.1.0", "2.2.0", "2.3.1" ] }, { "name": "eci", "kind": "optional", "type": "string<00 | 01 | 02 | 04 | 05 | 06 | 07>", "description": "

Electronic Commerce Indicator (chargeback liability-shift evidence)

", "example": "05", "enum": [ "00", "01", "02", "04", "05", "06", "07" ] } ] } ], "schema": [] } ] } ], "schema": [] }, { "name": "metadata", "kind": "optional", "type": "object", "description": "

Set of key-value pairs for storing additional information about the payment

", "example": "", "schema": [] }, { "name": "fraud", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "PaymentFraudDTO", "description": "", "modelRef": "#/components/schemas/PaymentFraudDTO", "schema": [ { "name": "preAuth", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "FraudDecisionDTO", "description": "", "modelRef": "#/components/schemas/FraudDecisionDTO", "schema": [ { "name": "decision", "kind": "required", "type": "string", "description": "Fraud decision", "enum": [ "approve", "decline", "not_reviewed" ] } ] } ], "schema": [] }, { "name": "postAuth", "kind": "optional", "type": "object", "description": "", "complexType": "allOf", "complexItems": [ { "name": "FraudDecisionDTO", "description": "", "modelRef": "#/components/schemas/FraudDecisionDTO", "schema": [ { "name": "decision", "kind": "required", "type": "string", "description": "Fraud decision", "enum": [ "approve", "decline", "not_reviewed" ] } ] } ], "schema": [] } ] } ], "schema": [] } ], "modelRef": "#/components/schemas/PaymentResponseDTO", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "92GuGYmOJuQpHGpPwUk_D", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url /api/payments/{id}/cancel \\\n --header 'accept: application/json' \\\n --header 'idempotency-key: string'" }, { "id": "biYK-RsCgdyOJjjcfHZoW", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"idempotency-key\", \"string\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/api/payments/{id}/cancel\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "T1S7-xvRbF5HHZaK07LqE", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/payments/{id}/cancel\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"idempotency-key\"] = \"string\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "jWcBmMjBfPq6OvEfG7cSe", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/api/payments/{id}/cancel\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'idempotency-key': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "92GuGYmOJuQpHGpPwUk_D" }, "results": { "languages": [ { "id": "Vtkz9YFaIJ9JpuPD05a3v", "language": "200", "code": "// Payment canceled\n{\n \"id\": \"\",\n \"orderId\": \"order-abc-123\",\n \"amount\": 9876,\n \"capturedAmount\": 9876,\n \"authorizedAmount\": 9876,\n \"refundedAmount\": 0,\n \"capturedAt\": \"\",\n \"refundedAt\": \"\",\n \"authorizedAt\": \"\",\n \"authorizationExpiresAt\": \"\",\n \"createdAt\": \"2025-07-14T12:34:56.789Z\",\n \"currency\": \"GBP\",\n \"status\": \"succeeded\",\n \"nextAction\": {},\n \"captureMethod\": \"automatic\",\n \"paymentMethod\": {},\n \"processor\": {},\n \"authorization\": {},\n \"authentication\": {},\n \"metadata\": {},\n \"fraud\": {}\n}" }, { "id": "ssS0Y9A21eP1RMaHjhGPY", "language": "400", "code": "// Bad request\n" }, { "id": "gPMcgkUJnv0wvCqceqltN", "language": "401", "code": "// Unauthorized\n" }, { "id": "s6CmOUYCbks65MdnXnRT4", "language": "404", "code": "// Not found\n" } ], "selectedLanguageId": "Vtkz9YFaIJ9JpuPD05a3v" } }, "children": [ { "text": "" } ] }