StripeAPI.Types.SetupIntent

Contains the types generated from the schema SetupIntent

Documentation

data SetupIntent

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

• setupIntentApplication :: Maybe SetupIntentApplication'Variants

  application: ID of the Connect application that created the SetupIntent.

• setupIntentCancellationReason :: Maybe SetupIntentCancellationReason'

  cancellation_reason: Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.

• setupIntentClientSecret :: Maybe Text

  client_secret: The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

  The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

  Constraints:

  • Maximum length of 5000
• setupIntentCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• setupIntentCustomer :: Maybe SetupIntentCustomer'Variants

  customer: 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.

• setupIntentDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• setupIntentId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError :: Maybe SetupIntentLastSetupError'

  last_setup_error: The error encountered in the previous SetupIntent confirmation.

• setupIntentLatestAttempt :: Maybe SetupIntentLatestAttempt'Variants

  latest_attempt: The most recent SetupAttempt for this SetupIntent.

• setupIntentLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• setupIntentMandate :: Maybe SetupIntentMandate'Variants

  mandate: ID of the multi use Mandate generated by the SetupIntent.

• setupIntentMetadata :: Maybe Object

  metadata: 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.

• setupIntentNextAction :: Maybe SetupIntentNextAction'

  next_action: If present, this property tells you what actions you need to take in order for your customer to continue payment setup.

• setupIntentOnBehalfOf :: Maybe SetupIntentOnBehalfOf'Variants

  on_behalf_of: The account (if any) for which the setup is intended.

• setupIntentPaymentMethod :: Maybe SetupIntentPaymentMethod'Variants

  payment_method: ID of the payment method used with this SetupIntent.

• setupIntentPaymentMethodOptions :: Maybe SetupIntentPaymentMethodOptions'

  payment_method_options: Payment-method-specific configuration for this SetupIntent.

• setupIntentPaymentMethodTypes :: [Text]

  payment_method_types: The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

• setupIntentSingleUseMandate :: Maybe SetupIntentSingleUseMandate'Variants

  single_use_mandate: ID of the single_use Mandate generated by the SetupIntent.

• setupIntentStatus :: SetupIntentStatus'

  status: Status of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.

• setupIntentUsage :: Text

  usage: Indicates how the payment method is intended to be used in the future.

  Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.

  Constraints:

  • Maximum length of 5000

Instances

Eq SetupIntent

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntent -> SetupIntent -> Bool

(/=) :: SetupIntent -> SetupIntent -> Bool

Show SetupIntent

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntent -> ShowS

show :: SetupIntent -> String

showList :: [SetupIntent] -> ShowS

ToJSON SetupIntent

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntent -> Value

toEncoding :: SetupIntent -> Encoding

toJSONList :: [SetupIntent] -> Value

toEncodingList :: [SetupIntent] -> Encoding

FromJSON SetupIntent

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntent

parseJSONList :: Value -> Parser [SetupIntent]

mkSetupIntent

Arguments

:: Int

setupIntentCreated

-> Text

setupIntentId

-> Bool

setupIntentLivemode

-> [Text]

setupIntentPaymentMethodTypes

-> SetupIntentStatus'

setupIntentStatus

-> Text

setupIntentUsage

-> SetupIntent

Create a new SetupIntent with all required fields.

data SetupIntentApplication'Variants

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.

Constructors

SetupIntentApplication'Text Text

SetupIntentApplication'Application Application

Instances

Eq SetupIntentApplication'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentApplication'Variants -> SetupIntentApplication'Variants -> Bool

(/=) :: SetupIntentApplication'Variants -> SetupIntentApplication'Variants -> Bool

Show SetupIntentApplication'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentApplication'Variants -> ShowS

show :: SetupIntentApplication'Variants -> String

showList :: [SetupIntentApplication'Variants] -> ShowS

ToJSON SetupIntentApplication'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentApplication'Variants -> Value

toEncoding :: SetupIntentApplication'Variants -> Encoding

toJSONList :: [SetupIntentApplication'Variants] -> Value

toEncodingList :: [SetupIntentApplication'Variants] -> Encoding

FromJSON SetupIntentApplication'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentApplication'Variants

parseJSONList :: Value -> Parser [SetupIntentApplication'Variants]

data SetupIntentCancellationReason'

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 "abandoned"

SetupIntentCancellationReason'EnumDuplicate

Represents the JSON value "duplicate"

SetupIntentCancellationReason'EnumRequestedByCustomer

Represents the JSON value "requested_by_customer"

Instances

Eq SetupIntentCancellationReason'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentCancellationReason' -> SetupIntentCancellationReason' -> Bool

(/=) :: SetupIntentCancellationReason' -> SetupIntentCancellationReason' -> Bool

Show SetupIntentCancellationReason'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentCancellationReason' -> ShowS

show :: SetupIntentCancellationReason' -> String

showList :: [SetupIntentCancellationReason'] -> ShowS

ToJSON SetupIntentCancellationReason'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentCancellationReason' -> Value

toEncoding :: SetupIntentCancellationReason' -> Encoding

toJSONList :: [SetupIntentCancellationReason'] -> Value

toEncodingList :: [SetupIntentCancellationReason'] -> Encoding

FromJSON SetupIntentCancellationReason'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentCancellationReason'

parseJSONList :: Value -> Parser [SetupIntentCancellationReason']

data SetupIntentCustomer'Variants

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

Eq SetupIntentCustomer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentCustomer'Variants -> SetupIntentCustomer'Variants -> Bool

(/=) :: SetupIntentCustomer'Variants -> SetupIntentCustomer'Variants -> Bool

Show SetupIntentCustomer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentCustomer'Variants -> ShowS

show :: SetupIntentCustomer'Variants -> String

showList :: [SetupIntentCustomer'Variants] -> ShowS

ToJSON SetupIntentCustomer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentCustomer'Variants -> Value

toEncoding :: SetupIntentCustomer'Variants -> Encoding

toJSONList :: [SetupIntentCustomer'Variants] -> Value

toEncodingList :: [SetupIntentCustomer'Variants] -> Encoding

FromJSON SetupIntentCustomer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentCustomer'Variants

parseJSONList :: Value -> Parser [SetupIntentCustomer'Variants]

data SetupIntentLastSetupError'

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

• setupIntentLastSetupError'Charge :: Maybe Text

  charge: For card errors, the ID of the failed charge.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Code :: Maybe Text

  code: For some errors that could be handled programmatically, a short string indicating the error code reported.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'DeclineCode :: Maybe Text

  decline_code: For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'DocUrl :: Maybe Text

  doc_url: A URL to more information about the error code reported.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Message :: Maybe Text

  message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

  Constraints:

  • Maximum length of 40000
• setupIntentLastSetupError'Param :: Maybe Text

  param: If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'PaymentIntent :: Maybe PaymentIntent

  payment_intent: 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.

• setupIntentLastSetupError'PaymentMethod :: Maybe PaymentMethod

  payment_method: PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

  Related guides: Payment Methods and More Payment Scenarios.

• setupIntentLastSetupError'PaymentMethodType :: Maybe Text

  payment_method_type: If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'SetupIntent :: Maybe SetupIntent

  setup_intent: 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.

• setupIntentLastSetupError'Source :: Maybe SetupIntentLastSetupError'Source'

  source: The source object for errors returned on a request involving a source.

• setupIntentLastSetupError'Type :: Maybe SetupIntentLastSetupError'Type'

  type: 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`

Instances

Eq SetupIntentLastSetupError'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError' -> SetupIntentLastSetupError' -> Bool

(/=) :: SetupIntentLastSetupError' -> SetupIntentLastSetupError' -> Bool

Show SetupIntentLastSetupError'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError' -> ShowS

show :: SetupIntentLastSetupError' -> String

showList :: [SetupIntentLastSetupError'] -> ShowS

ToJSON SetupIntentLastSetupError'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError' -> Value

toEncoding :: SetupIntentLastSetupError' -> Encoding

toJSONList :: [SetupIntentLastSetupError'] -> Value

toEncodingList :: [SetupIntentLastSetupError'] -> Encoding

FromJSON SetupIntentLastSetupError'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError']

mkSetupIntentLastSetupError' :: SetupIntentLastSetupError'

Create a new SetupIntentLastSetupError' with all required fields.

data SetupIntentLastSetupError'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

• setupIntentLastSetupError'Source'Account :: Maybe SetupIntentLastSetupError'Source'Account'Variants

  account: The ID of the account that the bank account is associated with.

• setupIntentLastSetupError'Source'AccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AccountHolderType :: Maybe Text

  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• setupIntentLastSetupError'Source'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• setupIntentLastSetupError'Source'AcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• setupIntentLastSetupError'Source'AddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'AddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Alipay :: Maybe SourceTypeAlipay

  alipay

• setupIntentLastSetupError'Source'Amount :: Maybe Int

  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

• setupIntentLastSetupError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• setupIntentLastSetupError'Source'AvailablePayoutMethods :: Maybe [SetupIntentLastSetupError'Source'AvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• setupIntentLastSetupError'Source'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• setupIntentLastSetupError'Source'BankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Brand :: Maybe Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Card :: Maybe SourceTypeCard

  card

• setupIntentLastSetupError'Source'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• setupIntentLastSetupError'Source'ClientSecret :: Maybe Text

  client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• setupIntentLastSetupError'Source'Country :: Maybe Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Created :: Maybe Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• setupIntentLastSetupError'Source'Currency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• setupIntentLastSetupError'Source'Customer :: Maybe SetupIntentLastSetupError'Source'Customer'Variants

  customer: The ID of the customer that the bank account is associated with.

• setupIntentLastSetupError'Source'CvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'DefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• setupIntentLastSetupError'Source'DynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Eps :: Maybe SourceTypeEps

  eps

• setupIntentLastSetupError'Source'ExpMonth :: Maybe Int

  exp_month: Two-digit number representing the card's expiration month.

• setupIntentLastSetupError'Source'ExpYear :: Maybe Int

  exp_year: Four-digit number representing the card's expiration year.

• setupIntentLastSetupError'Source'Fingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Flow :: Maybe Text

  flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Funding :: Maybe Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Giropay :: Maybe SourceTypeGiropay

  giropay

• setupIntentLastSetupError'Source'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Ideal :: Maybe SourceTypeIdeal

  ideal

• setupIntentLastSetupError'Source'Klarna :: Maybe SourceTypeKlarna

  klarna

• setupIntentLastSetupError'Source'Last4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Livemode :: Maybe Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• setupIntentLastSetupError'Source'Metadata :: Maybe Object

  metadata: 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.

• setupIntentLastSetupError'Source'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• setupIntentLastSetupError'Source'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Object :: Maybe SetupIntentLastSetupError'Source'Object'

  object: String representing the object's type. Objects of the same type share the same value.

• setupIntentLastSetupError'Source'Owner :: Maybe SetupIntentLastSetupError'Source'Owner'

  owner: Information about the owner of the payment instrument that may be used or required by particular source types.

• setupIntentLastSetupError'Source'P24 :: Maybe SourceTypeP24

  p24

• setupIntentLastSetupError'Source'Receiver :: Maybe SourceReceiverFlow

  receiver:

• setupIntentLastSetupError'Source'Recipient :: Maybe SetupIntentLastSetupError'Source'Recipient'Variants

  recipient: 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.

• setupIntentLastSetupError'Source'Redirect :: Maybe SourceRedirectFlow

  redirect:

• setupIntentLastSetupError'Source'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'SepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• setupIntentLastSetupError'Source'Sofort :: Maybe SourceTypeSofort

  sofort

• setupIntentLastSetupError'Source'SourceOrder :: Maybe SourceOrder

  source_order:

• setupIntentLastSetupError'Source'StatementDescriptor :: Maybe Text

  statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Status :: Maybe Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• setupIntentLastSetupError'Source'TokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Type :: Maybe SetupIntentLastSetupError'Source'Type'

  type: 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.

• setupIntentLastSetupError'Source'Usage :: Maybe Text

  usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Wechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq SetupIntentLastSetupError'Source'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source' -> SetupIntentLastSetupError'Source' -> Bool

(/=) :: SetupIntentLastSetupError'Source' -> SetupIntentLastSetupError'Source' -> Bool

Show SetupIntentLastSetupError'Source'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source' -> ShowS

show :: SetupIntentLastSetupError'Source' -> String

showList :: [SetupIntentLastSetupError'Source'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source' -> Value

toEncoding :: SetupIntentLastSetupError'Source' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source']

mkSetupIntentLastSetupError'Source' :: SetupIntentLastSetupError'Source'

Create a new SetupIntentLastSetupError'Source' with all required fields.

data SetupIntentLastSetupError'Source'Account'Variants

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

Eq SetupIntentLastSetupError'Source'Account'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Account'Variants -> SetupIntentLastSetupError'Source'Account'Variants -> Bool

(/=) :: SetupIntentLastSetupError'Source'Account'Variants -> SetupIntentLastSetupError'Source'Account'Variants -> Bool

Show SetupIntentLastSetupError'Source'Account'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Account'Variants -> ShowS

show :: SetupIntentLastSetupError'Source'Account'Variants -> String

showList :: [SetupIntentLastSetupError'Source'Account'Variants] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Account'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Account'Variants -> Value

toEncoding :: SetupIntentLastSetupError'Source'Account'Variants -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Account'Variants] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Account'Variants] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Account'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Account'Variants

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Account'Variants]

data SetupIntentLastSetupError'Source'AvailablePayoutMethods'

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 "instant"

SetupIntentLastSetupError'Source'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq SetupIntentLastSetupError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> Bool

(/=) :: SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> Bool

Show SetupIntentLastSetupError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> ShowS

show :: SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> String

showList :: [SetupIntentLastSetupError'Source'AvailablePayoutMethods'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> Value

toEncoding :: SetupIntentLastSetupError'Source'AvailablePayoutMethods' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'AvailablePayoutMethods'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'AvailablePayoutMethods'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'AvailablePayoutMethods']

data SetupIntentLastSetupError'Source'Customer'Variants

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

Eq SetupIntentLastSetupError'Source'Customer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Customer'Variants -> SetupIntentLastSetupError'Source'Customer'Variants -> Bool

(/=) :: SetupIntentLastSetupError'Source'Customer'Variants -> SetupIntentLastSetupError'Source'Customer'Variants -> Bool

Show SetupIntentLastSetupError'Source'Customer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Customer'Variants -> ShowS

show :: SetupIntentLastSetupError'Source'Customer'Variants -> String

showList :: [SetupIntentLastSetupError'Source'Customer'Variants] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Customer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Customer'Variants -> Value

toEncoding :: SetupIntentLastSetupError'Source'Customer'Variants -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Customer'Variants] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Customer'Variants] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Customer'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Customer'Variants

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Customer'Variants]

data SetupIntentLastSetupError'Source'Object'

Defines the enum schema located at components.schemas.setup_intent.properties.last_setup_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.

Constructors

SetupIntentLastSetupError'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.

SetupIntentLastSetupError'Source'Object'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SetupIntentLastSetupError'Source'Object'EnumBankAccount

Represents the JSON value "bank_account"

Instances

Eq SetupIntentLastSetupError'Source'Object'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Object' -> SetupIntentLastSetupError'Source'Object' -> Bool

(/=) :: SetupIntentLastSetupError'Source'Object' -> SetupIntentLastSetupError'Source'Object' -> Bool

Show SetupIntentLastSetupError'Source'Object'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Object' -> ShowS

show :: SetupIntentLastSetupError'Source'Object' -> String

showList :: [SetupIntentLastSetupError'Source'Object'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Object'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Object' -> Value

toEncoding :: SetupIntentLastSetupError'Source'Object' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Object'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Object'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Object'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Object'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Object']

data SetupIntentLastSetupError'Source'Owner'

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

• setupIntentLastSetupError'Source'Owner'Address :: Maybe SetupIntentLastSetupError'Source'Owner'Address'

  address: Owner's address.

• setupIntentLastSetupError'Source'Owner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Phone :: Maybe Text

  phone: Owner's phone number (including extension).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress :: Maybe SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

  verified_address: 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.

• setupIntentLastSetupError'Source'Owner'VerifiedEmail :: Maybe Text

  verified_email: Verified owner's email 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.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedName :: Maybe Text

  verified_name: Verified owner's full name. 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.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedPhone :: Maybe Text

  verified_phone: Verified owner's phone number (including extension). 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.

  Constraints:

  • Maximum length of 5000

Instances

Eq SetupIntentLastSetupError'Source'Owner'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Owner' -> SetupIntentLastSetupError'Source'Owner' -> Bool

(/=) :: SetupIntentLastSetupError'Source'Owner' -> SetupIntentLastSetupError'Source'Owner' -> Bool

Show SetupIntentLastSetupError'Source'Owner'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Owner' -> ShowS

show :: SetupIntentLastSetupError'Source'Owner' -> String

showList :: [SetupIntentLastSetupError'Source'Owner'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Owner'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Owner' -> Value

toEncoding :: SetupIntentLastSetupError'Source'Owner' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Owner'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Owner'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Owner'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Owner'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Owner']

mkSetupIntentLastSetupError'Source'Owner' :: SetupIntentLastSetupError'Source'Owner'

Create a new SetupIntentLastSetupError'Source'Owner' with all required fields.

data SetupIntentLastSetupError'Source'Owner'Address'

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

• setupIntentLastSetupError'Source'Owner'Address'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Address'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Address'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Address'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq SetupIntentLastSetupError'Source'Owner'Address'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Owner'Address' -> SetupIntentLastSetupError'Source'Owner'Address' -> Bool

(/=) :: SetupIntentLastSetupError'Source'Owner'Address' -> SetupIntentLastSetupError'Source'Owner'Address' -> Bool

Show SetupIntentLastSetupError'Source'Owner'Address'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Owner'Address' -> ShowS

show :: SetupIntentLastSetupError'Source'Owner'Address' -> String

showList :: [SetupIntentLastSetupError'Source'Owner'Address'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Owner'Address'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Owner'Address' -> Value

toEncoding :: SetupIntentLastSetupError'Source'Owner'Address' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Owner'Address'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Owner'Address'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Owner'Address'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Owner'Address'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Owner'Address']

mkSetupIntentLastSetupError'Source'Owner'Address' :: SetupIntentLastSetupError'Source'Owner'Address'

Create a new SetupIntentLastSetupError'Source'Owner'Address' with all required fields.

data SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

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

• setupIntentLastSetupError'Source'Owner'VerifiedAddress'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• setupIntentLastSetupError'Source'Owner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> Bool

(/=) :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> Bool

Show SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> ShowS

show :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> String

showList :: [SetupIntentLastSetupError'Source'Owner'VerifiedAddress'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> Value

toEncoding :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Owner'VerifiedAddress'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Owner'VerifiedAddress'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Owner'VerifiedAddress']

mkSetupIntentLastSetupError'Source'Owner'VerifiedAddress' :: SetupIntentLastSetupError'Source'Owner'VerifiedAddress'

Create a new SetupIntentLastSetupError'Source'Owner'VerifiedAddress' with all required fields.

data SetupIntentLastSetupError'Source'Recipient'Variants

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

Eq SetupIntentLastSetupError'Source'Recipient'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Recipient'Variants -> SetupIntentLastSetupError'Source'Recipient'Variants -> Bool

(/=) :: SetupIntentLastSetupError'Source'Recipient'Variants -> SetupIntentLastSetupError'Source'Recipient'Variants -> Bool

Show SetupIntentLastSetupError'Source'Recipient'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Recipient'Variants -> ShowS

show :: SetupIntentLastSetupError'Source'Recipient'Variants -> String

showList :: [SetupIntentLastSetupError'Source'Recipient'Variants] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Recipient'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Recipient'Variants -> Value

toEncoding :: SetupIntentLastSetupError'Source'Recipient'Variants -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Recipient'Variants] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Recipient'Variants] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Recipient'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Recipient'Variants

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Recipient'Variants]

data SetupIntentLastSetupError'Source'Type'

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

SetupIntentLastSetupError'Source'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'Source'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

SetupIntentLastSetupError'Source'Type'EnumAchCreditTransfer

Represents the JSON value "ach_credit_transfer"

SetupIntentLastSetupError'Source'Type'EnumAchDebit

Represents the JSON value "ach_debit"

SetupIntentLastSetupError'Source'Type'EnumAcssDebit

Represents the JSON value "acss_debit"

SetupIntentLastSetupError'Source'Type'EnumAlipay

Represents the JSON value "alipay"

SetupIntentLastSetupError'Source'Type'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

SetupIntentLastSetupError'Source'Type'EnumBancontact

Represents the JSON value "bancontact"

SetupIntentLastSetupError'Source'Type'EnumCard

Represents the JSON value "card"

SetupIntentLastSetupError'Source'Type'EnumCardPresent

Represents the JSON value "card_present"

SetupIntentLastSetupError'Source'Type'EnumEps

Represents the JSON value "eps"

SetupIntentLastSetupError'Source'Type'EnumGiropay

Represents the JSON value "giropay"

SetupIntentLastSetupError'Source'Type'EnumIdeal

Represents the JSON value "ideal"

SetupIntentLastSetupError'Source'Type'EnumKlarna

Represents the JSON value "klarna"

SetupIntentLastSetupError'Source'Type'EnumMultibanco

Represents the JSON value "multibanco"

SetupIntentLastSetupError'Source'Type'EnumP24

Represents the JSON value "p24"

SetupIntentLastSetupError'Source'Type'EnumSepaDebit

Represents the JSON value "sepa_debit"

SetupIntentLastSetupError'Source'Type'EnumSofort

Represents the JSON value "sofort"

SetupIntentLastSetupError'Source'Type'EnumThreeDSecure

Represents the JSON value "three_d_secure"

SetupIntentLastSetupError'Source'Type'EnumWechat

Represents the JSON value "wechat"

Instances

Eq SetupIntentLastSetupError'Source'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Source'Type' -> SetupIntentLastSetupError'Source'Type' -> Bool

(/=) :: SetupIntentLastSetupError'Source'Type' -> SetupIntentLastSetupError'Source'Type' -> Bool

Show SetupIntentLastSetupError'Source'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Source'Type' -> ShowS

show :: SetupIntentLastSetupError'Source'Type' -> String

showList :: [SetupIntentLastSetupError'Source'Type'] -> ShowS

ToJSON SetupIntentLastSetupError'Source'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Source'Type' -> Value

toEncoding :: SetupIntentLastSetupError'Source'Type' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Source'Type'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Source'Type'] -> Encoding

FromJSON SetupIntentLastSetupError'Source'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Source'Type'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Source'Type']

data SetupIntentLastSetupError'Type'

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 "api_connection_error"

SetupIntentLastSetupError'Type'EnumApiError

Represents the JSON value "api_error"

SetupIntentLastSetupError'Type'EnumAuthenticationError

Represents the JSON value "authentication_error"

SetupIntentLastSetupError'Type'EnumCardError

Represents the JSON value "card_error"

SetupIntentLastSetupError'Type'EnumIdempotencyError

Represents the JSON value "idempotency_error"

SetupIntentLastSetupError'Type'EnumInvalidRequestError

Represents the JSON value "invalid_request_error"

SetupIntentLastSetupError'Type'EnumRateLimitError

Represents the JSON value "rate_limit_error"

Instances

Eq SetupIntentLastSetupError'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLastSetupError'Type' -> SetupIntentLastSetupError'Type' -> Bool

(/=) :: SetupIntentLastSetupError'Type' -> SetupIntentLastSetupError'Type' -> Bool

Show SetupIntentLastSetupError'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLastSetupError'Type' -> ShowS

show :: SetupIntentLastSetupError'Type' -> String

showList :: [SetupIntentLastSetupError'Type'] -> ShowS

ToJSON SetupIntentLastSetupError'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLastSetupError'Type' -> Value

toEncoding :: SetupIntentLastSetupError'Type' -> Encoding

toJSONList :: [SetupIntentLastSetupError'Type'] -> Value

toEncodingList :: [SetupIntentLastSetupError'Type'] -> Encoding

FromJSON SetupIntentLastSetupError'Type'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLastSetupError'Type'

parseJSONList :: Value -> Parser [SetupIntentLastSetupError'Type']

data SetupIntentLatestAttempt'Variants

Defines the oneOf schema located at components.schemas.setup_intent.properties.latest_attempt.anyOf in the specification.

The most recent SetupAttempt for this SetupIntent.

Constructors

SetupIntentLatestAttempt'Text Text

SetupIntentLatestAttempt'SetupAttempt SetupAttempt

Instances

Eq SetupIntentLatestAttempt'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentLatestAttempt'Variants -> SetupIntentLatestAttempt'Variants -> Bool

(/=) :: SetupIntentLatestAttempt'Variants -> SetupIntentLatestAttempt'Variants -> Bool

Show SetupIntentLatestAttempt'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentLatestAttempt'Variants -> ShowS

show :: SetupIntentLatestAttempt'Variants -> String

showList :: [SetupIntentLatestAttempt'Variants] -> ShowS

ToJSON SetupIntentLatestAttempt'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentLatestAttempt'Variants -> Value

toEncoding :: SetupIntentLatestAttempt'Variants -> Encoding

toJSONList :: [SetupIntentLatestAttempt'Variants] -> Value

toEncodingList :: [SetupIntentLatestAttempt'Variants] -> Encoding

FromJSON SetupIntentLatestAttempt'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentLatestAttempt'Variants

parseJSONList :: Value -> Parser [SetupIntentLatestAttempt'Variants]

data SetupIntentMandate'Variants

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

Eq SetupIntentMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentMandate'Variants -> SetupIntentMandate'Variants -> Bool

(/=) :: SetupIntentMandate'Variants -> SetupIntentMandate'Variants -> Bool

Show SetupIntentMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentMandate'Variants -> ShowS

show :: SetupIntentMandate'Variants -> String

showList :: [SetupIntentMandate'Variants] -> ShowS

ToJSON SetupIntentMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentMandate'Variants -> Value

toEncoding :: SetupIntentMandate'Variants -> Encoding

toJSONList :: [SetupIntentMandate'Variants] -> Value

toEncodingList :: [SetupIntentMandate'Variants] -> Encoding

FromJSON SetupIntentMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentMandate'Variants

parseJSONList :: Value -> Parser [SetupIntentMandate'Variants]

data SetupIntentNextAction'

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

• setupIntentNextAction'RedirectToUrl :: Maybe SetupIntentNextActionRedirectToUrl

  redirect_to_url:

• setupIntentNextAction'Type :: Maybe Text

  type: Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`.

  Constraints:

  • Maximum length of 5000
• setupIntentNextAction'UseStripeSdk :: Maybe Object

  use_stripe_sdk: When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.

• setupIntentNextAction'VerifyWithMicrodeposits :: Maybe SetupIntentNextActionVerifyWithMicrodeposits

  verify_with_microdeposits:

Instances

Eq SetupIntentNextAction'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentNextAction' -> SetupIntentNextAction' -> Bool

(/=) :: SetupIntentNextAction' -> SetupIntentNextAction' -> Bool

Show SetupIntentNextAction'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentNextAction' -> ShowS

show :: SetupIntentNextAction' -> String

showList :: [SetupIntentNextAction'] -> ShowS

ToJSON SetupIntentNextAction'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentNextAction' -> Value

toEncoding :: SetupIntentNextAction' -> Encoding

toJSONList :: [SetupIntentNextAction'] -> Value

toEncodingList :: [SetupIntentNextAction'] -> Encoding

FromJSON SetupIntentNextAction'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentNextAction'

parseJSONList :: Value -> Parser [SetupIntentNextAction']

mkSetupIntentNextAction' :: SetupIntentNextAction'

Create a new SetupIntentNextAction' with all required fields.

data SetupIntentOnBehalfOf'Variants

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.

Constructors

SetupIntentOnBehalfOf'Text Text

SetupIntentOnBehalfOf'Account Account

Instances

Eq SetupIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentOnBehalfOf'Variants -> SetupIntentOnBehalfOf'Variants -> Bool

(/=) :: SetupIntentOnBehalfOf'Variants -> SetupIntentOnBehalfOf'Variants -> Bool

Show SetupIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentOnBehalfOf'Variants -> ShowS

show :: SetupIntentOnBehalfOf'Variants -> String

showList :: [SetupIntentOnBehalfOf'Variants] -> ShowS

ToJSON SetupIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentOnBehalfOf'Variants -> Value

toEncoding :: SetupIntentOnBehalfOf'Variants -> Encoding

toJSONList :: [SetupIntentOnBehalfOf'Variants] -> Value

toEncodingList :: [SetupIntentOnBehalfOf'Variants] -> Encoding

FromJSON SetupIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentOnBehalfOf'Variants

parseJSONList :: Value -> Parser [SetupIntentOnBehalfOf'Variants]

data SetupIntentPaymentMethod'Variants

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.

Constructors

SetupIntentPaymentMethod'Text Text

SetupIntentPaymentMethod'PaymentMethod PaymentMethod

Instances

Eq SetupIntentPaymentMethod'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentPaymentMethod'Variants -> SetupIntentPaymentMethod'Variants -> Bool

(/=) :: SetupIntentPaymentMethod'Variants -> SetupIntentPaymentMethod'Variants -> Bool

Show SetupIntentPaymentMethod'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentPaymentMethod'Variants -> ShowS

show :: SetupIntentPaymentMethod'Variants -> String

showList :: [SetupIntentPaymentMethod'Variants] -> ShowS

ToJSON SetupIntentPaymentMethod'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentPaymentMethod'Variants -> Value

toEncoding :: SetupIntentPaymentMethod'Variants -> Encoding

toJSONList :: [SetupIntentPaymentMethod'Variants] -> Value

toEncodingList :: [SetupIntentPaymentMethod'Variants] -> Encoding

FromJSON SetupIntentPaymentMethod'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentPaymentMethod'Variants

parseJSONList :: Value -> Parser [SetupIntentPaymentMethod'Variants]

data SetupIntentPaymentMethodOptions'

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'

Fields

• setupIntentPaymentMethodOptions'AcssDebit :: Maybe SetupIntentPaymentMethodOptionsAcssDebit

  acss_debit:

• setupIntentPaymentMethodOptions'Card :: Maybe SetupIntentPaymentMethodOptionsCard

  card:

• setupIntentPaymentMethodOptions'SepaDebit :: Maybe SetupIntentPaymentMethodOptionsSepaDebit

  sepa_debit:

Instances

Eq SetupIntentPaymentMethodOptions'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentPaymentMethodOptions' -> SetupIntentPaymentMethodOptions' -> Bool

(/=) :: SetupIntentPaymentMethodOptions' -> SetupIntentPaymentMethodOptions' -> Bool

Show SetupIntentPaymentMethodOptions'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentPaymentMethodOptions' -> ShowS

show :: SetupIntentPaymentMethodOptions' -> String

showList :: [SetupIntentPaymentMethodOptions'] -> ShowS

ToJSON SetupIntentPaymentMethodOptions'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentPaymentMethodOptions' -> Value

toEncoding :: SetupIntentPaymentMethodOptions' -> Encoding

toJSONList :: [SetupIntentPaymentMethodOptions'] -> Value

toEncodingList :: [SetupIntentPaymentMethodOptions'] -> Encoding

FromJSON SetupIntentPaymentMethodOptions'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentPaymentMethodOptions'

parseJSONList :: Value -> Parser [SetupIntentPaymentMethodOptions']

mkSetupIntentPaymentMethodOptions' :: SetupIntentPaymentMethodOptions'

Create a new SetupIntentPaymentMethodOptions' with all required fields.

data SetupIntentSingleUseMandate'Variants

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.

Constructors

SetupIntentSingleUseMandate'Text Text

SetupIntentSingleUseMandate'Mandate Mandate

Instances

Eq SetupIntentSingleUseMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentSingleUseMandate'Variants -> SetupIntentSingleUseMandate'Variants -> Bool

(/=) :: SetupIntentSingleUseMandate'Variants -> SetupIntentSingleUseMandate'Variants -> Bool

Show SetupIntentSingleUseMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentSingleUseMandate'Variants -> ShowS

show :: SetupIntentSingleUseMandate'Variants -> String

showList :: [SetupIntentSingleUseMandate'Variants] -> ShowS

ToJSON SetupIntentSingleUseMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentSingleUseMandate'Variants -> Value

toEncoding :: SetupIntentSingleUseMandate'Variants -> Encoding

toJSONList :: [SetupIntentSingleUseMandate'Variants] -> Value

toEncodingList :: [SetupIntentSingleUseMandate'Variants] -> Encoding

FromJSON SetupIntentSingleUseMandate'Variants

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentSingleUseMandate'Variants

parseJSONList :: Value -> Parser [SetupIntentSingleUseMandate'Variants]

data SetupIntentStatus'

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 "canceled"

SetupIntentStatus'EnumProcessing

Represents the JSON value "processing"

SetupIntentStatus'EnumRequiresAction

Represents the JSON value "requires_action"

SetupIntentStatus'EnumRequiresConfirmation

Represents the JSON value "requires_confirmation"

SetupIntentStatus'EnumRequiresPaymentMethod

Represents the JSON value "requires_payment_method"

SetupIntentStatus'EnumSucceeded

Represents the JSON value "succeeded"

Instances

Eq SetupIntentStatus'

Defined in StripeAPI.Types.SetupIntent

Methods

(==) :: SetupIntentStatus' -> SetupIntentStatus' -> Bool

(/=) :: SetupIntentStatus' -> SetupIntentStatus' -> Bool

Show SetupIntentStatus'

Defined in StripeAPI.Types.SetupIntent

Methods

showsPrec :: Int -> SetupIntentStatus' -> ShowS

show :: SetupIntentStatus' -> String

showList :: [SetupIntentStatus'] -> ShowS

ToJSON SetupIntentStatus'

Defined in StripeAPI.Types.SetupIntent

Methods

toJSON :: SetupIntentStatus' -> Value

toEncoding :: SetupIntentStatus' -> Encoding

toJSONList :: [SetupIntentStatus'] -> Value

toEncodingList :: [SetupIntentStatus'] -> Encoding

FromJSON SetupIntentStatus'

Defined in StripeAPI.Types.SetupIntent

Methods

parseJSON :: Value -> Parser SetupIntentStatus'

parseJSONList :: Value -> Parser [SetupIntentStatus']