Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
External Accounts

Get external account balances

Given an external account ID, return the account balances in real time.

The data returned by this endpoint is always fetched synchronously; it is not cached by Synctera. As a result, response latency is often high.

get/external_accounts/{external_account_id}/balance

Path parameters

external_account_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

External Account ID

Query parameters

max_ageinteger
Example:600

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.

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.

availableinteger nullable

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.

creation_timestring date-time
currencystring required

ISO 4217 alphabetic currency code

currentinteger nullable

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.

last_updated_timestring date-time

The last time Synctera has fetched this balance from a vendor

last_updated_time_vendorstring date-time

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

limitinteger nullable

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

transactions_last_updated_timestring date-time

The last time Synctera has fetched transactions from a vendor

Example response

{
  "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"
}