This is an object representing your balances.
Balances
Balances are how much money you have in a currency. You can retrieve it to see the balance currently on all currencies supported (or created) by your account.
You can also retrieve the balance history, which contains a list of payment transactions that contributed to the balance (top-ups, charges, and so forth).
Each currency's balance also has an available and pending amount. Available amounts can be used to pay for services and pending amounts are processing and would be arriving soon!
Balance object fields
| Field | Data type | Description | Type |
|---|---|---|---|
| id | string | unique id of balance | required |
| name | string | name of balance | optional |
| description | string | information about balance | optional |
| available_amount | number | funds ready to be used | required |
| pending_amount | number | funds still being processed | required |
| currency | string | currency of balance | required |
| active | boolean | specifies if the balance has been disabled or not | required |
| event_log | json | log of important event timestamps of the balance | optional |
| metadata | json | metadata to store extra information | optional |