[GET] /customer/v1/balance

Get customer balance

The customer balance endpoint in Avenu's API will retrieve the available and current balances of an account, based on the provided customer access token in the request header.

Example [GET] Request


Example Response

    "customerAccountNumber": "",
    "availableBalance": xxxxx,
    "currentBalance": xxxxx,
    "currency": "usd",

Response Elements

customerAccountNumberThe customer's Avenu client account number
availableBalanceThe customer's current balance that is available to be used for transactions.
currentBalanceIn addition to the customer's available balance, the current balance also includes any pending transactions.
currencyThe three-letter ISO currency codeISO currency code


1001"Missing required field"
1002"Invalid data structure"
1003"Invalid data"