get
https://api.lirium-sandbox.com/v1/partner/balances
Retrieve partner account balances
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve the current balances for the partner's accounts, one entry per currency.
Request
GET /partner/balances
Example Response
{
"balances": [
{
"currency": "BTC",
"amount": "1.50000000",
"available_amount": "1.50000000"
},
{
"currency": "USD",
"amount": "100000.00",
"available_amount": "100500.00"
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
| currency | string | Currency code |
| amount | string | Current balance for the currency |
| available_amount | string | Amount available to spend, computed as amount plus any configured overdraft for the account. Equals amount when no overdraft is configured. |
Notes
- All amounts are returned as strings to preserve decimal precision.
- Use the
decimal_placesfrom Partner Details for proper formatting. available_amountmay exceedamountwhen an overdraft is configured for the account, and may differ fromamounteven when the balance is negative.
