StripeAPI.Operations.PostPaymentIntentsIntentCancel

POST /v1/payment_intents/{intent}/cancel

<p>A PaymentIntent object can be canceled when it is in one of these statuses: <code>requires_payment_method</code>, <code>requires_capture</code>, <code>requires_confirmation</code>, <code>requires_action</code>, or <code>processing</code>. </p>

<p>Once canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with <code>status=’requires_capture’</code>, the remaining <code>amount_capturable</code> will automatically be refunded. </p>

<p>You cannot cancel the PaymentIntent for a Checkout Session. <a href="/docs/api/checkout/sessions/expire">Expire the Checkout Session</a> instead</p>

Defines the object schema located at paths./v1/payment_intents/{intent}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostPaymentIntentsIntentCancelRequestBody with all required fields.

Defines the enum schema located at paths./v1/payment_intents/{intent}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.cancellation_reason in the specification.

Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`

Represents a response of the operation postPaymentIntentsIntentCancel.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostPaymentIntentsIntentCancelResponseError is used.