Skip to main content
POST
/
accounts
/
balance
/
get
/accounts/balance/get
curl --request POST \
  --url http://localhost:8080/plaid-compatible/accounts/balance/get \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "access_token": "<string>",
  "secret": "<string>",
  "client_id": "<string>",
  "options": {
    "account_ids": [
      "<string>"
    ],
    "min_last_updated_datetime": "2023-11-07T05:31:56Z"
  }
}'
{
  "access_token": "<string>",
  "secret": "<string>",
  "client_id": "<string>",
  "options": {
    "account_ids": [
      "<string>"
    ],
    "min_last_updated_datetime": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

AccountsBalanceGetRequest defines the request schema for /accounts/balance/get

​
access_token
string
required

The access token associated with the Item data is being requested for.

​
secret
string | null

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

​
client_id
string | null

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

​
options
object | null

An optional object to filter /accounts/balance/get results.

Response

OK

AccountsBalanceGetRequest defines the request schema for /accounts/balance/get

​
access_token
string
required

The access token associated with the Item data is being requested for.

​
secret
string | null

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

​
client_id
string | null

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

​
options
object | null

An optional object to filter /accounts/balance/get results.