Skip to content

GET /api/getBalance.php

Get information on current user balance

Returns the current user 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

  • apikey
  • BearerAuth
  • OAuth2 (Scopes: sms-scope)
    • sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Parameters

NameTypeDescription
incomeboolean

Information on affiliate program earnings

langstring

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.

Enum:frderuenzhDefault:ruExample:en

Responses

200

‘Successful response for getBalance request: the server returns
information on your current balance status or throws an exception.’

Code Samples