| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostPaymentIntentsIntent
Description
Contains the different functions to run the operation postPaymentIntentsIntent
Synopsis
- postPaymentIntentsIntent :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPaymentIntentsIntentRequestBody -> m (Either HttpException (Response PostPaymentIntentsIntentResponse))
- postPaymentIntentsIntentRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPaymentIntentsIntentRequestBody -> m (Either HttpException (Response ByteString))
- postPaymentIntentsIntentM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPaymentIntentsIntentRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentResponse))
- postPaymentIntentsIntentRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPaymentIntentsIntentRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostPaymentIntentsIntentRequestBody = PostPaymentIntentsIntentRequestBody {
- postPaymentIntentsIntentRequestBodyAmount :: Maybe Integer
- postPaymentIntentsIntentRequestBodyApplicationFeeAmount :: Maybe PostPaymentIntentsIntentRequestBodyApplicationFeeAmount'Variants
- postPaymentIntentsIntentRequestBodyCurrency :: Maybe String
- postPaymentIntentsIntentRequestBodyCustomer :: Maybe String
- postPaymentIntentsIntentRequestBodyDescription :: Maybe String
- postPaymentIntentsIntentRequestBodyExpand :: Maybe ([] String)
- postPaymentIntentsIntentRequestBodyMetadata :: Maybe PostPaymentIntentsIntentRequestBodyMetadata'
- postPaymentIntentsIntentRequestBodyPaymentMethod :: Maybe String
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions :: Maybe PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'
- postPaymentIntentsIntentRequestBodyPaymentMethodTypes :: Maybe ([] String)
- postPaymentIntentsIntentRequestBodyReceiptEmail :: Maybe PostPaymentIntentsIntentRequestBodyReceiptEmail'Variants
- postPaymentIntentsIntentRequestBodySavePaymentMethod :: Maybe Bool
- postPaymentIntentsIntentRequestBodySetupFutureUsage :: Maybe PostPaymentIntentsIntentRequestBodySetupFutureUsage'
- postPaymentIntentsIntentRequestBodyShipping :: Maybe PostPaymentIntentsIntentRequestBodyShipping'Variants
- postPaymentIntentsIntentRequestBodyStatementDescriptor :: Maybe String
- postPaymentIntentsIntentRequestBodyStatementDescriptorSuffix :: Maybe String
- postPaymentIntentsIntentRequestBodyTransferData :: Maybe PostPaymentIntentsIntentRequestBodyTransferData'
- postPaymentIntentsIntentRequestBodyTransferGroup :: Maybe String
- data PostPaymentIntentsIntentRequestBodyApplicationFeeAmount'OneOf1
- data PostPaymentIntentsIntentRequestBodyApplicationFeeAmount'Variants
- data PostPaymentIntentsIntentRequestBodyMetadata' = PostPaymentIntentsIntentRequestBodyMetadata' {
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions' = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions' {}
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card' = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card' {
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments :: Maybe PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure :: Maybe PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments' = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments' {}
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumOther Value
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumTyped String
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1EnumString_
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 {
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Count :: Integer
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval :: PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- postPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type :: PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'
- = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumOther Value
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumTyped String
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval'EnumStringMonth
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'
- = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumOther Value
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumTyped String
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type'EnumStringFixedCount
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants
- = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2
- data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'
- = PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumOther Value
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumTyped String
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAny
- | PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure'EnumStringAutomatic
- data PostPaymentIntentsIntentRequestBodyReceiptEmail'OneOf2
- data PostPaymentIntentsIntentRequestBodyReceiptEmail'Variants
- data PostPaymentIntentsIntentRequestBodySetupFutureUsage'
- = PostPaymentIntentsIntentRequestBodySetupFutureUsage'EnumOther Value
- | PostPaymentIntentsIntentRequestBodySetupFutureUsage'EnumTyped String
- | PostPaymentIntentsIntentRequestBodySetupFutureUsage'EnumString_
- | PostPaymentIntentsIntentRequestBodySetupFutureUsage'EnumStringOffSession
- | PostPaymentIntentsIntentRequestBodySetupFutureUsage'EnumStringOnSession
- data PostPaymentIntentsIntentRequestBodyShipping'OneOf1
- data PostPaymentIntentsIntentRequestBodyShipping'OneOf2 = PostPaymentIntentsIntentRequestBodyShipping'OneOf2 {
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address :: PostPaymentIntentsIntentRequestBodyShipping'OneOf2Address'
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Carrier :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Name :: String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Phone :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2TrackingNumber :: Maybe String
- data PostPaymentIntentsIntentRequestBodyShipping'OneOf2Address' = PostPaymentIntentsIntentRequestBodyShipping'OneOf2Address' {
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'City :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'Country :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'Line1 :: String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'Line2 :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'PostalCode :: Maybe String
- postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'State :: Maybe String
- data PostPaymentIntentsIntentRequestBodyShipping'Variants
- data PostPaymentIntentsIntentRequestBodyTransferData' = PostPaymentIntentsIntentRequestBodyTransferData' {}
- data PostPaymentIntentsIntentResponse
Documentation
postPaymentIntentsIntent Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | intent | Constraints: Maximum length of 5000 |
| -> PostPaymentIntentsIntentRequestBody | The request body to send |
| -> m (Either HttpException (Response PostPaymentIntentsIntentResponse)) | Monad containing the result of the operation |
POST /v1/payment_intents/{intent}<p>Updates properties on a PaymentIntent object without confirming.</p>
<p>Depending on which properties you update, you may need to confirm the PaymentIntent again. For example, updating the <code>payment_method</code> will always require you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties via the <a href="/docs/api/payment_intents/confirm">confirm API</a> instead.</p>
postPaymentIntentsIntentRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostPaymentIntentsIntentRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/payment_intents/{intent}The same as postPaymentIntentsIntent but returns the raw ByteString
postPaymentIntentsIntentM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPaymentIntentsIntentRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostPaymentIntentsIntentResponse)) Source #
POST /v1/payment_intents/{intent}Monadic version of postPaymentIntentsIntent (use with runWithConfiguration)
postPaymentIntentsIntentRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostPaymentIntentsIntentRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/payment_intents/{intent}Monadic version of postPaymentIntentsIntentRaw (use with runWithConfiguration)
data PostPaymentIntentsIntentRequestBody Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBody
Constructors
| PostPaymentIntentsIntentRequestBody | |
Fields
| |
Instances
data PostPaymentIntentsIntentRequestBodyApplicationFeeAmount'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyApplication_fee_amount'OneOf1
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyApplicationFeeAmount'Variants Source #
Define the one-of schema postPaymentIntentsIntentRequestBodyApplication_fee_amount'
The amount of the application fee (if any) for the resulting payment. See the PaymentIntents use case for connected accounts for details.
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyMetadata' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyMetadata'
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`.
Constructors
| PostPaymentIntentsIntentRequestBodyMetadata' | |
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyPayment_method_options'
Payment-method-specific configuration for this PaymentIntent.
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'Plan'OneOf1
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2 Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Interval' Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Interval'
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'OneOf2Type' Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'Plan'OneOf2Type'
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'Installments'Plan'Variants Source #
Define the one-of schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Installments'Plan'
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyPaymentMethodOptions'Card'RequestThreeDSecure' Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyPayment_method_options'Card'Request_three_d_secure'
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyReceiptEmail'OneOf2 Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyReceipt_email'OneOf2
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyReceiptEmail'Variants Source #
Define the one-of schema postPaymentIntentsIntentRequestBodyReceipt_email'
Email address that the receipt for the resulting payment will be sent to.
Constructors
Instances
data PostPaymentIntentsIntentRequestBodySetupFutureUsage' Source #
Defines the enum schema postPaymentIntentsIntentRequestBodySetup_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 PostPaymentIntentsIntentRequestBodyShipping'OneOf1 Source #
Defines the enum schema postPaymentIntentsIntentRequestBodyShipping'OneOf1
Constructors
| PostPaymentIntentsIntentRequestBodyShipping'OneOf1EnumOther Value | |
| PostPaymentIntentsIntentRequestBodyShipping'OneOf1EnumTyped String | |
| PostPaymentIntentsIntentRequestBodyShipping'OneOf1EnumString_ |
Instances
data PostPaymentIntentsIntentRequestBodyShipping'OneOf2 Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyShipping'OneOf2
Constructors
| PostPaymentIntentsIntentRequestBodyShipping'OneOf2 | |
Fields
| |
Instances
data PostPaymentIntentsIntentRequestBodyShipping'OneOf2Address' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyShipping'OneOf2Address'
Constructors
| PostPaymentIntentsIntentRequestBodyShipping'OneOf2Address' | |
Fields
| |
Instances
data PostPaymentIntentsIntentRequestBodyShipping'Variants Source #
Define the one-of schema postPaymentIntentsIntentRequestBodyShipping'
Shipping information for this PaymentIntent.
Constructors
Instances
data PostPaymentIntentsIntentRequestBodyTransferData' Source #
Defines the data type for the schema postPaymentIntentsIntentRequestBodyTransfer_data'
The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents use case for connected accounts.
Constructors
| PostPaymentIntentsIntentRequestBodyTransferData' | |
Fields | |
Instances
data PostPaymentIntentsIntentResponse Source #
Represents a response of the operation postPaymentIntentsIntent.
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), PostPaymentIntentsIntentResponseError is used.
Constructors
| PostPaymentIntentsIntentResponseError String | Means either no matching case available or a parse error |
| PostPaymentIntentsIntentResponse200 PaymentIntent | Successful response. |
| PostPaymentIntentsIntentResponseDefault Error | Error response. |