customer/v1/balance

[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

{{avenu_base_url}}/customer/v1/balance

Example Response

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

Response Elements

Element	Meaning	Reference
customerAccountNumber	The customer's Avenu client account number
availableBalance	The customer's current balance that is available to be used for transactions.
currentBalance	In addition to the customer's available balance, the current balance also includes any pending transactions.
currency	The three-letter ISO currency code	ISO currency code

Errors

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