accountsGet

POST {{baseUrl}}/accounts/get

The /accounts/get endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.

This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use /accounts/balance/get instead.

Request Body

{"access_token"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "options"=>{"account_ids"=>["<string>", "<string>"]}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;accounts&quot;:[{&quot;account_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;balances&quot;:{&quot;available&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;current&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;limit&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;iso_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;unofficial_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;last_updated_datetime&quot;:&quot;\u003cstring,null\u003e&quot;},&quot;mask&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;official_name&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;subtype&quot;:&quot;\u003cstring,number\u003e&quot;,&quot;verification_status&quot;:&quot;\u003cstring\u003e&quot;},{&quot;account_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;balances&quot;:{&quot;available&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;current&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;limit&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;iso_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;unofficial_currency_code&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;last_updated_datetime&quot;:&quot;\u003cstring,null\u003e&quot;},&quot;mask&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;official_name&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;subtype&quot;:&quot;\u003cstring,number\u003e&quot;,&quot;verification_status&quot;:&quot;\u003cstring\u003e&quot;}],&quot;item&quot;:{&quot;item_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;webhook&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;error&quot;:{&quot;error_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;error_code&quot;:&quot;\u003cstring\u003e&quot;,&quot;error_message&quot;:&quot;\u003cstring\u003e&quot;,&quot;display_message&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;causes&quot;:[&quot;\u003cobject\u003e&quot;,&quot;\u003cobject\u003e&quot;],&quot;status&quot;:&quot;\u003cnumber,null\u003e&quot;,&quot;documentation_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;suggested_action&quot;:&quot;\u003cstring\u003e&quot;},&quot;available_products&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;billed_products&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;consent_expiration_time&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;update_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;institution_id&quot;:&quot;\u003cstring,null\u003e&quot;,&quot;products&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;request_id&quot;:&quot;\u003cstring\u003e&quot;}