get getBalance

https://onlinesim.io/api/getBalance.php
profile
This request can be used to get your current balance. You might use it to check the balance of the profile to top it up when needed (for example to handle `WARNING_LOW_BALANCE` exceptions).

Security

Parameters

income
Information on affiliate program earnings
In: query
Schema:
  • boolean
    Example: true
lang

Response language:

fr - French,

de - German,

ru - Russian,

en - English,

zh - Chinese. Please note that the translation applies only to string field values, such as service names or country names. Field names themselves, error messages, and standard values (for example, true/false for boolean fields) remain in English.

In: query
Schema:
  • string
    Example: "en"
    Enum: fr de ru en zh

Global params

Responses

200

Successful response for `getBalance` request: the server returns information on your current balance status or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"response":1,"balance":"230.25","zbalance":120.5}
    Properties:
    • response
      mixed
      1, if the request has been completed successfully, or an error message
      Example: 1
      One Of:
      • integer
        Example: 0
      • string
        Example: "string"
    • balance
      string
      Current available balance
      Example: "230.25"
    • zbalance
      number
      Frozen balance (the funds reserved for active operations, which will be returned if those operations are cancelled)
      Example: 120.5