GET api/getbalance/{sessionID}
Get user wallet balances
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| sessionID |
Session ID (obtained at login) |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetBalanceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| retval |
Return code (0 - OK, otherwise - error) |
integer |
None. |
| desc |
Return code text description (error description) |
string |
None. |
| Zfree |
Z available |
decimal number |
None. |
| Zlock |
Z locked |
decimal number |
None. |
| Rfree |
R available |
decimal number |
None. |
| Rlock |
R locked |
decimal number |
None. |
| Efree |
E available |
decimal number |
None. |
| Elock |
E locked |
decimal number |
None. |
| Ufree |
U available |
decimal number |
None. |
| Lfree |
L available |
decimal number |
None. |
| Ulock |
U locked |
decimal number |
None. |
| Llock |
L locked |
decimal number |
None. |
| Xfree |
X available |
decimal number |
None. |
| Xlock |
X locked |
decimal number |
None. |
| Tfree |
T available |
decimal number |
None. |
| Tlock |
T locked |
decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"retval": 1,
"desc": "sample string 2",
"Zfree": 3.0,
"Zlock": 4.0,
"Rfree": 5.0,
"Rlock": 6.0,
"Efree": 7.0,
"Elock": 8.0,
"Ufree": 9.0,
"Lfree": 11.0,
"Ulock": 10.0,
"Llock": 12.0,
"Xfree": 13.0,
"Xlock": 14.0,
"Tfree": 15.0,
"Tlock": 16.0
}
application/xml, text/xml
Sample:
<balance.response> <retval>1</retval> <desc>sample string 2</desc> <Zfree>3</Zfree> <Zlock>4</Zlock> <Rfree>5</Rfree> <Rlock>6</Rlock> <Efree>7</Efree> <Elock>8</Elock> <UFree>9</UFree> <Ulock>10</Ulock> <LFree>11</LFree> <Llock>12</Llock> <Xfree>13</Xfree> <Xlock>14</Xlock> <Tfree>15</Tfree> <Tlock>16</Tlock> </balance.response>