For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Wallet Balance

Get Wallet Balance

With a single endpoint, you can get the collection and transfer wallet balances for currencies enabled for your account.

Header
Value

Authorization

Bearer SECRET_KEY

Content-type

application/json

Endpoint: GET - {{baseurl}}/wallet

Once a call is initiated, we return your wallet balances across all currencies.

Sample response:

{
    "success": true,
    "message": "Wallet",
    "data": [
        {
            "availableBalance": 0,
            "ledgerBalance": 0,
            "lienBalance": 0,
            "collectionBalance": 0,
            "payoutBalance": 0,
            "refundsOrChargeBackBalance": 0,
            "rollingReserveOverdraftBalance": 0,
            "_id": "6ab3aebbb56dff4926xxxxx",
            "currency": "KES",
            "type": "payout"
        },
        {
            "availableBalance": 0,
            "ledgerBalance": 0,
            "lienBalance": 0,
            "collectionBalance": 0,
            "payoutBalance": 0,
            "refundsOrChargeBackBalance": 0,
            "rollingReserveOverdraftBalance": 0,
            "_id": "6ab3aebbb56dff4926xxxxx",
            "currency": "XOF",
            "type": "payout"
        },
        {
            "availableBalance": 0,
            "ledgerBalance": 0,
            "lienBalance": 0,
            "collectionBalance": 0,
            "payoutBalance": 0,
            "refundsOrChargeBackBalance": 0,
            "rollingReserveOverdraftBalance": 0,
            "_id": "69f21d72a3cde628cbxxxxx",
            "currency": "RWF",
            "type": "collection"
        },
        {
            "availableBalance": 0,
            "ledgerBalance": 0,
            "lienBalance": 0,
            "collectionBalance": 0,
            "payoutBalance": 0,
            "refundsOrChargeBackBalance": 0,
            "rollingReserveOverdraftBalance": 0,
            "_id": "6ab3aebbb56dff4926xxxxx",
            "currency": "RWF",
            "type": "payout"
        }
    ]
}

Each currency may appear more than once in the response — once per wallet type (collection or payout) that is active for that currency.

Last updated