Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema PaymentIntent
Synopsis
- data PaymentIntent = PaymentIntent {
- paymentIntentAmount :: Int
- paymentIntentAmountCapturable :: Maybe Int
- paymentIntentAmountReceived :: Maybe Int
- paymentIntentApplication :: Maybe PaymentIntentApplication'Variants
- paymentIntentApplicationFeeAmount :: Maybe Int
- paymentIntentCanceledAt :: Maybe Int
- paymentIntentCancellationReason :: Maybe PaymentIntentCancellationReason'
- paymentIntentCaptureMethod :: PaymentIntentCaptureMethod'
- paymentIntentCharges :: Maybe PaymentIntentCharges'
- paymentIntentClientSecret :: Maybe Text
- paymentIntentConfirmationMethod :: PaymentIntentConfirmationMethod'
- paymentIntentCreated :: Int
- paymentIntentCurrency :: Text
- paymentIntentCustomer :: Maybe PaymentIntentCustomer'Variants
- paymentIntentDescription :: Maybe Text
- paymentIntentId :: Text
- paymentIntentInvoice :: Maybe PaymentIntentInvoice'Variants
- paymentIntentLastPaymentError :: Maybe PaymentIntentLastPaymentError'
- paymentIntentLivemode :: Bool
- paymentIntentMetadata :: Maybe Object
- paymentIntentNextAction :: Maybe PaymentIntentNextAction'
- paymentIntentOnBehalfOf :: Maybe PaymentIntentOnBehalfOf'Variants
- paymentIntentPaymentMethod :: Maybe PaymentIntentPaymentMethod'Variants
- paymentIntentPaymentMethodOptions :: Maybe PaymentIntentPaymentMethodOptions'
- paymentIntentPaymentMethodTypes :: [Text]
- paymentIntentReceiptEmail :: Maybe Text
- paymentIntentReview :: Maybe PaymentIntentReview'Variants
- paymentIntentSetupFutureUsage :: Maybe PaymentIntentSetupFutureUsage'
- paymentIntentShipping :: Maybe PaymentIntentShipping'
- paymentIntentStatementDescriptor :: Maybe Text
- paymentIntentStatementDescriptorSuffix :: Maybe Text
- paymentIntentStatus :: PaymentIntentStatus'
- paymentIntentTransferData :: Maybe PaymentIntentTransferData'
- paymentIntentTransferGroup :: Maybe Text
- mkPaymentIntent :: Int -> PaymentIntentCaptureMethod' -> PaymentIntentConfirmationMethod' -> Int -> Text -> Text -> Bool -> [Text] -> PaymentIntentStatus' -> PaymentIntent
- data PaymentIntentApplication'Variants
- data PaymentIntentCancellationReason'
- = PaymentIntentCancellationReason'Other Value
- | PaymentIntentCancellationReason'Typed Text
- | PaymentIntentCancellationReason'EnumAbandoned
- | PaymentIntentCancellationReason'EnumAutomatic
- | PaymentIntentCancellationReason'EnumDuplicate
- | PaymentIntentCancellationReason'EnumFailedInvoice
- | PaymentIntentCancellationReason'EnumFraudulent
- | PaymentIntentCancellationReason'EnumRequestedByCustomer
- | PaymentIntentCancellationReason'EnumVoidInvoice
- data PaymentIntentCaptureMethod'
- data PaymentIntentCharges' = PaymentIntentCharges' {}
- mkPaymentIntentCharges' :: [Charge] -> Bool -> Text -> PaymentIntentCharges'
- data PaymentIntentConfirmationMethod'
- data PaymentIntentCustomer'Variants
- data PaymentIntentInvoice'Variants
- data PaymentIntentLastPaymentError' = PaymentIntentLastPaymentError' {
- paymentIntentLastPaymentError'Charge :: Maybe Text
- paymentIntentLastPaymentError'Code :: Maybe Text
- paymentIntentLastPaymentError'DeclineCode :: Maybe Text
- paymentIntentLastPaymentError'DocUrl :: Maybe Text
- paymentIntentLastPaymentError'Message :: Maybe Text
- paymentIntentLastPaymentError'Param :: Maybe Text
- paymentIntentLastPaymentError'PaymentIntent :: Maybe PaymentIntent
- paymentIntentLastPaymentError'PaymentMethod :: Maybe PaymentMethod
- paymentIntentLastPaymentError'PaymentMethodType :: Maybe Text
- paymentIntentLastPaymentError'SetupIntent :: Maybe SetupIntent
- paymentIntentLastPaymentError'Source :: Maybe PaymentIntentLastPaymentError'Source'
- paymentIntentLastPaymentError'Type :: Maybe PaymentIntentLastPaymentError'Type'
- mkPaymentIntentLastPaymentError' :: PaymentIntentLastPaymentError'
- data PaymentIntentLastPaymentError'Source' = PaymentIntentLastPaymentError'Source' {
- paymentIntentLastPaymentError'Source'Account :: Maybe PaymentIntentLastPaymentError'Source'Account'Variants
- paymentIntentLastPaymentError'Source'AccountHolderName :: Maybe Text
- paymentIntentLastPaymentError'Source'AccountHolderType :: Maybe Text
- paymentIntentLastPaymentError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer
- paymentIntentLastPaymentError'Source'AchDebit :: Maybe SourceTypeAchDebit
- paymentIntentLastPaymentError'Source'AcssDebit :: Maybe SourceTypeAcssDebit
- paymentIntentLastPaymentError'Source'AddressCity :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressCountry :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressLine1 :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressLine1Check :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressLine2 :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressState :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressZip :: Maybe Text
- paymentIntentLastPaymentError'Source'AddressZipCheck :: Maybe Text
- paymentIntentLastPaymentError'Source'Alipay :: Maybe SourceTypeAlipay
- paymentIntentLastPaymentError'Source'Amount :: Maybe Int
- paymentIntentLastPaymentError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit
- paymentIntentLastPaymentError'Source'AvailablePayoutMethods :: Maybe [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods']
- paymentIntentLastPaymentError'Source'Bancontact :: Maybe SourceTypeBancontact
- paymentIntentLastPaymentError'Source'BankName :: Maybe Text
- paymentIntentLastPaymentError'Source'Brand :: Maybe Text
- paymentIntentLastPaymentError'Source'Card :: Maybe SourceTypeCard
- paymentIntentLastPaymentError'Source'CardPresent :: Maybe SourceTypeCardPresent
- paymentIntentLastPaymentError'Source'ClientSecret :: Maybe Text
- paymentIntentLastPaymentError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow
- paymentIntentLastPaymentError'Source'Country :: Maybe Text
- paymentIntentLastPaymentError'Source'Created :: Maybe Int
- paymentIntentLastPaymentError'Source'Currency :: Maybe Text
- paymentIntentLastPaymentError'Source'Customer :: Maybe PaymentIntentLastPaymentError'Source'Customer'Variants
- paymentIntentLastPaymentError'Source'CvcCheck :: Maybe Text
- paymentIntentLastPaymentError'Source'DefaultForCurrency :: Maybe Bool
- paymentIntentLastPaymentError'Source'DynamicLast4 :: Maybe Text
- paymentIntentLastPaymentError'Source'Eps :: Maybe SourceTypeEps
- paymentIntentLastPaymentError'Source'ExpMonth :: Maybe Int
- paymentIntentLastPaymentError'Source'ExpYear :: Maybe Int
- paymentIntentLastPaymentError'Source'Fingerprint :: Maybe Text
- paymentIntentLastPaymentError'Source'Flow :: Maybe Text
- paymentIntentLastPaymentError'Source'Funding :: Maybe Text
- paymentIntentLastPaymentError'Source'Giropay :: Maybe SourceTypeGiropay
- paymentIntentLastPaymentError'Source'Id :: Maybe Text
- paymentIntentLastPaymentError'Source'Ideal :: Maybe SourceTypeIdeal
- paymentIntentLastPaymentError'Source'Klarna :: Maybe SourceTypeKlarna
- paymentIntentLastPaymentError'Source'Last4 :: Maybe Text
- paymentIntentLastPaymentError'Source'Livemode :: Maybe Bool
- paymentIntentLastPaymentError'Source'Metadata :: Maybe Object
- paymentIntentLastPaymentError'Source'Multibanco :: Maybe SourceTypeMultibanco
- paymentIntentLastPaymentError'Source'Name :: Maybe Text
- paymentIntentLastPaymentError'Source'Object :: Maybe PaymentIntentLastPaymentError'Source'Object'
- paymentIntentLastPaymentError'Source'Owner :: Maybe PaymentIntentLastPaymentError'Source'Owner'
- paymentIntentLastPaymentError'Source'P24 :: Maybe SourceTypeP24
- paymentIntentLastPaymentError'Source'Receiver :: Maybe SourceReceiverFlow
- paymentIntentLastPaymentError'Source'Recipient :: Maybe PaymentIntentLastPaymentError'Source'Recipient'Variants
- paymentIntentLastPaymentError'Source'Redirect :: Maybe SourceRedirectFlow
- paymentIntentLastPaymentError'Source'RoutingNumber :: Maybe Text
- paymentIntentLastPaymentError'Source'SepaDebit :: Maybe SourceTypeSepaDebit
- paymentIntentLastPaymentError'Source'Sofort :: Maybe SourceTypeSofort
- paymentIntentLastPaymentError'Source'SourceOrder :: Maybe SourceOrder
- paymentIntentLastPaymentError'Source'StatementDescriptor :: Maybe Text
- paymentIntentLastPaymentError'Source'Status :: Maybe Text
- paymentIntentLastPaymentError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure
- paymentIntentLastPaymentError'Source'TokenizationMethod :: Maybe Text
- paymentIntentLastPaymentError'Source'Type :: Maybe PaymentIntentLastPaymentError'Source'Type'
- paymentIntentLastPaymentError'Source'Usage :: Maybe Text
- paymentIntentLastPaymentError'Source'Wechat :: Maybe SourceTypeWechat
- mkPaymentIntentLastPaymentError'Source' :: PaymentIntentLastPaymentError'Source'
- data PaymentIntentLastPaymentError'Source'Account'Variants
- data PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'
- data PaymentIntentLastPaymentError'Source'Customer'Variants
- data PaymentIntentLastPaymentError'Source'Object'
- data PaymentIntentLastPaymentError'Source'Owner' = PaymentIntentLastPaymentError'Source'Owner' {
- paymentIntentLastPaymentError'Source'Owner'Address :: Maybe PaymentIntentLastPaymentError'Source'Owner'Address'
- paymentIntentLastPaymentError'Source'Owner'Email :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Name :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Phone :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress :: Maybe PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'
- paymentIntentLastPaymentError'Source'Owner'VerifiedEmail :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedName :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedPhone :: Maybe Text
- mkPaymentIntentLastPaymentError'Source'Owner' :: PaymentIntentLastPaymentError'Source'Owner'
- data PaymentIntentLastPaymentError'Source'Owner'Address' = PaymentIntentLastPaymentError'Source'Owner'Address' {
- paymentIntentLastPaymentError'Source'Owner'Address'City :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Address'Country :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Address'Line1 :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Address'Line2 :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Address'PostalCode :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'Address'State :: Maybe Text
- mkPaymentIntentLastPaymentError'Source'Owner'Address' :: PaymentIntentLastPaymentError'Source'Owner'Address'
- data PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' = PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' {
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'City :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Country :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text
- paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'State :: Maybe Text
- mkPaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'
- data PaymentIntentLastPaymentError'Source'Recipient'Variants
- data PaymentIntentLastPaymentError'Source'Type'
- = PaymentIntentLastPaymentError'Source'Type'Other Value
- | PaymentIntentLastPaymentError'Source'Type'Typed Text
- | PaymentIntentLastPaymentError'Source'Type'EnumAchCreditTransfer
- | PaymentIntentLastPaymentError'Source'Type'EnumAchDebit
- | PaymentIntentLastPaymentError'Source'Type'EnumAcssDebit
- | PaymentIntentLastPaymentError'Source'Type'EnumAlipay
- | PaymentIntentLastPaymentError'Source'Type'EnumAuBecsDebit
- | PaymentIntentLastPaymentError'Source'Type'EnumBancontact
- | PaymentIntentLastPaymentError'Source'Type'EnumCard
- | PaymentIntentLastPaymentError'Source'Type'EnumCardPresent
- | PaymentIntentLastPaymentError'Source'Type'EnumEps
- | PaymentIntentLastPaymentError'Source'Type'EnumGiropay
- | PaymentIntentLastPaymentError'Source'Type'EnumIdeal
- | PaymentIntentLastPaymentError'Source'Type'EnumKlarna
- | PaymentIntentLastPaymentError'Source'Type'EnumMultibanco
- | PaymentIntentLastPaymentError'Source'Type'EnumP24
- | PaymentIntentLastPaymentError'Source'Type'EnumSepaDebit
- | PaymentIntentLastPaymentError'Source'Type'EnumSofort
- | PaymentIntentLastPaymentError'Source'Type'EnumThreeDSecure
- | PaymentIntentLastPaymentError'Source'Type'EnumWechat
- data PaymentIntentLastPaymentError'Type'
- = PaymentIntentLastPaymentError'Type'Other Value
- | PaymentIntentLastPaymentError'Type'Typed Text
- | PaymentIntentLastPaymentError'Type'EnumApiConnectionError
- | PaymentIntentLastPaymentError'Type'EnumApiError
- | PaymentIntentLastPaymentError'Type'EnumAuthenticationError
- | PaymentIntentLastPaymentError'Type'EnumCardError
- | PaymentIntentLastPaymentError'Type'EnumIdempotencyError
- | PaymentIntentLastPaymentError'Type'EnumInvalidRequestError
- | PaymentIntentLastPaymentError'Type'EnumRateLimitError
- data PaymentIntentNextAction' = PaymentIntentNextAction' {
- paymentIntentNextAction'AlipayHandleRedirect :: Maybe PaymentIntentNextActionAlipayHandleRedirect
- paymentIntentNextAction'BoletoDisplayDetails :: Maybe PaymentIntentNextActionBoleto
- paymentIntentNextAction'OxxoDisplayDetails :: Maybe PaymentIntentNextActionDisplayOxxoDetails
- paymentIntentNextAction'RedirectToUrl :: Maybe PaymentIntentNextActionRedirectToUrl
- paymentIntentNextAction'Type :: Maybe Text
- paymentIntentNextAction'UseStripeSdk :: Maybe Object
- paymentIntentNextAction'VerifyWithMicrodeposits :: Maybe PaymentIntentNextActionVerifyWithMicrodeposits
- mkPaymentIntentNextAction' :: PaymentIntentNextAction'
- data PaymentIntentOnBehalfOf'Variants
- data PaymentIntentPaymentMethod'Variants
- data PaymentIntentPaymentMethodOptions' = PaymentIntentPaymentMethodOptions' {
- paymentIntentPaymentMethodOptions'AcssDebit :: Maybe PaymentIntentPaymentMethodOptionsAcssDebit
- paymentIntentPaymentMethodOptions'AfterpayClearpay :: Maybe PaymentMethodOptionsAfterpayClearpay
- paymentIntentPaymentMethodOptions'Alipay :: Maybe PaymentMethodOptionsAlipay
- paymentIntentPaymentMethodOptions'Bancontact :: Maybe PaymentMethodOptionsBancontact
- paymentIntentPaymentMethodOptions'Boleto :: Maybe PaymentMethodOptionsBoleto
- paymentIntentPaymentMethodOptions'Card :: Maybe PaymentIntentPaymentMethodOptionsCard
- paymentIntentPaymentMethodOptions'CardPresent :: Maybe PaymentMethodOptionsCardPresent
- paymentIntentPaymentMethodOptions'Oxxo :: Maybe PaymentMethodOptionsOxxo
- paymentIntentPaymentMethodOptions'P24 :: Maybe PaymentMethodOptionsP24
- paymentIntentPaymentMethodOptions'SepaDebit :: Maybe PaymentIntentPaymentMethodOptionsSepaDebit
- paymentIntentPaymentMethodOptions'Sofort :: Maybe PaymentMethodOptionsSofort
- mkPaymentIntentPaymentMethodOptions' :: PaymentIntentPaymentMethodOptions'
- data PaymentIntentReview'Variants
- data PaymentIntentSetupFutureUsage'
- data PaymentIntentShipping' = PaymentIntentShipping' {}
- mkPaymentIntentShipping' :: PaymentIntentShipping'
- data PaymentIntentStatus'
- = PaymentIntentStatus'Other Value
- | PaymentIntentStatus'Typed Text
- | PaymentIntentStatus'EnumCanceled
- | PaymentIntentStatus'EnumProcessing
- | PaymentIntentStatus'EnumRequiresAction
- | PaymentIntentStatus'EnumRequiresCapture
- | PaymentIntentStatus'EnumRequiresConfirmation
- | PaymentIntentStatus'EnumRequiresPaymentMethod
- | PaymentIntentStatus'EnumSucceeded
- data PaymentIntentTransferData' = PaymentIntentTransferData' {}
- mkPaymentIntentTransferData' :: PaymentIntentTransferData'
- data PaymentIntentTransferData'Destination'Variants
Documentation
data PaymentIntent Source #
Defines the object schema located at components.schemas.payment_intent
in the specification.
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.
Related guide: Payment Intents API.
PaymentIntent | |
|
Instances
Eq PaymentIntent Source # | |
Defined in StripeAPI.Types.PaymentIntent (==) :: PaymentIntent -> PaymentIntent -> Bool # (/=) :: PaymentIntent -> PaymentIntent -> Bool # | |
Show PaymentIntent Source # | |
Defined in StripeAPI.Types.PaymentIntent showsPrec :: Int -> PaymentIntent -> ShowS # show :: PaymentIntent -> String # showList :: [PaymentIntent] -> ShowS # | |
ToJSON PaymentIntent Source # | |
Defined in StripeAPI.Types.PaymentIntent toJSON :: PaymentIntent -> Value # toEncoding :: PaymentIntent -> Encoding # toJSONList :: [PaymentIntent] -> Value # toEncodingList :: [PaymentIntent] -> Encoding # | |
FromJSON PaymentIntent Source # | |
Defined in StripeAPI.Types.PaymentIntent parseJSON :: Value -> Parser PaymentIntent # parseJSONList :: Value -> Parser [PaymentIntent] # |
:: Int | |
-> PaymentIntentCaptureMethod' | |
-> PaymentIntentConfirmationMethod' | |
-> Int | |
-> Text | |
-> Text | |
-> Bool | |
-> [Text] | |
-> PaymentIntentStatus' | |
-> PaymentIntent |
Create a new PaymentIntent
with all required fields.
data PaymentIntentApplication'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.application.anyOf
in the specification.
ID of the Connect application that created the PaymentIntent.
data PaymentIntentCancellationReason' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.cancellation_reason
in the specification.
Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
PaymentIntentCancellationReason'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentCancellationReason'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentCancellationReason'EnumAbandoned | Represents the JSON value |
PaymentIntentCancellationReason'EnumAutomatic | Represents the JSON value |
PaymentIntentCancellationReason'EnumDuplicate | Represents the JSON value |
PaymentIntentCancellationReason'EnumFailedInvoice | Represents the JSON value |
PaymentIntentCancellationReason'EnumFraudulent | Represents the JSON value |
PaymentIntentCancellationReason'EnumRequestedByCustomer | Represents the JSON value |
PaymentIntentCancellationReason'EnumVoidInvoice | Represents the JSON value |
data PaymentIntentCaptureMethod' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.capture_method
in the specification.
Controls when the funds will be captured from the customer's account.
PaymentIntentCaptureMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentCaptureMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentCaptureMethod'EnumAutomatic | Represents the JSON value |
PaymentIntentCaptureMethod'EnumManual | Represents the JSON value |
Instances
data PaymentIntentCharges' Source #
Defines the object schema located at components.schemas.payment_intent.properties.charges
in the specification.
Charges that were created by this PaymentIntent, if any.
PaymentIntentCharges' | |
|
Instances
Eq PaymentIntentCharges' Source # | |
Defined in StripeAPI.Types.PaymentIntent (==) :: PaymentIntentCharges' -> PaymentIntentCharges' -> Bool # (/=) :: PaymentIntentCharges' -> PaymentIntentCharges' -> Bool # | |
Show PaymentIntentCharges' Source # | |
Defined in StripeAPI.Types.PaymentIntent showsPrec :: Int -> PaymentIntentCharges' -> ShowS # show :: PaymentIntentCharges' -> String # showList :: [PaymentIntentCharges'] -> ShowS # | |
ToJSON PaymentIntentCharges' Source # | |
Defined in StripeAPI.Types.PaymentIntent toJSON :: PaymentIntentCharges' -> Value # toEncoding :: PaymentIntentCharges' -> Encoding # toJSONList :: [PaymentIntentCharges'] -> Value # toEncodingList :: [PaymentIntentCharges'] -> Encoding # | |
FromJSON PaymentIntentCharges' Source # | |
Defined in StripeAPI.Types.PaymentIntent parseJSON :: Value -> Parser PaymentIntentCharges' # parseJSONList :: Value -> Parser [PaymentIntentCharges'] # |
mkPaymentIntentCharges' Source #
:: [Charge] | |
-> Bool | |
-> Text | |
-> PaymentIntentCharges' |
Create a new PaymentIntentCharges'
with all required fields.
data PaymentIntentConfirmationMethod' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.confirmation_method
in the specification.
PaymentIntentConfirmationMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentConfirmationMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentConfirmationMethod'EnumAutomatic | Represents the JSON value |
PaymentIntentConfirmationMethod'EnumManual | Represents the JSON value |
data PaymentIntentCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.customer.anyOf
in the specification.
ID of the Customer this PaymentIntent belongs to, if one exists.
Payment methods attached to other Customers cannot be used with this PaymentIntent.
If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
PaymentIntentCustomer'Text Text | |
PaymentIntentCustomer'Customer Customer | |
PaymentIntentCustomer'DeletedCustomer DeletedCustomer |
data PaymentIntentInvoice'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.invoice.anyOf
in the specification.
ID of the invoice that created this PaymentIntent, if it exists.
Instances
data PaymentIntentLastPaymentError' Source #
Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf
in the specification.
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
PaymentIntentLastPaymentError' | |
|
mkPaymentIntentLastPaymentError' :: PaymentIntentLastPaymentError' Source #
Create a new PaymentIntentLastPaymentError'
with all required fields.
data PaymentIntentLastPaymentError'Source' Source #
Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf
in the specification.
The source object for errors returned on a request involving a source.
PaymentIntentLastPaymentError'Source' | |
|
mkPaymentIntentLastPaymentError'Source' :: PaymentIntentLastPaymentError'Source' Source #
Create a new PaymentIntentLastPaymentError'Source'
with all required fields.
data PaymentIntentLastPaymentError'Source'Account'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.account.anyOf
in the specification.
The ID of the account that the bank account is associated with.
PaymentIntentLastPaymentError'Source'Account'Text Text | |
PaymentIntentLastPaymentError'Source'Account'Account Account |
Instances
data PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.available_payout_methods.items
in the specification.
PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'EnumInstant | Represents the JSON value |
PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'EnumStandard | Represents the JSON value |
Instances
data PaymentIntentLastPaymentError'Source'Customer'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.customer.anyOf
in the specification.
The ID of the customer that the bank account is associated with.
PaymentIntentLastPaymentError'Source'Customer'Text Text | |
PaymentIntentLastPaymentError'Source'Customer'Customer Customer | |
PaymentIntentLastPaymentError'Source'Customer'DeletedCustomer DeletedCustomer |
Instances
data PaymentIntentLastPaymentError'Source'Object' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.object
in the specification.
String representing the object's type. Objects of the same type share the same value.
PaymentIntentLastPaymentError'Source'Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentLastPaymentError'Source'Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentLastPaymentError'Source'Object'EnumBankAccount | Represents the JSON value |
data PaymentIntentLastPaymentError'Source'Owner' Source #
Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf
in the specification.
Information about the owner of the payment instrument that may be used or required by particular source types.
PaymentIntentLastPaymentError'Source'Owner' | |
|
mkPaymentIntentLastPaymentError'Source'Owner' :: PaymentIntentLastPaymentError'Source'Owner' Source #
Create a new PaymentIntentLastPaymentError'Source'Owner'
with all required fields.
data PaymentIntentLastPaymentError'Source'Owner'Address' Source #
Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.address.anyOf
in the specification.
Owner\'s address.
PaymentIntentLastPaymentError'Source'Owner'Address' | |
|
Instances
mkPaymentIntentLastPaymentError'Source'Owner'Address' :: PaymentIntentLastPaymentError'Source'Owner'Address' Source #
Create a new PaymentIntentLastPaymentError'Source'Owner'Address'
with all required fields.
data PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' Source #
Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.verified_address.anyOf
in the specification.
Verified owner\'s address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.
PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' | |
|
Instances
mkPaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' Source #
Create a new PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'
with all required fields.
data PaymentIntentLastPaymentError'Source'Recipient'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.recipient.anyOf
in the specification.
The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.
PaymentIntentLastPaymentError'Source'Recipient'Text Text | |
PaymentIntentLastPaymentError'Source'Recipient'Recipient Recipient |
Instances
data PaymentIntentLastPaymentError'Source'Type' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.type
in the specification.
The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.
data PaymentIntentLastPaymentError'Type' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.type
in the specification.
The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`
PaymentIntentLastPaymentError'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentLastPaymentError'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentLastPaymentError'Type'EnumApiConnectionError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumApiError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumAuthenticationError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumCardError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumIdempotencyError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumInvalidRequestError | Represents the JSON value |
PaymentIntentLastPaymentError'Type'EnumRateLimitError | Represents the JSON value |
data PaymentIntentNextAction' Source #
Defines the object schema located at components.schemas.payment_intent.properties.next_action.anyOf
in the specification.
If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.
PaymentIntentNextAction' | |
|
Instances
Eq PaymentIntentNextAction' Source # | |
Defined in StripeAPI.Types.PaymentIntent | |
Show PaymentIntentNextAction' Source # | |
Defined in StripeAPI.Types.PaymentIntent showsPrec :: Int -> PaymentIntentNextAction' -> ShowS # show :: PaymentIntentNextAction' -> String # showList :: [PaymentIntentNextAction'] -> ShowS # | |
ToJSON PaymentIntentNextAction' Source # | |
Defined in StripeAPI.Types.PaymentIntent | |
FromJSON PaymentIntentNextAction' Source # | |
Defined in StripeAPI.Types.PaymentIntent |
mkPaymentIntentNextAction' :: PaymentIntentNextAction' Source #
Create a new PaymentIntentNextAction'
with all required fields.
data PaymentIntentOnBehalfOf'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.on_behalf_of.anyOf
in the specification.
The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.
data PaymentIntentPaymentMethod'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.payment_method.anyOf
in the specification.
ID of the payment method used in this PaymentIntent.
data PaymentIntentPaymentMethodOptions' Source #
Defines the object schema located at components.schemas.payment_intent.properties.payment_method_options.anyOf
in the specification.
Payment-method-specific configuration for this PaymentIntent.
mkPaymentIntentPaymentMethodOptions' :: PaymentIntentPaymentMethodOptions' Source #
Create a new PaymentIntentPaymentMethodOptions'
with all required fields.
data PaymentIntentReview'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.review.anyOf
in the specification.
ID of the review associated with this PaymentIntent, if any.
Instances
data PaymentIntentSetupFutureUsage' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.setup_future_usage
in the specification.
Indicates that you intend to make future payments with this PaymentIntent's payment method.
Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.
When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.
PaymentIntentSetupFutureUsage'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentSetupFutureUsage'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentSetupFutureUsage'EnumOffSession | Represents the JSON value |
PaymentIntentSetupFutureUsage'EnumOnSession | Represents the JSON value |
data PaymentIntentShipping' Source #
Defines the object schema located at components.schemas.payment_intent.properties.shipping.anyOf
in the specification.
Shipping information for this PaymentIntent.
PaymentIntentShipping' | |
|
Instances
Eq PaymentIntentShipping' Source # | |
Defined in StripeAPI.Types.PaymentIntent | |
Show PaymentIntentShipping' Source # | |
Defined in StripeAPI.Types.PaymentIntent showsPrec :: Int -> PaymentIntentShipping' -> ShowS # show :: PaymentIntentShipping' -> String # showList :: [PaymentIntentShipping'] -> ShowS # | |
ToJSON PaymentIntentShipping' Source # | |
Defined in StripeAPI.Types.PaymentIntent toJSON :: PaymentIntentShipping' -> Value # toEncoding :: PaymentIntentShipping' -> Encoding # toJSONList :: [PaymentIntentShipping'] -> Value # | |
FromJSON PaymentIntentShipping' Source # | |
Defined in StripeAPI.Types.PaymentIntent |
mkPaymentIntentShipping' :: PaymentIntentShipping' Source #
Create a new PaymentIntentShipping'
with all required fields.
data PaymentIntentStatus' Source #
Defines the enum schema located at components.schemas.payment_intent.properties.status
in the specification.
Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent status.
PaymentIntentStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
PaymentIntentStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
PaymentIntentStatus'EnumCanceled | Represents the JSON value |
PaymentIntentStatus'EnumProcessing | Represents the JSON value |
PaymentIntentStatus'EnumRequiresAction | Represents the JSON value |
PaymentIntentStatus'EnumRequiresCapture | Represents the JSON value |
PaymentIntentStatus'EnumRequiresConfirmation | Represents the JSON value |
PaymentIntentStatus'EnumRequiresPaymentMethod | Represents the JSON value |
PaymentIntentStatus'EnumSucceeded | Represents the JSON value |
Instances
Eq PaymentIntentStatus' Source # | |
Defined in StripeAPI.Types.PaymentIntent (==) :: PaymentIntentStatus' -> PaymentIntentStatus' -> Bool # (/=) :: PaymentIntentStatus' -> PaymentIntentStatus' -> Bool # | |
Show PaymentIntentStatus' Source # | |
Defined in StripeAPI.Types.PaymentIntent showsPrec :: Int -> PaymentIntentStatus' -> ShowS # show :: PaymentIntentStatus' -> String # showList :: [PaymentIntentStatus'] -> ShowS # | |
ToJSON PaymentIntentStatus' Source # | |
Defined in StripeAPI.Types.PaymentIntent toJSON :: PaymentIntentStatus' -> Value # toEncoding :: PaymentIntentStatus' -> Encoding # toJSONList :: [PaymentIntentStatus'] -> Value # toEncodingList :: [PaymentIntentStatus'] -> Encoding # | |
FromJSON PaymentIntentStatus' Source # | |
Defined in StripeAPI.Types.PaymentIntent parseJSON :: Value -> Parser PaymentIntentStatus' # parseJSONList :: Value -> Parser [PaymentIntentStatus'] # |
data PaymentIntentTransferData' Source #
Defines the object schema located at components.schemas.payment_intent.properties.transfer_data.anyOf
in the specification.
The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.
PaymentIntentTransferData' | |
|
Instances
mkPaymentIntentTransferData' :: PaymentIntentTransferData' Source #
Create a new PaymentIntentTransferData'
with all required fields.
data PaymentIntentTransferData'Destination'Variants Source #
Defines the oneOf schema located at components.schemas.payment_intent.properties.transfer_data.anyOf.properties.destination.anyOf
in the specification.
The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.
PaymentIntentTransferData'Destination'Text Text | |
PaymentIntentTransferData'Destination'Account Account |