Get a financial account balance

Get a financial account balance by its unique identifier.

get/v1/financial_accounts/{id}/balance

Request

Base URL
https://sandboxapi.givechariot.com
URL
https://sandboxapi.givechariot.com/v1/financial_accounts/{id}/balance
Auth
HTTP bearer

Path parameters

idstring required

The unique identifier for the financial account

Response

The financial account was retrieved

current_balancenumber required

The current balance is the amount of money in the account. This value is in minor currency units (USD cents).

available_balancenumber required

The available balance is the amount of money in the account that is available to be spent or transferred. This value is in minor currency units (USD cents).

timestampstring date-time required

The time the balance was retrieved

Example response

{
  "current_balance": 10000,
  "available_balance": 10000,
  "timestamp": "2020-01-31T23:00:00Z"
}

Changes

No recorded changes to this operation across all 12 revisions of this API.