Wallet Balance Query
API used to query wallet balance.
EndPoint
POST /binancepay/openapi/balance
Request Parameters
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
wallet | string | Y | Enum string | Binance wallet to query, currently supported enum valus: FUNDING_WALLET SPOT_WALLET |
currency | string | Y | Valid currency, must be in uppercase | Currency to query, for e.g, "USDT" |
Sample Request Body
{
"wallet": "SPOT_WALLET",
"currency": "USDT"
}
Response Parameters
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
status | string | Y | "SUCCESS" or "FAIL" | status of the API request |
code | string | Y | - | request result code, refer to |
data | AssetQueryResp | N | - | response body, refer to |
errorMessage | string | N | maximum length 256 |
Child Attribute
AssetQueryResp
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
balance | decimal | Y | Amount Range: 0.00000001 - 999999999999999.99999999; Max Unit Range: 8 decimal places | Current balance free to use |
asset | string | Y | Asset/currency name | |
fiat | string | Y | Fiat name, for fiat valuation | |
availableFiatValuation | decimal | Y | Amount Range: 0.00000001 - 999999999999999.99999999; Max Unit Range: 8 decimal places | Available fiat valuation |
availableBtcValuation | decimal | Y | Amount Range: 0.00000001 - 999999999999999.99999999; Max Unit Range: 8 decimal places | Available BTC valuation |
Sample Response
{
"status": "SUCCESS",
"code": "000000",
"data": {
"balance": 990000.00000000,
"asset": "USDT",
"fiat": "USD",
"availableFiatValuation": 989991.90516600,
"availableBtcValuation": 22.98780000
}
}
{
"status": "FAIL",
"code": "400003",
"errorMessage": "Timestamp for this request is outside of the recvWindow."
}
Result Code
Name | Code | Reason | Solution |
---|---|---|---|
UNKNOWN_ERROR | 400000 | An unknown error occurred while processing the request. | Try again later |
INVALID_REQUEST | 400001 | Parameter format is wrong or parameter transferring doesn't follow the rules. | Please check whether the parameters are correct. |
INVALID_SIGNATURE | 400002 | Incorrect signature result | Check whether the signature parameter and method comply with signature algorithm requirements. |
INVALID_TIMESTAMP | 400003 | Timestamp for this request is outside of the time window. | Sync server clock |
INVALID_API_KEY_OR_IP | 400004 | API identity key not found or invalid. | Check API identity key |
BAD_API_KEY_FMT | 400005 | API identity key format invalid. | Check API identity key. |
BAD_HTTP_METHOD | 400006 | Request method not supported. | Check Request method. |
MEDIA_TYPE_NOT_SUPPORTED | 400007 | Media type not supported. | Check Request Media type. |
INVALID_REQUEST_BODY | 400008 | Request body is not a valid json object. | Check Request body |
MANDATORY_PARAM_EMPTY_OR_MALFORMED | 400100 | A parameter was missing/empty/null, or malformed. | |
INVALID_PARAM_WRONG_LENGTH | 400101 | A parameter was not valid, was empty/null, or too long/short, or wrong format. | |
INVALID_PARAM_WRONG_VALUE | 400102 | A parameter was not valid, the value is out of range. | |
INVALID_PARAM_ILLEGAL_CHAR | 400103 | A parameter was not valid, contains illegal characters | |
INVALID_REQUEST_TOO_LARGE | 400104 | Invalid request, content length too large |