client/v1/customer/balance

[GET] /client/v1/customer/balance

Get customer balance using client admin endpoint

The client admin customer balance endpoint in Avenu's API will retrieve the available and current balances of a customer account, based on the provided customer account number. This endpoint is only authorized for client access tokens.

Example [GET] Request

{{avenu_base_url}}/client/v1/customer/balance/{customerAccountNumber}

Input Parameters

Parameter	Length Restrictions	Format Restrictions	Required (Y/N)	Type
customerAccountNumber	Exactly 16 digits	No special characters ("!"#$%'*+.:;<=>?@[]^_`{\|}~")	Y	String

Example Response

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

Response Elements

Element	Meaning	Reference
customerAccountNumber	The customer's sub-ledger 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
CH3009	Invalid Format
CH3010	Invalid Length
CH3011	Missing Required Field
CH3012	Does not exist