Server-side payments/cancelPaymentIntent

Cancel an authorized payment

Planned

Planned. This contract is published ahead of the build. It is not callable yet — treat it as the shape to design against, not a live endpoint.

Release an authorized payment intent before it's captured.

POST/v1/payment-intents/{id}/cancel

Void an authorization before capture, releasing the hold on the card.

Path parameters

idstringRequired

Response

application/json

idstringRequired

Example "0195d46e-7088-7cc4-a9b2-5f9273cd63b8"

merchantIdstringRequired

Example "mch_123"

customerIdstring

Example "cus_123"

terminalIdstring

Example "TID-00012345"

amountMinorintegerRequired

Example 1999

currencyCodestringRequired

Example "USD"

statusenumRequired

REQUIRES_PAYMENT_METHODREQUIRES_CONFIRMATIONPROCESSINGSUCCEEDEDDECLINEDREQUIRES_ACTIONCANCELED

clientSecretstring

Returned on create responses; pass only to the browser client for this payment.

Example "pi_0195d46e_secret_example"

paymentIdstring

Payment ID, present after the charge has been sent for authorization.

Example "0195d46e-7088-7cc4-a9b2-5f9273cd63b8"

paymentstring

Payment details, present after authorization.

setupFutureUsageenum

OFF_SESSIONON_SESSION

descriptionstring

metadataobject

createdAtstring · ISO 8601Required

Example "2026-04-09T09:14:22Z"

cancelPaymentIntent