Partner API
Your balances
The KES account you hold with us and its available balance. A Collections credential also gets usd, the USD account that collections are paid into and that conversions and USD payouts draw on. When that USD account cannot be read (not opened yet, still activating, or suspended), usd.available is null and usd.unavailableReason names why; it is never reported as 0. A USDT Rails credential gets kes only.
get/v1/balances
Request
- Base URLhttps://sandbox.onlink.africa
- AuthAPI key in header X-OnLink-Key
Response
Your balances
Example response
{
"kes": {
"available": "150000.50",
"accountNumber": "00000000123456",
"currency": "KES",
"asOf": "2026-09-08T12:00:00.000Z"
},
"usd": {
"available": "98.50",
"accountNumber": "00000000000000",
"currency": "USD",
"asOf": "2026-09-08T12:00:00.000Z"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.