| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostPaymentIntentsIntentConfirm
Description
Contains the different functions to run the operation postPaymentIntentsIntentConfirm
Synopsis
- postPaymentIntentsIntentConfirm :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> m (Either HttpException (Response PostPaymentIntentsIntentConfirmResponse))
- postPaymentIntentsIntentConfirmRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> m (Either HttpException (Response ByteString))
- postPaymentIntentsIntentConfirmM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentConfirmResponse))
- postPaymentIntentsIntentConfirmRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostPaymentIntentsIntentConfirmRequestBody = PostPaymentIntentsIntentConfirmRequestBody {
- postPaymentIntentsIntentConfirmRequestBodyClientSecret :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyErrorOnRequiresAction :: Maybe Bool
- postPaymentIntentsIntentConfirmRequestBodyExpand :: Maybe ([] Text)
- postPaymentIntentsIntentConfirmRequestBodyMandate :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyMandateData :: Maybe PostPaymentIntentsIntentConfirmRequestBodyMandateData'
- postPaymentIntentsIntentConfirmRequestBodyOffSession :: Maybe PostPaymentIntentsIntentConfirmRequestBodyOffSession'Variants
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethod :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions :: Maybe PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodTypes :: Maybe ([] Text)
- postPaymentIntentsIntentConfirmRequestBodyReceiptEmail :: Maybe PostPaymentIntentsIntentConfirmRequestBodyReceiptEmail'Variants
- postPaymentIntentsIntentConfirmRequestBodyReturnUrl :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodySavePaymentMethod :: Maybe Bool
- postPaymentIntentsIntentConfirmRequestBodySetupFutureUsage :: Maybe PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'
- postPaymentIntentsIntentConfirmRequestBodyShipping :: Maybe PostPaymentIntentsIntentConfirmRequestBodyShipping'Variants
- postPaymentIntentsIntentConfirmRequestBodyUseStripeSdk :: Maybe Bool
- data PostPaymentIntentsIntentConfirmRequestBodyMandateData' = PostPaymentIntentsIntentConfirmRequestBodyMandateData' {}
- data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance' = PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance' {
- postPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online :: PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online'
- postPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Type :: PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Type'
- data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online' = PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online' {}
- data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Type'
- data PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1
- = PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1EnumStringOneOff
- | PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1EnumStringRecurring
- data PostPaymentIntentsIntentConfirmRequestBodyOffSession'Variants
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions' = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions' {}
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card' = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card' {
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments :: Maybe PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure :: Maybe PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments' = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments' {}
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumString_
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 {
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Count :: Integer
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval :: PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- postPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type :: PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumStringMonth
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumStringFixedCount
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants
- = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2
- data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- = PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAny
- | PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAutomatic
- data PostPaymentIntentsIntentConfirmRequestBodyReceiptEmail'OneOf2
- data PostPaymentIntentsIntentConfirmRequestBodyReceiptEmail'Variants
- data PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'
- = PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'EnumOther Value
- | PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'EnumTyped Text
- | PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'EnumString_
- | PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'EnumStringOffSession
- | PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage'EnumStringOnSession
- data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf1
- data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2 = PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2 {
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address :: PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Carrier :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Name :: Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Phone :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2TrackingNumber :: Maybe Text
- data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address' = PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address' {
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'City :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'Country :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'Line1 :: Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'Line2 :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'PostalCode :: Maybe Text
- postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'State :: Maybe Text
- data PostPaymentIntentsIntentConfirmRequestBodyShipping'Variants
- = PostPaymentIntentsIntentConfirmRequestBodyShipping'PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf1 PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf1
- | PostPaymentIntentsIntentConfirmRequestBodyShipping'PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2 PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2
- data PostPaymentIntentsIntentConfirmResponse
Documentation
postPaymentIntentsIntentConfirm Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | intent | Constraints: Maximum length of 5000 |
| -> Maybe PostPaymentIntentsIntentConfirmRequestBody | The request body to send |
| -> m (Either HttpException (Response PostPaymentIntentsIntentConfirmResponse)) | Monad containing the result of the operation |
POST /v1/payment_intents/{intent}/confirm<p>Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment.</p>
<p>If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the <code>requires_action</code> status and suggest additional actions via <code>next_action</code>. If payment fails, the PaymentIntent will transition to the <code>requires_payment_method</code> status. If payment succeeds, the PaymentIntent will transition to the <code>succeeded</code> status (or <code>requires_capture</code>, if <code>capture_method</code> is set to <code>manual</code>).</p>
<p>If the <code>confirmation_method</code> is <code>automatic</code>, payment may be attempted using our <a href="/docs/stripe-js/reference#stripe-handle-card-payment">client SDKs</a> and the PaymentIntent’s <a href="#payment_intent_object-client_secret">client_secret</a>. After <code>next_action</code>s are handled by the client, no additional confirmation is required to complete the payment.</p>
<p>If the <code>confirmation_method</code> is <code>manual</code>, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the <code>requires_confirmation</code> state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt. Read the <a href="/docs/payments/payment-intents/web-manual">expanded documentation</a> to learn more about manual confirmation.</p>
postPaymentIntentsIntentConfirmRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/payment_intents/{intent}/confirmThe same as postPaymentIntentsIntentConfirm but returns the raw ByteString
postPaymentIntentsIntentConfirmM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentConfirmResponse)) Source #
POST /v1/payment_intents/{intent}/confirmMonadic version of postPaymentIntentsIntentConfirm (use with runWithConfiguration)
postPaymentIntentsIntentConfirmRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostPaymentIntentsIntentConfirmRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/payment_intents/{intent}/confirmMonadic version of postPaymentIntentsIntentConfirmRaw (use with runWithConfiguration)
data PostPaymentIntentsIntentConfirmRequestBody Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBody
Constructors
| PostPaymentIntentsIntentConfirmRequestBody | |
Fields
| |
Instances
data PostPaymentIntentsIntentConfirmRequestBodyMandateData' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyMandate_data'
This hash contains details about the Mandate to create
Instances
data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyMandate_data'Customer_acceptance'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyMandate_data'Customer_acceptance'Online'
Constructors
| PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Online' | |
Fields
| |
Instances
data PostPaymentIntentsIntentConfirmRequestBodyMandateData'CustomerAcceptance'Type' Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyMandate_data'Customer_acceptance'Type'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyOffSession'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyOff_session'OneOf1
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyOffSession'Variants Source #
Define the one-of schema postPaymentIntentsIntentConfirmRequestBodyOff_session'
Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and charge them later.
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'
Payment-method-specific configuration for this PaymentIntent.
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'Plan'OneOf1
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Interval'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Type'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source #
Define the one-of schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Installments'Plan'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyPayment_method_options'Card'Request_three_d_secure'
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyReceiptEmail'OneOf2 Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyReceipt_email'OneOf2
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyReceiptEmail'Variants Source #
Define the one-of schema postPaymentIntentsIntentConfirmRequestBodyReceipt_email'
Email address that the receipt for the resulting payment will be sent to.
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodySetupFutureUsage' Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodySetup_future_usage'
Indicates that you intend to make future payments with this PaymentIntent's payment method.
If present, the payment method used with this PaymentIntent can be attached to a Customer, even after the transaction completes.
Use `on_session` if you intend to only reuse the payment method when your customer is present in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow.
Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by SCA, using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect off-session payments for this customer.
If `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf1
Constructors
Instances
data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2 Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2
Constructors
| PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2 | |
Fields
| |
Instances
data PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address' Source #
Defines the data type for the schema postPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address'
Constructors
| PostPaymentIntentsIntentConfirmRequestBodyShipping'OneOf2Address' | |
Fields
| |
Instances
data PostPaymentIntentsIntentConfirmRequestBodyShipping'Variants Source #
Define the one-of schema postPaymentIntentsIntentConfirmRequestBodyShipping'
Shipping information for this PaymentIntent.
Constructors
Instances
data PostPaymentIntentsIntentConfirmResponse Source #
Represents a response of the operation postPaymentIntentsIntentConfirm.
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), PostPaymentIntentsIntentConfirmResponseError is used.
Constructors
| PostPaymentIntentsIntentConfirmResponseError String | Means either no matching case available or a parse error |
| PostPaymentIntentsIntentConfirmResponse200 PaymentIntent | Successful response. |
| PostPaymentIntentsIntentConfirmResponseDefault Error | Error response. |