Welcome to the
BSG Developer Docs.
BSG Developer Docs.
Whether you're looking to use our REST APIs, receive
notifications with webhooks, or build an app for the
Intercom Messenger, you've come to the right place.
BALANCE introduction
BSG provides an API to get the balance information of your account.
URI
https://app.bsg.hk/rest/common/balance
Available http methods:
- GET /rest/common/balance
The balance object
This object represents your balance information.
ATTRIBUTES
Attribute
Type
Description
amount
type: float
The amount of balance.
currency
type: string
For all supported currencies, an ISO-4217 code is returned.
limit
type: int
The credit limit of the postpay payment type.
REQUIRED PARAMETERS
No parameters are required.
RETURNS
Returns a balance object if the request was successful. If the request failed, an error object will be returned.
EXAMPLE RESPONSE
{ “error”:0,
“errorDescription”:”No errors”,
“amount”:”-0.2800005″,
“currency”:”EUR”,
“limit”:”10″
}