stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPaymentIntentsIntentCancel

Description

Contains the different functions to run the operation postPaymentIntentsIntentCancel

Synopsis

Documentation

postPaymentIntentsIntentCancel Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

intent | Constraints: Maximum length of 5000

-> PostPaymentIntentsIntentCancelRequestBody

The request body to send

-> m (Either HttpException (Response PostPaymentIntentsIntentCancelResponse))

Monad containing the result of the operation

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>. </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>

data PostPaymentIntentsIntentCancelRequestBody Source #

Defines the data type for the schema postPaymentIntentsIntentCancelRequestBody

Constructors

PostPaymentIntentsIntentCancelRequestBody 

Fields

data PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #

Defines the enum schema postPaymentIntentsIntentCancelRequestBodyCancellation_reason'

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

Instances
Eq PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel

Show PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel

ToJSON PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel

FromJSON PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel