Documentation

Fields

• bankAccountAccount :: Maybe BankAccountAccount'Variants

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

• bankAccountAccountHolderName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• bankAccountAccountHolderType :: 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
• bankAccountAvailablePayoutMethods :: Maybe [BankAccountAvailablePayoutMethods']

  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.

• bankAccountBankName :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• bankAccountCountry :: Text

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

  Constraints:

  • Maximum length of 5000
• bankAccountCurrency :: Text

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

• bankAccountCustomer :: Maybe BankAccountCustomer'Variants

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

• bankAccountDefaultForCurrency :: Maybe Bool

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

• bankAccountFingerprint :: 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
• bankAccountId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• bankAccountLast4 :: Text

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

  Constraints:

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

• bankAccountRoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

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