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).

v2 lets you read that balance. It has no deposit, withdrawal, or ledger-history endpoint — you top the fund up on-chain, and you reconcile the ledger in the management portal. (v3 adds the deposit addresses and the fund ledger.)

Poll this endpoint and alert yourself well before zero. There is no warning from us.

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"
}
An unknown currency returns zero, not an error

Ask for a currency you do not hold — or misspell one — and you get balance: 0 with success: true. There is no "no such wallet" error.

So a zero balance is ambiguous: it means either your fund is empty or you asked the wrong question. Do not wire "balance is 0" straight to a low-fund alert without checking that currency in the response is the one you meant.

Errors — only the shared ones.

On this page