accountsBalanceGet
POST {{baseUrl}}/accounts/balance/get
The /accounts/balance/get endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only /accounts/balance/get forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, balance itself is not a product that can be used to initialize Link.
Request Body
{"access_token"=>"<string>", "secret"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "options"=>{"account_ids"=>["<string>", "<string>"], "min_last_updated_datetime"=>"<string>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"accounts":[{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","verification_status":"\u003cstring\u003e"},{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","verification_status":"\u003cstring\u003e"}],"item":{"item_id":"\u003cstring\u003e","webhook":"\u003cstring,null\u003e","error":{"error_type":"\u003cstring\u003e","error_code":"\u003cstring\u003e","error_message":"\u003cstring\u003e","display_message":"\u003cstring,null\u003e","request_id":"\u003cstring\u003e","causes":["\u003cobject\u003e","\u003cobject\u003e"],"status":"\u003cnumber,null\u003e","documentation_url":"\u003cstring\u003e","suggested_action":"\u003cstring\u003e"},"available_products":["\u003cstring\u003e","\u003cstring\u003e"],"billed_products":["\u003cstring\u003e","\u003cstring\u003e"],"consent_expiration_time":"\u003cstring,null\u003e","update_type":"\u003cstring\u003e","institution_id":"\u003cstring,null\u003e","products":["\u003cstring\u003e","\u003cstring\u003e"]},"request_id":"\u003cstring\u003e"}