Hoiio Open API logo Hoiio Open API

Definition

https://secure.hoiio.com/open/user/get_balance

Parameters

app_id* string
Application ID assigned to your application.
access_token* string
Access Token assigned to your application.

Result Format

{
    "status":"success_ok",
    "currency":"SGD",
    "balance":"54.650"
    "points":"50.000",
    "bonus":"4.650"
}

Documentation

This API retrieves the current credit balance of your account.

Response Parameters

status The result of your request. Refer to Result Status for details.
currency Currency used for this account. Refer to Currency Code for the list of currency code.
balance The total available credit balance for your account. This is the sum of your Hoiio Points and Hoiio Bonus Points.
points Your Hoiio Points credit balance. Hoiio Points can be transferred to another account.
bonus Your Hoiio Bonus Points credit balance. Hoiio Bonus Points cannot be transferred. If you have remaining Hoiio Bonus Points, it will be used for your transactions first before Hoiio Points.

Result Status

success_ok The request has been processed successfully.
error_invalid_http_method Invalid HTTP method. Only GET or POST are allowed.
error_malformed_params HTTP POST request parameters contains non-readable bytes.
error_X_param_missing A required parameter is missing. X is the name of the parameter that is missing.
error_invalid_access_token Your Access Token is invalid, expired or has been revoked.
error_invalid_app_id Your Application ID is invalid or has been revoked.
error_rate_limit_exceeded You have exceeded your request limit for this API. Refer to API Limits for details.
error_internal_server_error There is an unexpected error. Please contact Hoiio support for assistance.

Notifications

None.

API Limits

60 request per minute per application

Charges

None.