Search documentation of tiger_stripe

# Stripe.Resources.BankAccount (tiger_stripe v0.1.1)

Copy Markdown View Source

BankAccount

These bank accounts are payment methods on `Customer` objects.

On the other hand External Accounts are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

Related guide: Bank debits and transfers

## Summary

### Types

t()

### Functions

expandable_fields()
object_name()

## Types

# t()

    @type t() :: %Stripe.Resources.BankAccount{
      account: String.t() | map() | nil,
      account_holder_name: String.t(),
      account_holder_type: String.t(),
      account_type: String.t(),
      available_payout_methods: [String.t()] | nil,
      bank_name: String.t(),
      country: String.t(),
      currency: String.t(),
      customer: map() | nil,
      default_for_currency: boolean() | nil,
      fingerprint: String.t(),
      future_requirements: map() | nil,
      id: String.t(),
      last4: String.t(),
      metadata: map() | nil,
      object: String.t(),
      requirements: map() | nil,
      routing_number: String.t(),
      status: String.t()
    }

- `account` - The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an External Account where controller.is_controller is `true`. Nullable. Expandable.
- `account_holder_name` - The name of the person or business that owns the bank account. Max length: 5000. Nullable.
- `account_holder_type` - The type of entity that holds the account. This can be either `individual` or `company`. Max length: 5000. Nullable.
- `account_type` - The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. Max length: 5000. Nullable.
- `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. Nullable.
- `bank_name` - Name of the bank associated with the routing number (e.g., `WELLS FARGO`). Max length: 5000. Nullable.
- `country` - Two-letter ISO code representing the country the bank account is located in. Max length: 5000.
- `currency` - Three-letter ISO code for the currency paid out to the bank account. Format: ISO 4217 currency code.
- `customer` - The ID of the customer that the bank account is associated with. Nullable. Expandable.
- `default_for_currency` - Whether this bank account is the default external account for its currency. Nullable.
- `fingerprint` - Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Max length: 5000. Nullable.
- `future_requirements` - Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when. Nullable. Expandable.
- `id` - Unique identifier for the object. Max length: 5000.
- `last4` - The last four digits of the bank account number. Max length: 5000.
- `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. Nullable.
- `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `bank_account`.
- `requirements` - Information about the requirements for the bank account, including what information needs to be collected. Nullable. Expandable.
- `routing_number` - The routing transit number for the bank account. Max length: 5000. Nullable.
- `status` - For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` 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 the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send scheduled payouts until the bank details are updated.

For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't verify the owner of the bank account, we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. Max length: 5000.

## Functions

# expandable_fields()

# object_name()