Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postPaymentIntents
Synopsis
- postPaymentIntents :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostPaymentIntentsRequestBody -> m (Either HttpException (Response PostPaymentIntentsResponse))
- postPaymentIntentsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostPaymentIntentsRequestBody -> m (Either HttpException (Response ByteString))
- postPaymentIntentsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsResponse))
- postPaymentIntentsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostPaymentIntentsRequestBody = PostPaymentIntentsRequestBody {
- postPaymentIntentsRequestBodyAmount :: Integer
- postPaymentIntentsRequestBodyApplicationFeeAmount :: Maybe Integer
- postPaymentIntentsRequestBodyCaptureMethod :: Maybe PostPaymentIntentsRequestBodyCaptureMethod'
- postPaymentIntentsRequestBodyConfirm :: Maybe Bool
- postPaymentIntentsRequestBodyConfirmationMethod :: Maybe PostPaymentIntentsRequestBodyConfirmationMethod'
- postPaymentIntentsRequestBodyCurrency :: String
- postPaymentIntentsRequestBodyCustomer :: Maybe String
- postPaymentIntentsRequestBodyDescription :: Maybe String
- postPaymentIntentsRequestBodyErrorOnRequiresAction :: Maybe Bool
- postPaymentIntentsRequestBodyExpand :: Maybe ([] String)
- postPaymentIntentsRequestBodyMandate :: Maybe String
- postPaymentIntentsRequestBodyMandateData :: Maybe PostPaymentIntentsRequestBodyMandateData'
- postPaymentIntentsRequestBodyMetadata :: Maybe PostPaymentIntentsRequestBodyMetadata'
- postPaymentIntentsRequestBodyOffSession :: Maybe PostPaymentIntentsRequestBodyOffSession'Variants
- postPaymentIntentsRequestBodyOnBehalfOf :: Maybe String
- postPaymentIntentsRequestBodyPaymentMethod :: Maybe String
- postPaymentIntentsRequestBodyPaymentMethodOptions :: Maybe PostPaymentIntentsRequestBodyPaymentMethodOptions'
- postPaymentIntentsRequestBodyPaymentMethodTypes :: Maybe ([] String)
- postPaymentIntentsRequestBodyReceiptEmail :: Maybe String
- postPaymentIntentsRequestBodyReturnUrl :: Maybe String
- postPaymentIntentsRequestBodySavePaymentMethod :: Maybe Bool
- postPaymentIntentsRequestBodySetupFutureUsage :: Maybe PostPaymentIntentsRequestBodySetupFutureUsage'
- postPaymentIntentsRequestBodyShipping :: Maybe PostPaymentIntentsRequestBodyShipping'
- postPaymentIntentsRequestBodyStatementDescriptor :: Maybe String
- postPaymentIntentsRequestBodyStatementDescriptorSuffix :: Maybe String
- postPaymentIntentsRequestBodyTransferData :: Maybe PostPaymentIntentsRequestBodyTransferData'
- postPaymentIntentsRequestBodyTransferGroup :: Maybe String
- postPaymentIntentsRequestBodyUseStripeSdk :: Maybe Bool
- data PostPaymentIntentsRequestBodyCaptureMethod'
- data PostPaymentIntentsRequestBodyConfirmationMethod'
- data PostPaymentIntentsRequestBodyMandateData' = PostPaymentIntentsRequestBodyMandateData' {}
- data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' = PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance' {
- postPaymentIntentsRequestBodyMandateData'CustomerAcceptance'AcceptedAt :: Maybe Integer
- postPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline :: Maybe PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline'
- postPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online :: Maybe PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online'
- postPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type :: PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'
- data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' = PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' {
- data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' = PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' {}
- data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'
- = PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'EnumOther Value
- | PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'EnumTyped String
- | PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'EnumStringOffline
- | PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type'EnumStringOnline
- data PostPaymentIntentsRequestBodyMetadata' = PostPaymentIntentsRequestBodyMetadata' {
- data PostPaymentIntentsRequestBodyOffSession'OneOf1
- data PostPaymentIntentsRequestBodyOffSession'Variants
- data PostPaymentIntentsRequestBodyPaymentMethodOptions' = PostPaymentIntentsRequestBodyPaymentMethodOptions' {}
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' {
- postPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments :: Maybe PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'
- postPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure :: Maybe PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' {}
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 {
- postPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Count :: Integer
- postPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval :: PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- postPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type :: PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumOther Value
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumTyped String
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumStringMonth
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumOther Value
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumTyped String
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumStringFixedCount
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants
- = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2
- data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- = PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumOther Value
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumTyped String
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAny
- | PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAutomatic
- data PostPaymentIntentsRequestBodySetupFutureUsage'
- data PostPaymentIntentsRequestBodyShipping' = PostPaymentIntentsRequestBodyShipping' {
- postPaymentIntentsRequestBodyShipping'Address :: PostPaymentIntentsRequestBodyShipping'Address'
- postPaymentIntentsRequestBodyShipping'Carrier :: Maybe String
- postPaymentIntentsRequestBodyShipping'Name :: String
- postPaymentIntentsRequestBodyShipping'Phone :: Maybe String
- postPaymentIntentsRequestBodyShipping'TrackingNumber :: Maybe String
- data PostPaymentIntentsRequestBodyShipping'Address' = PostPaymentIntentsRequestBodyShipping'Address' {
- postPaymentIntentsRequestBodyShipping'Address'City :: Maybe String
- postPaymentIntentsRequestBodyShipping'Address'Country :: Maybe String
- postPaymentIntentsRequestBodyShipping'Address'Line1 :: String
- postPaymentIntentsRequestBodyShipping'Address'Line2 :: Maybe String
- postPaymentIntentsRequestBodyShipping'Address'PostalCode :: Maybe String
- postPaymentIntentsRequestBodyShipping'Address'State :: Maybe String
- data PostPaymentIntentsRequestBodyTransferData' = PostPaymentIntentsRequestBodyTransferData' {}
- data PostPaymentIntentsResponse
Documentation
:: (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
postPaymentIntentsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsResponse)) Source #
POST /v1/payment_intents
Monadic version of postPaymentIntents
(use with runWithConfiguration
)
postPaymentIntentsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostPaymentIntentsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/payment_intents
Monadic version of postPaymentIntentsRaw
(use with runWithConfiguration
)
data PostPaymentIntentsRequestBody Source #
Defines the data type for the schema postPaymentIntentsRequestBody
PostPaymentIntentsRequestBody | |
|
Instances
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'
Instances
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
data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Offline' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Offline'
Instances
data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Online'
PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Online' | |
|
Instances
data PostPaymentIntentsRequestBodyMandateData'CustomerAcceptance'Type' Source #
Defines the enum schema postPaymentIntentsRequestBodyMandate_data'Customer_acceptance'Type'
Instances
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
Instances
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`.
PostPaymentIntentsRequestBodyOffSession'PostPaymentIntentsRequestBodyOffSession'OneOf1 PostPaymentIntentsRequestBodyOffSession'OneOf1 | |
PostPaymentIntentsRequestBodyOffSession'Bool Bool |
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'
Payment-method-specific configuration for this PaymentIntent.
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source #
Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf1
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source #
Defines the data type for the schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source #
Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Interval'
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source #
Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Type'
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source #
Define the one-of schema postPaymentIntentsRequestBodyPayment_method_options'Card'Installments'Plan'
Instances
data PostPaymentIntentsRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source #
Defines the enum schema postPaymentIntentsRequestBodyPayment_method_options'Card'Request_three_d_secure'
Instances
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.
Instances
data PostPaymentIntentsRequestBodyShipping' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyShipping'
Shipping information for this PaymentIntent.
PostPaymentIntentsRequestBodyShipping' | |
|
data PostPaymentIntentsRequestBodyShipping'Address' Source #
Defines the data type for the schema postPaymentIntentsRequestBodyShipping'Address'
PostPaymentIntentsRequestBodyShipping'Address' | |
|
Instances
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.
PostPaymentIntentsResponseError String | Means either no matching case available or a parse error |
PostPaymentIntentsResponse200 PaymentIntent | Successful response. |
PostPaymentIntentsResponseDefault Error | Error response. |