Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPaymentIntentsIntentCancel

Description

Contains the different functions to run the operation postPaymentIntentsIntentCancel

Synopsis

postPaymentIntentsIntentCancel :: forall m. MonadHTTP m => Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> ClientT m (Response PostPaymentIntentsIntentCancelResponse)
data PostPaymentIntentsIntentCancelRequestBody = PostPaymentIntentsIntentCancelRequestBody {
- postPaymentIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostPaymentIntentsIntentCancelRequestBodyCancellationReason'
- postPaymentIntentsIntentCancelRequestBodyExpand :: Maybe [Text]
}
mkPostPaymentIntentsIntentCancelRequestBody :: PostPaymentIntentsIntentCancelRequestBody
data PostPaymentIntentsIntentCancelRequestBodyCancellationReason'
data PostPaymentIntentsIntentCancelResponse

Documentation

postPaymentIntentsIntentCancel Source #

Arguments

:: forall m. MonadHTTP m
=> Text	intent \| Constraints: Maximum length of 5000
-> Maybe PostPaymentIntentsIntentCancelRequestBody	The request body to send
-> ClientT m (Response PostPaymentIntentsIntentCancelResponse)	Monadic computation which returns 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>, or <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 object schema located at paths./v1/payment_intents/{intent}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostPaymentIntentsIntentCancelRequestBody

Fields

postPaymentIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostPaymentIntentsIntentCancelRequestBodyCancellationReason'
cancellation_reason: Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`
Constraints:
- Maximum length of 5000
postPaymentIntentsIntentCancelRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.

Instances

Instances details

Eq PostPaymentIntentsIntentCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods (==) :: PostPaymentIntentsIntentCancelRequestBody -> PostPaymentIntentsIntentCancelRequestBody -> Bool # (/=) :: PostPaymentIntentsIntentCancelRequestBody -> PostPaymentIntentsIntentCancelRequestBody -> Bool #
Show PostPaymentIntentsIntentCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods showsPrec :: Int -> PostPaymentIntentsIntentCancelRequestBody -> ShowS # show :: PostPaymentIntentsIntentCancelRequestBody -> String # showList :: [PostPaymentIntentsIntentCancelRequestBody] -> ShowS #
ToJSON PostPaymentIntentsIntentCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods toJSON :: PostPaymentIntentsIntentCancelRequestBody -> Value # toEncoding :: PostPaymentIntentsIntentCancelRequestBody -> Encoding # toJSONList :: [PostPaymentIntentsIntentCancelRequestBody] -> Value # toEncodingList :: [PostPaymentIntentsIntentCancelRequestBody] -> Encoding #
FromJSON PostPaymentIntentsIntentCancelRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods parseJSON :: Value -> Parser PostPaymentIntentsIntentCancelRequestBody # parseJSONList :: Value -> Parser [PostPaymentIntentsIntentCancelRequestBody] #

mkPostPaymentIntentsIntentCancelRequestBody :: PostPaymentIntentsIntentCancelRequestBody Source #

Create a new PostPaymentIntentsIntentCancelRequestBody with all required fields.

data PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #

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`

Constructors

PostPaymentIntentsIntentCancelRequestBodyCancellationReason'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumAbandoned	Represents the JSON value `"abandoned"`
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumDuplicate	Represents the JSON value `"duplicate"`
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumFraudulent	Represents the JSON value `"fraudulent"`
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumRequestedByCustomer	Represents the JSON value `"requested_by_customer"`

Instances

Instances details

Eq PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods (==) :: PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> Bool # (/=) :: PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> Bool #
Show PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods showsPrec :: Int -> PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> ShowS # show :: PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> String # showList :: [PostPaymentIntentsIntentCancelRequestBodyCancellationReason'] -> ShowS #
ToJSON PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods toJSON :: PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> Value # toEncoding :: PostPaymentIntentsIntentCancelRequestBodyCancellationReason' -> Encoding # toJSONList :: [PostPaymentIntentsIntentCancelRequestBodyCancellationReason'] -> Value # toEncodingList :: [PostPaymentIntentsIntentCancelRequestBodyCancellationReason'] -> Encoding #
FromJSON PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods parseJSON :: Value -> Parser PostPaymentIntentsIntentCancelRequestBodyCancellationReason' # parseJSONList :: Value -> Parser [PostPaymentIntentsIntentCancelRequestBodyCancellationReason'] #

data PostPaymentIntentsIntentCancelResponse Source #

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.

Constructors

PostPaymentIntentsIntentCancelResponseError String	Means either no matching case available or a parse error
PostPaymentIntentsIntentCancelResponse200 PaymentIntent	Successful response.
PostPaymentIntentsIntentCancelResponseDefault Error	Error response.

Instances

Instances details

Eq PostPaymentIntentsIntentCancelResponse Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods (==) :: PostPaymentIntentsIntentCancelResponse -> PostPaymentIntentsIntentCancelResponse -> Bool # (/=) :: PostPaymentIntentsIntentCancelResponse -> PostPaymentIntentsIntentCancelResponse -> Bool #
Show PostPaymentIntentsIntentCancelResponse Source #
Instance details Defined in StripeAPI.Operations.PostPaymentIntentsIntentCancel Methods showsPrec :: Int -> PostPaymentIntentsIntentCancelResponse -> ShowS # show :: PostPaymentIntentsIntentCancelResponse -> String # showList :: [PostPaymentIntentsIntentCancelResponse] -> ShowS #