Skip to main content

Fund

You hold a crypto fund with AliX. Every order you create debits it and pays the recipient in local currency; if it runs dry, orders fail with PARTNER_INSUFFICIENT_BALANCE (errorCode 7).

The API reads that balance; you top the fund up on-chain, and the management portal keeps the balance history you reconcile against.

Poll this endpoint and alert yourself well before zero — running dry is something only you can see coming.

Get your balance

POST /api/v2/wallet/balance

Signed string

partnerCode|currency|<secretKey>

Request

FieldTypeRequiredNotes
partnerCodestringYes
currencystringYesThe crypto to read — USDT, BTC, ETH. It is part of the signed string, so omitting it does not come back as a missing field — it comes back as a bad signature.
signaturestringYesOmitting it fails with errorCode 2.

Response data

FieldTypeNotes
balancenumberTruncated to 2 decimals, not rounded.
currencystringEchoed back from your request.
signaturestringOver balance|currency|secretKey.
JSON
{
"success": true,
"message": "Your request has been successful",
"data": { "balance": 1500.25, "currency": "USDT", "signature": "K3tQ...==" },
"errorCode": 0,
"semanticCode": "SUCCESS"
}
Confirm the currency before acting on a zero balance

A currency you do not hold — or a misspelled one — answers balance: 0 with success: true. So before wiring a zero balance to a low-fund alert, check that the currency echoed in the response is the one you meant.

Errors — only the shared ones.

On this page