GET
/
external_accounts
/
{external_account_id}
/
balance
Get external account balances
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/external_accounts/{external_account_id}/balance \
  --header 'Authorization: Bearer <token>'
{
  "available": 1025,
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "current": -2500,
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "last_updated_time_vendor": "2010-05-06T12:23:34.321Z",
  "limit": 10000,
  "transactions_last_updated_time": "2010-05-06T12:23:34.321Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
external_account_id
string<uuid>
required

External Account ID

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Query Parameters

​
max_age
integer

Optional relative age of a balance in seconds. If the balance is older than the requested seconds it will fail. This field is optional for most financial institutions, but required for some, so you should probably send it.

Required range: x >= 0
Example:

600

Response

A collection of fields that represent funds available in the account. The relationship between these fields is complex and can depend on geography and/or the external financial institution. You should not assume that all of these fields will be set, and you should not expect consistent results for different customers at different financial institutions.

If you use Plaid as your backing vendor, see https://plaid.com/docs/api/products/balance/ for precise details on when these fields are set and how they relate.

​
currency
string
required

ISO 4217 alphabetic currency code

Example:

"USD"

​
available
integer | null

The amount of funds available to be withdrawn from the account, as determined by the financial institution.

This is an integer in the minor currency unit (e.g. cents): 1025 means $10.25.

Example:

1025

​
creation_time
string<date-time>
Example:

"2010-05-06T12:23:34.321Z"

​
current
integer | null

For a DEPOSITORY account, this is the total amount of funds in the account.

For a CREDIT account, this is the amount owing. If negative, the lender owes the account holder.

This is an integer in the minor currency unit (e.g. cents): -2500 means $25.00 owed to the account holder.

Example:

-2500

​
last_updated_time
string<date-time>

The last time Synctera has fetched this balance from a vendor

Example:

"2010-05-06T12:23:34.321Z"

​
last_updated_time_vendor
string<date-time>

Vendor timestamp of when the balance was last updated on the vendor side

Example:

"2010-05-06T12:23:34.321Z"

​
limit
integer | null

For DEPOSITORY accounts, this is the pre-arranged overdraft limit, commonly used in Europe. In North America this is typically not set for depository accounts.

For CREDIT accounts, this is the credit limit on the account.

This is an integer in the minor currency unit (e.g. cents): 10000 means $100.00

Required range: x >= 0
Example:

10000

​
transactions_last_updated_time
string<date-time>

The last time Synctera has fetched transactions from a vendor

Example:

"2010-05-06T12:23:34.321Z"