StripeAPI.Types.ExternalAccount

Contains the types generated from the schema ExternalAccount

Documentation

data ExternalAccount

Defines the object schema located at components.schemas.external_account.anyOf in the specification.

Constructors

ExternalAccount

Fields

• externalAccountAccount :: Maybe ExternalAccountAccount'Variants

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

• externalAccountAccountHolderName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAccountHolderType :: 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
• externalAccountAddressCity :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAddressCountry :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAddressLine1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAddressLine1Check :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAddressLine2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• externalAccountAddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• externalAccountAddressZipCheck :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountAvailablePayoutMethods :: Maybe [ExternalAccountAvailablePayoutMethods']

  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.

• externalAccountBankName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountBrand :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountCountry :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountCurrency :: Maybe Text

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

• externalAccountCustomer :: Maybe ExternalAccountCustomer'Variants

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

• externalAccountCvcCheck :: 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
• externalAccountDefaultForCurrency :: Maybe Bool

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

• externalAccountDynamicLast4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountExpMonth :: Maybe Int

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

• externalAccountExpYear :: Maybe Int

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

• externalAccountFingerprint :: 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
• externalAccountFunding :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountId :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• externalAccountLast4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• externalAccountMetadata :: 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.

• externalAccountName :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• externalAccountObject :: Maybe ExternalAccountObject'

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

• externalAccountRecipient :: Maybe ExternalAccountRecipient'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.

• externalAccountRoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• externalAccountStatus :: 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
• externalAccountTokenizationMethod :: 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

Instances

Eq ExternalAccount

Defined in StripeAPI.Types.ExternalAccount

Methods

(==) :: ExternalAccount -> ExternalAccount -> Bool

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

Show ExternalAccount

Defined in StripeAPI.Types.ExternalAccount

Methods

showsPrec :: Int -> ExternalAccount -> ShowS

show :: ExternalAccount -> String

showList :: [ExternalAccount] -> ShowS

ToJSON ExternalAccount

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccount -> Value

toEncoding :: ExternalAccount -> Encoding

toJSONList :: [ExternalAccount] -> Value

toEncodingList :: [ExternalAccount] -> Encoding

FromJSON ExternalAccount

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccount

parseJSONList :: Value -> Parser [ExternalAccount]

mkExternalAccount :: ExternalAccount

Create a new ExternalAccount with all required fields.

data ExternalAccountAccount'Variants

Defines the oneOf schema located at components.schemas.external_account.anyOf.properties.account.anyOf in the specification.

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

Constructors

ExternalAccountAccount'Text Text

ExternalAccountAccount'Account Account

Instances

Eq ExternalAccountAccount'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

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

Show ExternalAccountAccount'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

show :: ExternalAccountAccount'Variants -> String

showList :: [ExternalAccountAccount'Variants] -> ShowS

ToJSON ExternalAccountAccount'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccountAccount'Variants -> Value

toEncoding :: ExternalAccountAccount'Variants -> Encoding

toJSONList :: [ExternalAccountAccount'Variants] -> Value

toEncodingList :: [ExternalAccountAccount'Variants] -> Encoding

FromJSON ExternalAccountAccount'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccountAccount'Variants

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

data ExternalAccountAvailablePayoutMethods'

Defines the enum schema located at components.schemas.external_account.anyOf.properties.available_payout_methods.items in the specification.

Constructors

ExternalAccountAvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

ExternalAccountAvailablePayoutMethods'Typed Text

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

ExternalAccountAvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

ExternalAccountAvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq ExternalAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.ExternalAccount

Methods

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

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

Show ExternalAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.ExternalAccount

Methods

showsPrec :: Int -> ExternalAccountAvailablePayoutMethods' -> ShowS

show :: ExternalAccountAvailablePayoutMethods' -> String

showList :: [ExternalAccountAvailablePayoutMethods'] -> ShowS

ToJSON ExternalAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccountAvailablePayoutMethods' -> Value

toEncoding :: ExternalAccountAvailablePayoutMethods' -> Encoding

toJSONList :: [ExternalAccountAvailablePayoutMethods'] -> Value

toEncodingList :: [ExternalAccountAvailablePayoutMethods'] -> Encoding

FromJSON ExternalAccountAvailablePayoutMethods'

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccountAvailablePayoutMethods'

parseJSONList :: Value -> Parser [ExternalAccountAvailablePayoutMethods']

data ExternalAccountCustomer'Variants

Defines the oneOf schema located at components.schemas.external_account.anyOf.properties.customer.anyOf in the specification.

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

Constructors

ExternalAccountCustomer'Text Text

ExternalAccountCustomer'Customer Customer

ExternalAccountCustomer'DeletedCustomer DeletedCustomer

Instances

Eq ExternalAccountCustomer'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

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

Show ExternalAccountCustomer'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

show :: ExternalAccountCustomer'Variants -> String

showList :: [ExternalAccountCustomer'Variants] -> ShowS

ToJSON ExternalAccountCustomer'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccountCustomer'Variants -> Value

toEncoding :: ExternalAccountCustomer'Variants -> Encoding

toJSONList :: [ExternalAccountCustomer'Variants] -> Value

toEncodingList :: [ExternalAccountCustomer'Variants] -> Encoding

FromJSON ExternalAccountCustomer'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccountCustomer'Variants

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

data ExternalAccountObject'

Defines the enum schema located at components.schemas.external_account.anyOf.properties.object in the specification.

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

Constructors

ExternalAccountObject'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

ExternalAccountObject'Typed Text

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

ExternalAccountObject'EnumBankAccount

Represents the JSON value "bank_account"

Instances

Eq ExternalAccountObject'

Defined in StripeAPI.Types.ExternalAccount

Methods

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

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

Show ExternalAccountObject'

Defined in StripeAPI.Types.ExternalAccount

Methods

showsPrec :: Int -> ExternalAccountObject' -> ShowS

show :: ExternalAccountObject' -> String

showList :: [ExternalAccountObject'] -> ShowS

ToJSON ExternalAccountObject'

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccountObject' -> Value

toEncoding :: ExternalAccountObject' -> Encoding

toJSONList :: [ExternalAccountObject'] -> Value

toEncodingList :: [ExternalAccountObject'] -> Encoding

FromJSON ExternalAccountObject'

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccountObject'

parseJSONList :: Value -> Parser [ExternalAccountObject']

data ExternalAccountRecipient'Variants

Defines the oneOf schema located at components.schemas.external_account.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

ExternalAccountRecipient'Text Text

ExternalAccountRecipient'Recipient Recipient

Instances

Eq ExternalAccountRecipient'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

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

Show ExternalAccountRecipient'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

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

show :: ExternalAccountRecipient'Variants -> String

showList :: [ExternalAccountRecipient'Variants] -> ShowS

ToJSON ExternalAccountRecipient'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

toJSON :: ExternalAccountRecipient'Variants -> Value

toEncoding :: ExternalAccountRecipient'Variants -> Encoding

toJSONList :: [ExternalAccountRecipient'Variants] -> Value

toEncodingList :: [ExternalAccountRecipient'Variants] -> Encoding

FromJSON ExternalAccountRecipient'Variants

Defined in StripeAPI.Types.ExternalAccount

Methods

parseJSON :: Value -> Parser ExternalAccountRecipient'Variants

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