client/v1/balance

[GET] client/v1/balance

Get total balances of all customers

The client admin balance endpoint will return the total sum of all customer balances in the client's account.

Example [GET] Request

{{avenu_base_url}}/client/v1/balance

Example Response

{
    "availableBalance": "",
    "currentBalance": "",
    "ledgerCurrency": ""
}

Response Elements

ElementDetails
availableBalanceThe sum of all customers' available balances
currentBalanceThe sum of all customers' current balances
ledgerCurrencyThe currency of the balance values in the ledger