Sign in
Accounts

Get account balance

Returns the balance of a balance account: funds available to pay out and funds committed to in-flight payouts. Only available for accounts with holdsBalance=true.

get/v1/accounts/{id}/balance

Path parameters

idstring required

Balance account ID

Headers

X-API-Keystring

API key

Response

Account balance

accountIdstring required

Account ID

currencystring required

Balance currency

Example response

{
  "accountId": "vba_abc123",
  "currency": "USD",
  "available": {
    "currency": "USD",
    "exponent": 2,
    "value": "12345",
    "displayValue": "123.45"
  },
  "pending": {
    "currency": "USD",
    "exponent": 2,
    "value": "12345",
    "displayValue": "123.45"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.