Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Retrieve an Account Balance

Retrieve the current and available balances for an account in minor units of the account's currency. Learn more about account balances.

get/accounts/{account_id}/balance

Path parameters

account_idstring required

The identifier of the Account to retrieve.

Query parameters

at_timestring date-time

The moment to query the balance at. If not set, returns the current balances.

Response

Balance Lookup

account_idstring required

The identifier for the account for which the balance was queried.

available_balanceinteger required

The Account's available balance, representing the current balance less any open Pending Transactions on the Account.

current_balanceinteger required

The Account's current balance, representing the sum of all posted Transactions on the Account.

type'balance_lookup' required

A constant representing the object's type. For this resource it will always be balance_lookup.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "available_balance": 100,
  "current_balance": 100,
  "loan": null,
  "type": "balance_lookup"
}