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

OAuth2Scopes: sms-scope

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Parameters

query2

Name	Type	Description
`income`	`boolean`	Information on affiliate program earnings
`lang`	`string`	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:`frderuenzh`Default:`ru`Example:`en`

Responses

200

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

Content-Typeapplication/json

Schema

Responseobject

responseoneOf

1, if the request has been completed successfully, or an error message

Example:1

One Of

[0]integer

[1]string

balancestring

Current available balance

Example:230.25

zbalancenumber

Frozen balance (the funds reserved for active operations, which will be returned if those operations are cancelled)

Example:120.5

Successfull getBalance response example

{
  "response": "1",
  "balance": "106.32",
  "zbalance": 0
}