UNPKG

2.38 kBTypeScriptView Raw
1/**
2 * The BankAccount object.
3 */
4export interface BankAccount {
5 /**
6 * Unique identifier for the object.
7 */
8 id: string;
9
10 /**
11 * String representing the object's type. Objects of the same type share the same value.
12 */
13 object: 'bank_account';
14
15 /**
16 * The name of the person or business that owns the bank account.
17 */
18 account_holder_name: string | null;
19
20 /**
21 * The type of entity that holds the account. This can be either `individual` or `company`.
22 */
23 account_holder_type: string | null;
24
25 /**
26 * Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
27 */
28 bank_name: string | null;
29
30 /**
31 * Two-letter ISO code representing the country the bank account is located in.
32 */
33 country: string;
34
35 /**
36 * Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
37 */
38 currency: string;
39
40 /**
41 * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
42 */
43 fingerprint: string | null;
44
45 /**
46 * The last four digits of the bank account number.
47 */
48 last4: string;
49
50 /**
51 * The routing transit number for the bank account.
52 */
53 routing_number: string | null;
54
55 /**
56 * 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.
57 *
58 * 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.
59 */
60 status: string;
61}