Struct BankAccount

pub struct BankAccount {

    pub account: Option<Expandable<Account>>,
    pub account_holder_name: Option<String>,
    pub account_holder_type: Option<String>,
    pub account_type: Option<String>,
    pub available_payout_methods: Option<Vec<BankAccountAvailablePayoutMethods>>,
    pub bank_name: Option<String>,
    pub country: String,
    pub currency: Currency,
    pub customer: Option<Expandable<Customer>>,
    pub default_for_currency: Option<bool>,
    pub fingerprint: Option<String>,
    pub future_requirements: Option<ExternalAccountRequirements>,
    pub id: BankAccountId,
    pub last4: String,
    pub metadata: Option<HashMap<String, String>>,
    pub requirements: Option<ExternalAccountRequirements>,
    pub routing_number: Option<String>,
    pub status: String,
}

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

Fields

account: Option<Expandable<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.

account_holder_name: Option<String>

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

account_holder_type: Option<String>

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

account_type: Option<String>

The bank account type. This can only be checking or savings in most countries. In Japan, this can only be futsu or toza.

available_payout_methods: Option<Vec<BankAccountAvailablePayoutMethods>>

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.

bank_name: Option<String>

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

country: String

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

currency: Currency

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

customer: Option<Expandable<Customer>>

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

default_for_currency: Option<bool>

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

fingerprint: Option<String>

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

future_requirements: Option<ExternalAccountRequirements>

Information about the upcoming new requirements for the bank account, including what information needs to be collected, and by when.

id: BankAccountId

Unique identifier for the object.

last4: String

The last four digits of the bank account number.

metadata: Option<HashMap<String, String>>

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.

requirements: Option<ExternalAccountRequirements>

Information about the requirements for the bank account, including what information needs to be collected.

routing_number: Option<String>

The routing transit number for the bank account.

status: String

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 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 and verification_failed. 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.

Trait Implementations

impl Clone for BankAccount

fn clone(&self) -> BankAccount

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BankAccount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deserialize for BankAccount

fn begin(out: &mut Option<Self>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl FromValueOpt for BankAccount

fn from_value(v: Value) -> Option<Self>

impl Object for BankAccount

type Id = BankAccountId

The canonical id type for this object.

fn id(&self) -> &Self::Id

The id of the object.

fn into_id(self) -> Self::Id

The owned id of the object.

impl ObjectDeser for BankAccount

type Builder = BankAccountBuilder