stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostPaymentIntents

Description

Contains the different functions to run the operation postPaymentIntents

Synopsis

Documentation

postPaymentIntents Source #

Arguments

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

The configuration to use in the request

-> PostPaymentIntentsRequestBody

The request body to send

-> m (Either HttpException (Response PostPaymentIntentsResponse))

Monad containing the result of the operation

POST /v1/payment_intents

<p>Creates a PaymentIntent object.</p>

<p>After the PaymentIntent is created, attach a payment method and <a href="/docs/api/payment_intents/confirm">confirm</a> to continue the payment. You can read more about the different payment flows available via the Payment Intents API <a href="/docs/payments/payment-intents">here</a>.</p>

<p>When <code>confirm=true</code> is used during creation, it is equivalent to creating and confirming the PaymentIntent in the same call. You may use any parameters available in the <a href="/docs/api/payment_intents/confirm">confirm API</a> when <code>confirm=true</code> is supplied.</p>

postPaymentIntentsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostPaymentIntentsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/payment_intents

The same as postPaymentIntents but returns the raw ByteString

data PostPaymentIntentsRequestBody Source #

Defines the data type for the schema postPaymentIntentsRequestBody

Constructors

PostPaymentIntentsRequestBody 

Fields

data PostPaymentIntentsRequestBodyCaptureMethod' Source #

Defines the enum schema postPaymentIntentsRequestBodyCapture_method'

Controls when the funds will be captured from the customer's account.

data PostPaymentIntentsRequestBodyConfirmationMethod' Source #

Defines the enum schema postPaymentIntentsRequestBodyConfirmation_method'

data PostPaymentIntentsRequestBodyMandateData' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'

This hash contains details about the Mandate to create. This parameter can only be used with `confirm=true`.

data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'

Instances
Eq PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Offline'

Instances
Eq PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Online'

Instances
Eq PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source #

Defines the enum schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Type'

Instances
Eq PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyMetadata' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data PostPaymentIntentsRequestBodyOffSession'OneOf1 Source #

Defines the enum schema postPaymentIntentsRequestBodyOff_session'OneOf1

data PostPaymentIntentsRequestBodyOffSession'Variants Source #

Define the one-of schema postPaymentIntentsRequestBodyOff_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. This parameter can only be used with `confirm=true`.

Instances
Eq PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Generic PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

type Rep PostPaymentIntentsRequestBodyOffSession'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

type Rep PostPaymentIntentsRequestBodyOffSession'Variants = D1 (MetaData "PostPaymentIntentsRequestBodyOffSession'Variants" "StripeAPI.Operations.PostPaymentIntents" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostPaymentIntentsRequestBodyOffSession'PostPaymentIntentsRequestBodyOffSession'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostPaymentIntentsRequestBodyOffSession'OneOf1)) :+: C1 (MetaCons "PostPaymentIntentsRequestBodyOffSession'Bool" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))

data PostPaymentIntentsRequestBodyPaymentMethodOptions' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'

Payment-method-specific configuration for this PaymentIntent.

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source #

Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf1

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source #

Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source #

Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Interval'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source #

Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Type'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source #

Define the one-of schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Generic PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

type Rep PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

type Rep PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants = D1 (MetaData "PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants" "StripeAPI.Operations.PostPaymentIntents" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1)) :+: C1 (MetaCons "PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2)))

data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source #

Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Request_three_d_secure'

Instances
Eq PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

Show PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

ToJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

FromJSON PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source # 
Instance details

Defined in StripeAPI.Operations.PostPaymentIntents

data PostPaymentIntentsRequestBodySetupFutureUsage' Source #

Defines the enum schema postPaymentIntentsRequestBodySetup_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.

For more, learn to save card details during payment.

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.

data PostPaymentIntentsRequestBodyShipping' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyShipping'

Shipping information for this PaymentIntent.

data PostPaymentIntentsRequestBodyShipping'Address' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyShipping'Address'

Constructors

PostPaymentIntentsRequestBodyShipping'Address' 

Fields

data PostPaymentIntentsRequestBodyTransferData' Source #

Defines the data type for the schema postPaymentIntentsRequestBodyTransfer_data'

The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.

data PostPaymentIntentsResponse Source #

Represents a response of the operation postPaymentIntents.

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), PostPaymentIntentsResponseError is used.

Constructors

PostPaymentIntentsResponseError String

Means either no matching case available or a parse error

PostPaymentIntentsResponse200 PaymentIntent

Successful response.

PostPaymentIntentsResponseDefault Error

Error response.