Documentation

Fields

• accountBusinessProfile :: Maybe AccountBusinessProfile'

  business_profile: Business information about the account.

• accountBusinessType :: Maybe AccountBusinessType'

  business_type: The business type.

• accountCapabilities :: Maybe AccountCapabilities

  capabilities:

• accountChargesEnabled :: Maybe Bool

  charges_enabled: Whether the account can create live charges.

• accountCompany :: Maybe LegalEntityCompany

  company:

• accountController :: Maybe AccountController

  controller:

• accountCountry :: Maybe Text

  country: The account's country.

  Constraints:

  • Maximum length of 5000
• accountCreated :: Maybe Int

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

• accountDefaultCurrency :: Maybe Text

  default_currency: Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.

  Constraints:

  • Maximum length of 5000
• accountDetailsSubmitted :: Maybe Bool

  details_submitted: Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

• accountEmail :: Maybe Text

  email: An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts :: Maybe AccountExternalAccounts'

  external_accounts: External accounts (bank accounts and debit cards) currently attached to this account

• accountId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• accountIndividual :: Maybe Person

  individual: This is an object representing a person associated with a Stripe account.

  A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the Standard onboarding or Express onboarding documentation for information about platform pre-filling and account onboarding steps.

  Related guide: Handling Identity Verification with the API.

• accountMetadata :: 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.

• accountPayoutsEnabled :: Maybe Bool

  payouts_enabled: Whether Stripe can send payouts to this account.

• accountRequirements :: Maybe AccountRequirements

  requirements:

• accountSettings :: Maybe AccountSettings'

  settings: Options for customizing how the account functions within Stripe.

• accountTosAcceptance :: Maybe AccountTosAcceptance

  tos_acceptance:

• accountType :: Maybe AccountType'

  type: The Stripe account type. Can be `standard`, `express`, or `custom`.

Fields

• accountBusinessProfile'Mcc :: Maybe Text

  mcc: The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'Name :: Maybe Text

  name: The customer-facing business name.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'ProductDescription :: Maybe Text

  product_description: Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.

  Constraints:

  • Maximum length of 40000
• accountBusinessProfile'SupportAddress :: Maybe AccountBusinessProfile'SupportAddress'

  support_address: A publicly available mailing address for sending support issues to.

• accountBusinessProfile'SupportEmail :: Maybe Text

  support_email: A publicly available email address for sending support issues to.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportPhone :: Maybe Text

  support_phone: A publicly available phone number to call with support issues.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportUrl :: Maybe Text

  support_url: A publicly available website for handling support issues.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'Url :: Maybe Text

  url: The business's publicly available website.

  Constraints:

  • Maximum length of 5000

Fields

• accountBusinessProfile'SupportAddress'City :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportAddress'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
• accountBusinessProfile'SupportAddress'Line1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportAddress'Line2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• accountBusinessProfile'SupportAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Fields

• accountExternalAccounts'Data :: [AccountExternalAccounts'Data']

  data: The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.

• accountExternalAccounts'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• accountExternalAccounts'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Fields

• accountExternalAccounts'Data'Account :: Maybe AccountExternalAccounts'Data'Account'Variants

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

• accountExternalAccounts'Data'AccountHolderName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'AddressCity :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'AddressCountry :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'AddressLine1 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'AddressLine2 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'AvailablePayoutMethods :: Maybe [AccountExternalAccounts'Data'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.

• accountExternalAccounts'Data'BankName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Brand :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Country :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Currency :: Maybe Text

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

• accountExternalAccounts'Data'Customer :: Maybe AccountExternalAccounts'Data'Customer'Variants

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

• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'DefaultForCurrency :: Maybe Bool

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

• accountExternalAccounts'Data'DynamicLast4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'ExpMonth :: Maybe Int

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

• accountExternalAccounts'Data'ExpYear :: Maybe Int

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

• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'Funding :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Last4 :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'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.

• accountExternalAccounts'Data'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'Object :: Maybe AccountExternalAccounts'Data'Object'

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

• accountExternalAccounts'Data'Recipient :: Maybe AccountExternalAccounts'Data'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.

• accountExternalAccounts'Data'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• accountExternalAccounts'Data'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
• accountExternalAccounts'Data'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

Fields

• accountSettings'BacsDebitPayments :: Maybe AccountBacsDebitPaymentsSettings

  bacs_debit_payments:

• accountSettings'Branding :: Maybe AccountBrandingSettings

  branding:

• accountSettings'CardIssuing :: Maybe AccountCardIssuingSettings

  card_issuing:

• accountSettings'CardPayments :: Maybe AccountCardPaymentsSettings

  card_payments:

• accountSettings'Dashboard :: Maybe AccountDashboardSettings

  dashboard:

• accountSettings'Payments :: Maybe AccountPaymentsSettings

  payments:

• accountSettings'Payouts :: Maybe AccountPayoutSettings

  payouts:

• accountSettings'SepaDebitPayments :: Maybe AccountSepaDebitPaymentsSettings

  sepa_debit_payments: