Toolcog home
Search ⌘ + K

Command Palette

Search for a command to run...

Sign In

Retrieve an external account

GET /v1/accounts/{account}/bank_accounts/{id}
Copy endpoint
https://api.stripe.com/

Parameters

path Path Parameters

Name Type
account required
string
id required

Unique identifier for the external account to be retrieved.
string

query Query Parameters

Name Type
expand

Specifies which fields in the response should be expanded.
string[]

Request Body

application/x-www-form-urlencoded
{}

Responses

200 application/json

Successful response.

type ExternalAccount = interface BankAccount {
account?: Account

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned.

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

interface Account {
business_profile?: AccountBusinessProfile | null;
business_type?: "company" | "government_entity" | "individual" | "non_profit" | null;
capabilities?: AccountCapabilities;
charges_enabled?: boolean;
company?: LegalEntityCompany;
controller?: AccountUnificationAccountController;
country?: string;
created?: number;
default_currency?: string;
details_submitted?: boolean;
email?: string | null;
external_accounts?: {
data: (BankAccount | Card)[];
has_more: boolean;
object: "list";
url: string;
};
future_requirements?: AccountFutureRequirements;
groups?: AccountGroupMembership | null;
id: string;
individual?: Person;
metadata?: { };
object: "account";
payouts_enabled?: boolean;
requirements?: AccountRequirements;
settings?: AccountSettings | null;
tos_acceptance?: AccountTosAcceptance;
type?: "custom" | "express" | "none" | "standard";
}
| string | null;
account_holder_name?: string | null;
account_holder_type?: string | null;
account_type?: string | null;
available_payout_methods?: ("instant" | "standard")[] | null;
bank_name?: string | null;
country: string;
currency: string;
customer?: Customer

This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

interface Customer {
address?: Address | null;
balance?: number;
business_name?: string;
cash_balance?: CashBalance | null;
created: number;
currency?: string | null;
customer_account?: string | null;
default_source?: BankAccount | Card | Source | string | null;
delinquent?: boolean | null;
description?: string | null;
discount?: Discount | null;
email?: string | null;
id: string;
individual_name?: string;
invoice_credit_balance?: { };
invoice_prefix?: string | null;
invoice_settings?: InvoiceSettingCustomerSetting;
livemode: boolean;
metadata?: { };
name?: string | null;
next_invoice_sequence?: number;
object: "customer";
phone?: string | null;
preferred_locales?: string[] | null;
shipping?: Shipping | null;
sources?: {
data: (BankAccount | Card | Source)[];
has_more: boolean;
object: "list";
url: string;
};
subscriptions?: {
data: Subscription[];
has_more: boolean;
object: "list";
url: string;
};
tax?: CustomerTax;
tax_exempt?: "exempt" | "none" | "reverse" | null;
tax_ids?: {
data: TaxId[];
has_more: boolean;
object: "list";
url: string;
};
test_clock?: TestHelpersTestClock | string | null;
}
| DeletedCustomer
interface DeletedCustomer {
deleted: true;
id: string;
object: "customer";
}
| string | null;
default_for_currency?: boolean | null;
fingerprint?: string | null;
future_requirements?: ExternalAccountRequirements
interface ExternalAccountRequirements {
currently_due?: string[] | null;
errors?: AccountRequirementsError[] | null;
past_due?: string[] | null;
pending_verification?: string[] | null;
}
| null;
id: string;
last4: string;
metadata?: { } | null;
object: "bank_account";
requirements?: ExternalAccountRequirements
interface ExternalAccountRequirements {
currently_due?: string[] | null;
errors?: AccountRequirementsError[] | null;
past_due?: string[] | null;
pending_verification?: string[] | null;
}
| null;
routing_number?: string | null;
status: string;
} | interface Card {
account?: Account

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned.

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

interface Account {
business_profile?: AccountBusinessProfile | null;
business_type?: "company" | "government_entity" | "individual" | "non_profit" | null;
capabilities?: AccountCapabilities;
charges_enabled?: boolean;
company?: LegalEntityCompany;
controller?: AccountUnificationAccountController;
country?: string;
created?: number;
default_currency?: string;
details_submitted?: boolean;
email?: string | null;
external_accounts?: {
data: (BankAccount | Card)[];
has_more: boolean;
object: "list";
url: string;
};
future_requirements?: AccountFutureRequirements;
groups?: AccountGroupMembership | null;
id: string;
individual?: Person;
metadata?: { };
object: "account";
payouts_enabled?: boolean;
requirements?: AccountRequirements;
settings?: AccountSettings | null;
tos_acceptance?: AccountTosAcceptance;
type?: "custom" | "express" | "none" | "standard";
}
| string | null;
address_city?: string | null;
address_country?: string | null;
address_line1?: string | null;
address_line1_check?: string | null;
address_line2?: string | null;
address_state?: string | null;
address_zip?: string | null;
address_zip_check?: string | null;
allow_redisplay?: "always" | "limited" | "unspecified" | null;
available_payout_methods?: ("instant" | "standard")[] | null;
brand: string;
country?: string | null;
currency?: string | null;
customer?: Customer

This object represents a customer of your business. Use it to create recurring charges, save payment and contact information, and track payments that belong to the same customer.

interface Customer {
address?: Address | null;
balance?: number;
business_name?: string;
cash_balance?: CashBalance | null;
created: number;
currency?: string | null;
customer_account?: string | null;
default_source?: BankAccount | Card | Source | string | null;
delinquent?: boolean | null;
description?: string | null;
discount?: Discount | null;
email?: string | null;
id: string;
individual_name?: string;
invoice_credit_balance?: { };
invoice_prefix?: string | null;
invoice_settings?: InvoiceSettingCustomerSetting;
livemode: boolean;
metadata?: { };
name?: string | null;
next_invoice_sequence?: number;
object: "customer";
phone?: string | null;
preferred_locales?: string[] | null;
shipping?: Shipping | null;
sources?: {
data: (BankAccount | Card | Source)[];
has_more: boolean;
object: "list";
url: string;
};
subscriptions?: {
data: Subscription[];
has_more: boolean;
object: "list";
url: string;
};
tax?: CustomerTax;
tax_exempt?: "exempt" | "none" | "reverse" | null;
tax_ids?: {
data: TaxId[];
has_more: boolean;
object: "list";
url: string;
};
test_clock?: TestHelpersTestClock | string | null;
}
| DeletedCustomer
interface DeletedCustomer {
deleted: true;
id: string;
object: "customer";
}
| string | null;
cvc_check?: string | null;
default_for_currency?: boolean | null;
dynamic_last4?: string | null;
exp_month: number;
exp_year: number;
fingerprint?: string | null;
funding: string;
id: string;
iin?: string;
last4: string;
metadata?: { } | null;
name?: string | null;
networks?: TokenCardNetworks
interface TokenCardNetworks {
preferred?: string | null;
}
;
object: "card";
regulated_status?: "regulated" | "unregulated" | null;
status?: string | null;
tokenization_method?: string | null;
}
default application/json

Error response.

interface Error {
error: ApiErrors
interface ApiErrors {
advice_code?: string;
charge?: string;
code?: string;
decline_code?: string;
doc_url?: string;
message?: string;
network_advice_code?: string;
network_decline_code?: string;
param?: string;
payment_intent?: PaymentIntent;
payment_method?: PaymentMethod;
payment_method_type?: string;
request_log_url?: string;
setup_intent?: SetupIntent;
source?: BankAccount | Card | Source;
type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error";
}
;
}