Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.SetupIntent
Description
Contains the types generated from the schema SetupIntent
Synopsis
- data SetupIntent = SetupIntent {
- setupIntentApplication :: Maybe SetupIntentApplication'Variants
- setupIntentCancellationReason :: Maybe SetupIntentCancellationReason'
- setupIntentClientSecret :: Maybe Text
- setupIntentCreated :: Int
- setupIntentCustomer :: Maybe SetupIntentCustomer'Variants
- setupIntentDescription :: Maybe Text
- setupIntentId :: Text
- setupIntentLastSetupError :: Maybe SetupIntentLastSetupError'
- setupIntentLatestAttempt :: Maybe SetupIntentLatestAttempt'Variants
- setupIntentLivemode :: Bool
- setupIntentMandate :: Maybe SetupIntentMandate'Variants
- setupIntentMetadata :: Maybe Object
- setupIntentNextAction :: Maybe SetupIntentNextAction'
- setupIntentOnBehalfOf :: Maybe SetupIntentOnBehalfOf'Variants
- setupIntentPaymentMethod :: Maybe SetupIntentPaymentMethod'Variants
- setupIntentPaymentMethodOptions :: Maybe SetupIntentPaymentMethodOptions'
- setupIntentPaymentMethodTypes :: [Text]
- setupIntentSingleUseMandate :: Maybe SetupIntentSingleUseMandate'Variants
- setupIntentStatus :: SetupIntentStatus'
- setupIntentUsage :: Text
- mkSetupIntent :: Int -> Text -> Bool -> [Text] -> SetupIntentStatus' -> Text -> SetupIntent
- data SetupIntentApplication'Variants
- data SetupIntentCancellationReason'
- data SetupIntentCustomer'Variants
- data SetupIntentLastSetupError' = SetupIntentLastSetupError' {
- setupIntentLastSetupError'Charge :: Maybe Text
- setupIntentLastSetupError'Code :: Maybe Text
- setupIntentLastSetupError'DeclineCode :: Maybe Text
- setupIntentLastSetupError'DocUrl :: Maybe Text
- setupIntentLastSetupError'Message :: Maybe Text
- setupIntentLastSetupError'Param :: Maybe Text
- setupIntentLastSetupError'PaymentIntent :: Maybe PaymentIntent
- setupIntentLastSetupError'PaymentMethod :: Maybe PaymentMethod
- setupIntentLastSetupError'PaymentMethodType :: Maybe Text
- setupIntentLastSetupError'SetupIntent :: Maybe SetupIntent
- setupIntentLastSetupError'Source :: Maybe SetupIntentLastSetupError'Source'
- setupIntentLastSetupError'Type :: Maybe SetupIntentLastSetupError'Type'
- mkSetupIntentLastSetupError' :: SetupIntentLastSetupError'
- data SetupIntentLastSetupError'Source' = SetupIntentLastSetupError'Source' {
- setupIntentLastSetupError'Source'Account :: Maybe SetupIntentLastSetupError'Source'Account'Variants
- setupIntentLastSetupError'Source'AccountHolderName :: Maybe Text
- setupIntentLastSetupError'Source'AccountHolderType :: Maybe Text
- setupIntentLastSetupError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer
- setupIntentLastSetupError'Source'AchDebit :: Maybe SourceTypeAchDebit
- setupIntentLastSetupError'Source'AcssDebit :: Maybe SourceTypeAcssDebit
- setupIntentLastSetupError'Source'AddressCity :: Maybe Text
- setupIntentLastSetupError'Source'AddressCountry :: Maybe Text
- setupIntentLastSetupError'Source'AddressLine1 :: Maybe Text
- setupIntentLastSetupError'Source'AddressLine1Check :: Maybe Text
- setupIntentLastSetupError'Source'AddressLine2 :: Maybe Text
- setupIntentLastSetupError'Source'AddressState :: Maybe Text
- setupIntentLastSetupError'Source'AddressZip :: Maybe Text
- setupIntentLastSetupError'Source'AddressZipCheck :: Maybe Text
- setupIntentLastSetupError'Source'Alipay :: Maybe SourceTypeAlipay
- setupIntentLastSetupError'Source'Amount :: Maybe Int
- setupIntentLastSetupError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit
- setupIntentLastSetupError'Source'AvailablePayoutMethods :: Maybe [SetupIntentLastSetupError'Source'AvailablePayoutMethods']
- setupIntentLastSetupError'Source'Bancontact :: Maybe SourceTypeBancontact
- setupIntentLastSetupError'Source'BankName :: Maybe Text
- setupIntentLastSetupError'Source'Brand :: Maybe Text
- setupIntentLastSetupError'Source'Card :: Maybe SourceTypeCard
- setupIntentLastSetupError'Source'CardPresent :: Maybe SourceTypeCardPresent
- setupIntentLastSetupError'Source'ClientSecret :: Maybe Text
- setupIntentLastSetupError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow
- setupIntentLastSetupError'Source'Country :: Maybe Text
- setupIntentLastSetupError'Source'Created :: Maybe Int
- setupIntentLastSetupError'Source'Currency :: Maybe Text
- setupIntentLastSetupError'Source'Customer :: Maybe SetupIntentLastSetupError'Source'Customer'Variants
- setupIntentLastSetupError'Source'CvcCheck :: Maybe Text
- setupIntentLastSetupError'Source'DefaultForCurrency :: Maybe Bool
- setupIntentLastSetupError'Source'DynamicLast4 :: Maybe Text
- setupIntentLastSetupError'Source'Eps :: Maybe SourceTypeEps
- setupIntentLastSetupError'Source'ExpMonth :: Maybe Int
- setupIntentLastSetupError'Source'ExpYear :: Maybe Int
- setupIntentLastSetupError'Source'Fingerprint :: Maybe Text
- setupIntentLastSetupError'Source'Flow :: Maybe Text
- setupIntentLastSetupError'Source'Funding :: Maybe Text
- setupIntentLastSetupError'Source'Giropay :: Maybe SourceTypeGiropay
- setupIntentLastSetupError'Source'Id :: Maybe Text
- setupIntentLastSetupError'Source'Ideal :: Maybe SourceTypeIdeal
- setupIntentLastSetupError'Source'Klarna :: Maybe SourceTypeKlarna
- setupIntentLastSetupError'Source'Last4 :: Maybe Text
- setupIntentLastSetupError'Source'Livemode :: Maybe Bool
- setupIntentLastSetupError'Source'Metadata :: Maybe Object
- setupIntentLastSetupError'Source'Multibanco :: Maybe SourceTypeMultibanco
- setupIntentLastSetupError'Source'Name :: Maybe Text
- setupIntentLastSetupError'Source'Owner :: Maybe SetupIntentLastSetupError'Source'Owner'
- setupIntentLastSetupError'Source'P24 :: Maybe SourceTypeP24
- setupIntentLastSetupError'Source'Receiver :: Maybe SourceReceiverFlow
- setupIntentLastSetupError'Source'Recipient :: Maybe SetupIntentLastSetupError'Source'Recipient'Variants
- setupIntentLastSetupError'Source'Redirect :: Maybe SourceRedirectFlow
- setupIntentLastSetupError'Source'RoutingNumber :: Maybe Text
- setupIntentLastSetupError'Source'SepaDebit :: Maybe SourceTypeSepaDebit
- setupIntentLastSetupError'Source'Sofort :: Maybe SourceTypeSofort
- setupIntentLastSetupError'Source'SourceOrder :: Maybe SourceOrder
- setupIntentLastSetupError'Source'StatementDescriptor :: Maybe Text
- setupIntentLastSetupError'Source'Status :: Maybe Text
- setupIntentLastSetupError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure
- setupIntentLastSetupError'Source'TokenizationMethod :: Maybe Text
- setupIntentLastSetupError'Source'Type :: Maybe SetupIntentLastSetupError'Source'Type'
- setupIntentLastSetupError'Source'Usage :: Maybe Text
- setupIntentLastSetupError'Source'Wechat :: Maybe SourceTypeWechat
- mkSetupIntentLastSetupError'Source' :: SetupIntentLastSetupError'Source'
- data SetupIntentLastSetupError'Source'Account'Variants
- data SetupIntentLastSetupError'Source'AvailablePayoutMethods'
- data SetupIntentLastSetupError'Source'Customer'Variants
- data SetupIntentLastSetupError'Source'Owner' = SetupIntentLastSetupError'Source'Owner' {
- setupIntentLastSetupError'Source'Owner'Address :: Maybe SetupIntentLastSetupError'Source'Owner'Address'
- setupIntentLastSetupError'Source'Owner'Email :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Name :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Phone :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress :: Maybe SetupIntentLastSetupError'Source'Owner'VerifiedAddress'
- setupIntentLastSetupError'Source'Owner'VerifiedEmail :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedName :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedPhone :: Maybe Text
- mkSetupIntentLastSetupError'Source'Owner' :: SetupIntentLastSetupError'Source'Owner'
- data SetupIntentLastSetupError'Source'Owner'Address' = SetupIntentLastSetupError'Source'Owner'Address' {
- setupIntentLastSetupError'Source'Owner'Address'City :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Address'Country :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Address'Line1 :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Address'Line2 :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Address'PostalCode :: Maybe Text
- setupIntentLastSetupError'Source'Owner'Address'State :: Maybe Text
- mkSetupIntentLastSetupError'Source'Owner'Address' :: SetupIntentLastSetupError'Source'Owner'Address'
- data SetupIntentLastSetupError'Source'Owner'VerifiedAddress' = SetupIntentLastSetupError'Source'Owner'VerifiedAddress' {
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'City :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'Country :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text
- setupIntentLastSetupError'Source'Owner'VerifiedAddress'State :: Maybe Text
- mkSetupIntentLastSetupError'Source'Owner'VerifiedAddress' :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress'
- data SetupIntentLastSetupError'Source'Recipient'Variants
- data SetupIntentLastSetupError'Source'Type'
- = SetupIntentLastSetupError'Source'Type'Other Value
- | SetupIntentLastSetupError'Source'Type'Typed Text
- | SetupIntentLastSetupError'Source'Type'EnumAchCreditTransfer
- | SetupIntentLastSetupError'Source'Type'EnumAchDebit
- | SetupIntentLastSetupError'Source'Type'EnumAcssDebit
- | SetupIntentLastSetupError'Source'Type'EnumAlipay
- | SetupIntentLastSetupError'Source'Type'EnumAuBecsDebit
- | SetupIntentLastSetupError'Source'Type'EnumBancontact
- | SetupIntentLastSetupError'Source'Type'EnumCard
- | SetupIntentLastSetupError'Source'Type'EnumCardPresent
- | SetupIntentLastSetupError'Source'Type'EnumEps
- | SetupIntentLastSetupError'Source'Type'EnumGiropay
- | SetupIntentLastSetupError'Source'Type'EnumIdeal
- | SetupIntentLastSetupError'Source'Type'EnumKlarna
- | SetupIntentLastSetupError'Source'Type'EnumMultibanco
- | SetupIntentLastSetupError'Source'Type'EnumP24
- | SetupIntentLastSetupError'Source'Type'EnumSepaDebit
- | SetupIntentLastSetupError'Source'Type'EnumSofort
- | SetupIntentLastSetupError'Source'Type'EnumThreeDSecure
- | SetupIntentLastSetupError'Source'Type'EnumWechat
- data SetupIntentLastSetupError'Type'
- = SetupIntentLastSetupError'Type'Other Value
- | SetupIntentLastSetupError'Type'Typed Text
- | SetupIntentLastSetupError'Type'EnumApiConnectionError
- | SetupIntentLastSetupError'Type'EnumApiError
- | SetupIntentLastSetupError'Type'EnumAuthenticationError
- | SetupIntentLastSetupError'Type'EnumCardError
- | SetupIntentLastSetupError'Type'EnumIdempotencyError
- | SetupIntentLastSetupError'Type'EnumInvalidRequestError
- | SetupIntentLastSetupError'Type'EnumRateLimitError
- data SetupIntentLatestAttempt'Variants
- data SetupIntentMandate'Variants
- data SetupIntentNextAction' = SetupIntentNextAction' {}
- mkSetupIntentNextAction' :: SetupIntentNextAction'
- data SetupIntentOnBehalfOf'Variants
- data SetupIntentPaymentMethod'Variants
- data SetupIntentPaymentMethodOptions' = SetupIntentPaymentMethodOptions' {}
- mkSetupIntentPaymentMethodOptions' :: SetupIntentPaymentMethodOptions'
- data SetupIntentSingleUseMandate'Variants
- data SetupIntentStatus'
Documentation
data SetupIntent Source #
Defines the object schema located at components.schemas.setup_intent
in the specification.
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.
Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.
Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.
Related guide: Setup Intents API.
Constructors
SetupIntent | |
Fields
|
Instances
Eq SetupIntent Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntent Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntent -> ShowS # show :: SetupIntent -> String # showList :: [SetupIntent] -> ShowS # | |
ToJSON SetupIntent Source # | |
Defined in StripeAPI.Types.SetupIntent Methods toJSON :: SetupIntent -> Value # toEncoding :: SetupIntent -> Encoding # toJSONList :: [SetupIntent] -> Value # toEncodingList :: [SetupIntent] -> Encoding # | |
FromJSON SetupIntent Source # | |
Defined in StripeAPI.Types.SetupIntent |
Arguments
:: Int | |
-> Text | |
-> Bool | |
-> [Text] | |
-> SetupIntentStatus' | |
-> Text | |
-> SetupIntent |
Create a new SetupIntent
with all required fields.
data SetupIntentApplication'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.application.anyOf
in the specification.
ID of the Connect application that created the SetupIntent.
Instances
Eq SetupIntentApplication'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentApplication'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentApplication'Variants -> ShowS # | |
ToJSON SetupIntentApplication'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentApplication'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentApplication'Variants # parseJSONList :: Value -> Parser [SetupIntentApplication'Variants] # |
data SetupIntentCancellationReason' Source #
Defines the enum schema located at components.schemas.setup_intent.properties.cancellation_reason
in the specification.
Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
Constructors
SetupIntentCancellationReason'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
SetupIntentCancellationReason'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SetupIntentCancellationReason'EnumAbandoned | Represents the JSON value |
SetupIntentCancellationReason'EnumDuplicate | Represents the JSON value |
SetupIntentCancellationReason'EnumRequestedByCustomer | Represents the JSON value |
Instances
Eq SetupIntentCancellationReason' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentCancellationReason' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentCancellationReason' -> ShowS # show :: SetupIntentCancellationReason' -> String # showList :: [SetupIntentCancellationReason'] -> ShowS # | |
ToJSON SetupIntentCancellationReason' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentCancellationReason' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentCancellationReason' # parseJSONList :: Value -> Parser [SetupIntentCancellationReason'] # |
data SetupIntentCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.customer.anyOf
in the specification.
ID of the Customer this SetupIntent belongs to, if one exists.
If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
Constructors
SetupIntentCustomer'Text Text | |
SetupIntentCustomer'Customer Customer | |
SetupIntentCustomer'DeletedCustomer DeletedCustomer |
Instances
data SetupIntentLastSetupError' Source #
Defines the object schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf
in the specification.
The error encountered in the previous SetupIntent confirmation.
Constructors
SetupIntentLastSetupError' | |
Fields
|
Instances
Eq SetupIntentLastSetupError' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods (==) :: SetupIntentLastSetupError' -> SetupIntentLastSetupError' -> Bool # (/=) :: SetupIntentLastSetupError' -> SetupIntentLastSetupError' -> Bool # | |
Show SetupIntentLastSetupError' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentLastSetupError' -> ShowS # show :: SetupIntentLastSetupError' -> String # showList :: [SetupIntentLastSetupError'] -> ShowS # | |
ToJSON SetupIntentLastSetupError' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods toJSON :: SetupIntentLastSetupError' -> Value # toEncoding :: SetupIntentLastSetupError' -> Encoding # toJSONList :: [SetupIntentLastSetupError'] -> Value # toEncodingList :: [SetupIntentLastSetupError'] -> Encoding # | |
FromJSON SetupIntentLastSetupError' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentLastSetupError' # parseJSONList :: Value -> Parser [SetupIntentLastSetupError'] # |
mkSetupIntentLastSetupError' :: SetupIntentLastSetupError' Source #
Create a new SetupIntentLastSetupError'
with all required fields.
data SetupIntentLastSetupError'Source' Source #
Defines the object schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf.properties.source.anyOf
in the specification.
The source object for errors returned on a request involving a source.
Constructors
SetupIntentLastSetupError'Source' | |
Fields
|
Instances
Eq SetupIntentLastSetupError'Source' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentLastSetupError'Source' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentLastSetupError'Source' -> ShowS # | |
ToJSON SetupIntentLastSetupError'Source' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentLastSetupError'Source' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentLastSetupError'Source' # parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'] # |
mkSetupIntentLastSetupError'Source' :: SetupIntentLastSetupError'Source' Source #
Create a new SetupIntentLastSetupError'Source'
with all required fields.
data SetupIntentLastSetupError'Source'Account'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf.properties.source.anyOf.properties.account.anyOf
in the specification.
The ID of the account that the bank account is associated with.
Constructors
SetupIntentLastSetupError'Source'Account'Text Text | |
SetupIntentLastSetupError'Source'Account'Account Account |
Instances
data SetupIntentLastSetupError'Source'AvailablePayoutMethods' Source #
Defines the enum schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf.properties.source.anyOf.properties.available_payout_methods.items
in the specification.
Constructors
SetupIntentLastSetupError'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. |
SetupIntentLastSetupError'Source'AvailablePayoutMethods'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SetupIntentLastSetupError'Source'AvailablePayoutMethods'EnumInstant | Represents the JSON value |
SetupIntentLastSetupError'Source'AvailablePayoutMethods'EnumStandard | Represents the JSON value |
Instances
data SetupIntentLastSetupError'Source'Customer'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf.properties.source.anyOf.properties.customer.anyOf
in the specification.
The ID of the customer that the bank account is associated with.
Constructors
SetupIntentLastSetupError'Source'Customer'Text Text | |
SetupIntentLastSetupError'Source'Customer'Customer Customer | |
SetupIntentLastSetupError'Source'Customer'DeletedCustomer DeletedCustomer |
Instances
data SetupIntentLastSetupError'Source'Owner' Source #
Defines the object schema located at components.schemas.setup_intent.properties.last_setup_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.
Constructors
SetupIntentLastSetupError'Source'Owner' | |
Fields
|
Instances
mkSetupIntentLastSetupError'Source'Owner' :: SetupIntentLastSetupError'Source'Owner' Source #
Create a new SetupIntentLastSetupError'Source'Owner'
with all required fields.
data SetupIntentLastSetupError'Source'Owner'Address' Source #
Defines the object schema located at components.schemas.setup_intent.properties.last_setup_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.address.anyOf
in the specification.
Owner\'s address.
Constructors
SetupIntentLastSetupError'Source'Owner'Address' | |
Fields
|
Instances
mkSetupIntentLastSetupError'Source'Owner'Address' :: SetupIntentLastSetupError'Source'Owner'Address' Source #
Create a new SetupIntentLastSetupError'Source'Owner'Address'
with all required fields.
data SetupIntentLastSetupError'Source'Owner'VerifiedAddress' Source #
Defines the object schema located at components.schemas.setup_intent.properties.last_setup_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.
Constructors
SetupIntentLastSetupError'Source'Owner'VerifiedAddress' | |
Fields
|
Instances
mkSetupIntentLastSetupError'Source'Owner'VerifiedAddress' :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' Source #
Create a new SetupIntentLastSetupError'Source'Owner'VerifiedAddress'
with all required fields.
data SetupIntentLastSetupError'Source'Recipient'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.last_setup_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.
Constructors
SetupIntentLastSetupError'Source'Recipient'Text Text | |
SetupIntentLastSetupError'Source'Recipient'Recipient Recipient |
Instances
data SetupIntentLastSetupError'Source'Type' Source #
Defines the enum schema located at components.schemas.setup_intent.properties.last_setup_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.
Constructors
Instances
data SetupIntentLastSetupError'Type' Source #
Defines the enum schema located at components.schemas.setup_intent.properties.last_setup_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`
Constructors
SetupIntentLastSetupError'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
SetupIntentLastSetupError'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SetupIntentLastSetupError'Type'EnumApiConnectionError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumApiError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumAuthenticationError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumCardError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumIdempotencyError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumInvalidRequestError | Represents the JSON value |
SetupIntentLastSetupError'Type'EnumRateLimitError | Represents the JSON value |
Instances
Eq SetupIntentLastSetupError'Type' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentLastSetupError'Type' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentLastSetupError'Type' -> ShowS # | |
ToJSON SetupIntentLastSetupError'Type' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentLastSetupError'Type' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentLastSetupError'Type' # parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Type'] # |
data SetupIntentLatestAttempt'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.latest_attempt.anyOf
in the specification.
The most recent SetupAttempt for this SetupIntent.
Instances
Eq SetupIntentLatestAttempt'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentLatestAttempt'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentLatestAttempt'Variants -> ShowS # | |
ToJSON SetupIntentLatestAttempt'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentLatestAttempt'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentLatestAttempt'Variants # parseJSONList :: Value -> Parser [SetupIntentLatestAttempt'Variants] # |
data SetupIntentMandate'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.mandate.anyOf
in the specification.
ID of the multi use Mandate generated by the SetupIntent.
Constructors
SetupIntentMandate'Text Text | |
SetupIntentMandate'Mandate Mandate |
Instances
data SetupIntentNextAction' Source #
Defines the object schema located at components.schemas.setup_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 continue payment setup.
Constructors
SetupIntentNextAction' | |
Fields
|
Instances
Eq SetupIntentNextAction' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods (==) :: SetupIntentNextAction' -> SetupIntentNextAction' -> Bool # (/=) :: SetupIntentNextAction' -> SetupIntentNextAction' -> Bool # | |
Show SetupIntentNextAction' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentNextAction' -> ShowS # show :: SetupIntentNextAction' -> String # showList :: [SetupIntentNextAction'] -> ShowS # | |
ToJSON SetupIntentNextAction' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods toJSON :: SetupIntentNextAction' -> Value # toEncoding :: SetupIntentNextAction' -> Encoding # toJSONList :: [SetupIntentNextAction'] -> Value # | |
FromJSON SetupIntentNextAction' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentNextAction' # parseJSONList :: Value -> Parser [SetupIntentNextAction'] # |
mkSetupIntentNextAction' :: SetupIntentNextAction' Source #
Create a new SetupIntentNextAction'
with all required fields.
data SetupIntentOnBehalfOf'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.on_behalf_of.anyOf
in the specification.
The account (if any) for which the setup is intended.
Instances
Eq SetupIntentOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentOnBehalfOf'Variants -> ShowS # show :: SetupIntentOnBehalfOf'Variants -> String # showList :: [SetupIntentOnBehalfOf'Variants] -> ShowS # | |
ToJSON SetupIntentOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentOnBehalfOf'Variants # parseJSONList :: Value -> Parser [SetupIntentOnBehalfOf'Variants] # |
data SetupIntentPaymentMethod'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.payment_method.anyOf
in the specification.
ID of the payment method used with this SetupIntent.
Instances
Eq SetupIntentPaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentPaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentPaymentMethod'Variants -> ShowS # | |
ToJSON SetupIntentPaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentPaymentMethod'Variants Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentPaymentMethod'Variants # parseJSONList :: Value -> Parser [SetupIntentPaymentMethod'Variants] # |
data SetupIntentPaymentMethodOptions' Source #
Defines the object schema located at components.schemas.setup_intent.properties.payment_method_options.anyOf
in the specification.
Payment-method-specific configuration for this SetupIntent.
Constructors
SetupIntentPaymentMethodOptions' | |
Instances
Eq SetupIntentPaymentMethodOptions' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
Show SetupIntentPaymentMethodOptions' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentPaymentMethodOptions' -> ShowS # | |
ToJSON SetupIntentPaymentMethodOptions' Source # | |
Defined in StripeAPI.Types.SetupIntent | |
FromJSON SetupIntentPaymentMethodOptions' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentPaymentMethodOptions' # parseJSONList :: Value -> Parser [SetupIntentPaymentMethodOptions'] # |
mkSetupIntentPaymentMethodOptions' :: SetupIntentPaymentMethodOptions' Source #
Create a new SetupIntentPaymentMethodOptions'
with all required fields.
data SetupIntentSingleUseMandate'Variants Source #
Defines the oneOf schema located at components.schemas.setup_intent.properties.single_use_mandate.anyOf
in the specification.
ID of the single_use Mandate generated by the SetupIntent.
Instances
data SetupIntentStatus' Source #
Defines the enum schema located at components.schemas.setup_intent.properties.status
in the specification.
Status of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
Constructors
SetupIntentStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
SetupIntentStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
SetupIntentStatus'EnumCanceled | Represents the JSON value |
SetupIntentStatus'EnumProcessing | Represents the JSON value |
SetupIntentStatus'EnumRequiresAction | Represents the JSON value |
SetupIntentStatus'EnumRequiresConfirmation | Represents the JSON value |
SetupIntentStatus'EnumRequiresPaymentMethod | Represents the JSON value |
SetupIntentStatus'EnumSucceeded | Represents the JSON value |
Instances
Eq SetupIntentStatus' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods (==) :: SetupIntentStatus' -> SetupIntentStatus' -> Bool # (/=) :: SetupIntentStatus' -> SetupIntentStatus' -> Bool # | |
Show SetupIntentStatus' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods showsPrec :: Int -> SetupIntentStatus' -> ShowS # show :: SetupIntentStatus' -> String # showList :: [SetupIntentStatus'] -> ShowS # | |
ToJSON SetupIntentStatus' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods toJSON :: SetupIntentStatus' -> Value # toEncoding :: SetupIntentStatus' -> Encoding # toJSONList :: [SetupIntentStatus'] -> Value # toEncodingList :: [SetupIntentStatus'] -> Encoding # | |
FromJSON SetupIntentStatus' Source # | |
Defined in StripeAPI.Types.SetupIntent Methods parseJSON :: Value -> Parser SetupIntentStatus' # parseJSONList :: Value -> Parser [SetupIntentStatus'] # |