Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostPaymentIntentsIntentCancel

Description

Contains the different functions to run the operation postPaymentIntentsIntentCancel

Synopsis

postPaymentIntentsIntentCancel :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> m (Either HttpException (Response PostPaymentIntentsIntentCancelResponse))
postPaymentIntentsIntentCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> m (Either HttpException (Response ByteString))
postPaymentIntentsIntentCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentCancelResponse))
postPaymentIntentsIntentCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostPaymentIntentsIntentCancelRequestBody = PostPaymentIntentsIntentCancelRequestBody {
- postPaymentIntentsIntentCancelRequestBodyCancellationReason :: Maybe PostPaymentIntentsIntentCancelRequestBodyCancellationReason'
- postPaymentIntentsIntentCancelRequestBodyExpand :: Maybe ([] Text)
}
data PostPaymentIntentsIntentCancelRequestBodyCancellationReason'
data PostPaymentIntentsIntentCancelResponse

Documentation

postPaymentIntentsIntentCancel Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	intent \| Constraints: Maximum length of 5000
-> Maybe 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>

postPaymentIntentsIntentCancelRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/payment_intents/{intent}/cancel

The same as postPaymentIntentsIntentCancel but returns the raw ByteString

postPaymentIntentsIntentCancelM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentCancelResponse)) Source #

POST /v1/payment_intents/{intent}/cancel

Monadic version of postPaymentIntentsIntentCancel (use with runWithConfiguration)

postPaymentIntentsIntentCancelRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentCancelRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/payment_intents/{intent}/cancel

Monadic version of postPaymentIntentsIntentCancelRaw (use with runWithConfiguration)

data PostPaymentIntentsIntentCancelRequestBody Source #

Defines the data type for the schema postPaymentIntentsIntentCancelRequestBody

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

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] #

data PostPaymentIntentsIntentCancelRequestBodyCancellationReason' Source #

Defines the enum schema postPaymentIntentsIntentCancelRequestBodyCancellation_reason'

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

Constructors

PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumOther Value
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumTyped Text
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumStringAbandoned
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumStringDuplicate
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumStringFraudulent
PostPaymentIntentsIntentCancelRequestBodyCancellationReason'EnumStringRequestedByCustomer

Instances

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

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 #