OnLink
API reference

Your balances

The KES account you hold with us and its available balance. USDT is added when the ledger ships.

GET
/v1/balances

Authorization

partner-key
X-OnLink-Key<token>

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/balances"
{  "kes": {    "available": "150000.50",    "accountNumber": "46013001348902",    "currency": "KES",    "asOf": "2026-09-08T12:00:00.000Z"  }}

Your KES payout destinations GET

The destinations a sell order may name in payoutAccountId. Read-only: destinations are registered by OnLink, not through this API, so your API credential cannot add a place for money to go. Only active destinations are listed. Account numbers are returned as the last four digits only — you select a destination by id and never type its number.

Register a withdrawal address POST

Creates the address in pending_partner_approval and emails a 6-digit code to a registered administrator. The address is not usable until your administrator confirms the code and OnLink approves it. Re-registering the same address is idempotent: the existing registration is returned and no second row is created. If that registration is still awaiting your administrator and its code is no longer usable (expired, or cancelled after too many incorrect attempts), re-registering re-issues a fresh code — this is how you recover such an address. A code that is still live is never replaced, and no code is issued once the address has moved past your administrator’s approval.