Skip to main content
GET
/
accounts
/
{account_id}
/
credit_balance
Credit balance for Account
curl --request GET \
  --url https://api.togai.com/accounts/{account_id}/credit_balance \
  --header 'Authorization: Bearer <token>'
{
  "activeCredits": 1000,
  "availableBalance": 800,
  "runningBalance": 700,
  "inapplicableCredits": 100,
  "unit": "USD",
  "lastUpdatedAt": "2020-07-04T12:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
account_id
string
required

account_id corresponding to an account

Maximum string length: 50
Example:

"ACC00001"

Response

Response for Credit Balance Request

Credit Balance response

​
activeCredits
number
required
Example:

1000

​
availableBalance
number
required
Example:

700

​
runningBalance
number
required
Example:

500

​
inapplicableCredits
number
required
Example:

500

​
unit
string
required
Example:

"USD"

​
lastUpdatedAt
string<date-time>
required
Example:

"2021-01-01T00:00:00Z"