Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Data v2.Account
BETA
REGION.US

Get Account Balances

Signage on balances: The balance amount signage is either positive or negative -

  1. A balance that is positive indicates there are funds available to be spent.
  2. A balance that is negative indicates that the user owes funds to the financial institution. The above is true for both depository accounts and credit accounts.
get/data/v2/accounts/{id}/balances

Path parameters

idstring required

AccountId

Response

Successful.

accountIdstring

The internal identifier of account.

refreshedstring date-time

Last refreshed time of this account, ISO 8601 date and time format in UTC (YYYY-MM-DDThh:mm:ssZ).

Example response

{
  "accountId": "a6bb87e57a8c4dd4874b241471a2b9e8",
  "balances": {
    "availableBalanceExcludingCredit": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    },
    "availableBalanceIncludingCredit": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    },
    "bookedBalance": {
      "amount": {
        "currencyCode": "EUR",
        "value": {
          "scale": 2,
          "unscaledValue": 1050
        },
        "valueInMinorUnit": 1050
      }
    }
  },
  "creditLimit": {
    "amount": {
      "currencyCode": "EUR",
      "value": {
        "scale": 2,
        "unscaledValue": 1050
      },
      "valueInMinorUnit": 1050
    }
  },
  "refreshed": "2022-09-27T15:01:40Z"
}