Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Account

Fetch an Account

get/account/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Response

The account

account_numberstring

Bank account number. Filterable.

account_product_idstring

Account Product used to create the account

account_typestring

One of checking or savings

additional_account_numbersstring[]

Invoice account numbers associated with the account

available_balancestring

Available funds in this account. If not available, the value will be null

bank_idstring

ID of the bank with which the account is associated

business_idsstring[]

Array of IDs of Business objects representing all businesses that own this account. Always empty for personal accounts

closed_datestring

Timestamp of the account closure, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC

currencystring

Three-letter ISO currency code in lowercase, indicating the currency denominating the account. Currently only USD is supported

current_balancestring

Last known account balance, with two-decimal precision. Note that some accounts may not support this field; if not available, the value will be null

fundedboolean

true if the account has ever been funded with an amount greater than $0, false otherwise

idstring

Unique identifier for object

interest_ratestring

Account interest rate

lockedboolean

true if the account is in a locked state, false otherwise

namestring

Name of the person or company that owns the bank account

nicknamestring

Nickname of the account

org_idstring

ID of the organization with which the account is associated. Filterable.

person_idsstring[]

Array of IDs of Person objects representing all people who own this account

primary_person_idstring

ID of the Person indicating the primary account holder

routing_numberstring

ABA routing transit number associated with the account

statusstring

The status of the account. One of open, closed, or close_pending

tagsstring[]

Array of tags associated with this account. Filterable.

userdataobject

Arbitrary user data that can be attached to the object