Get Oasis Balance Account(s)¶
Get balance accounts under our supported Oasis institutions.
Endpoint¶
Parameters¶
This endpoint does not require any parameters.
Response¶
Response Body¶
| Field | Type | Description |
|---|---|---|
| code | Integer | Response code (0 = success) |
| message | String | Response message |
| successful | Boolean | Whether the request was successful |
| data | Object[] | Balance accounts array. |
data (object)
| Field | Type | Description |
|---|---|---|
| accountId | String | Account ID |
| currency | String | Currency type. Only Oasis supported tokens are allowed. |
| amount | String | Currency total amount, in standard units |
| paying | String | Amount being paid |
| pending | String | Pending amount |
| frozen | String | Frozen amount |
| validAmount | String | Available amount for withdrawal or transfer Calculated as: Total balance minus any paying, pending, or frozen funds |
Response Example¶
{
"code": 0,
"message": "string",
"data": [
{
"currency": "BTC",
"amount": "100.12345678",
"paying": "10",
"pending": "0",
"frozen": "0",
"validAmount": "100.12345678",
"accountId": "100001"
},
{
"currency": "USDT",
"amount": "100.123456",
"paying": "10",
"pending": "0",
"frozen": "0",
"validAmount": "100.123456",
"accountId": "100002"
}
],
"successful": true
}