Skip to main content

Query Balance

Interface for querying platform wallet balance.

Request Information

  • Request URL: /gateway/api/v1/platforms/balance
  • Request Method: GET
  • Content-Type: application/x-www-form-urlencoded; charset=utf-8

Request Headers

ParameterTypeDescription
AuthorizationString{authorization} Authorization ID assigned to the platform by the system

Request Parameters

None

Response Example

Success Response

{
"error_code": "0000",
"data": {
"platform_id": "PF0060",
"platform_channels": [
{
"platform_channel_id": "PFC00000141",
"channel_name": "Diamond Deposit Payout",
"balance": 100200,
"frozen_balance": 0,
"sign": "82df5556b8900e2427343381581fe73e"
},
{
"platform_channel_id": "PFC00000142",
"channel_name": "Diamond Recharge Withdraw",
"balance": 100100,
"frozen_balance": 0,
"sign": "f4912e12897d612d677c36c19d9e05e7"
}
],
"total": 4,
"total_balance": 394300,
"total_frozen_balance": 0,
"request_time": 1596530514,
"sign": "1d8f90a6b3d1ef212fb15ace3d294e9b"
}
}

Error Response Example

{
"error_code": "0006",
"error_msg": "Invalid Authorization!"
}

Response Parameter Description

ParameterTypeDescription
error_codeStringError code
error_msgStringError message (returned when error_code is not "0000")
platform_idStringPlatform Merchant ID
total_balanceIntTotal Balance (cents)
balanceIntChannel Balance (cents)

Remarks

  • authorization is the authorization ID assigned to the platform by the system. If NOT obtained yet, please contact system personnel.
  • Outer signature is composed of platform_id, total, total_balance, request_time.
  • Inner signature is composed of platform_channel_id, channel_name, balance.
  • Please refer to Signature Specification.
  • Balance unit is CNY (cents).