Description
Gets the Available Balance of the specified Customer.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
customer-id | Integer | Required | Customer Id of the Customer whose Available Balance is to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/billing/customer-balance.json?auth-userid=0&api-key=key&customer-id=0
Response
Returns a hash map of the Customer's Available Balance containing the below details:
-
Selling Currency Symbol of the Parent Reseller (currencysymbol)
-
Available Balance Amount in the Selling Currency (sellingcurrencybalance)
-
Locked Amount in the Selling Currency (sellingcurrencylockedbalance)
-
Total Balance Amount in the Selling Currency (totalsellingbalance)
-
Available Balance Amount in the Accounting Currency (accountingcurrencybalance)
-
Locked Amount in the Accounting Currency (accountingcurrencylockedbalance)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.