Balance - Query Balance

Query the player's current available balance.

Request Parameters

Request Before Decryption

{
  "cipherText": "asdqwcqwqe"
}

info

For encryption description, please refer to [Operator API Implementation Guide](./overview.md#1-Security Requirements)

Request After Decryption

{
  "action": "balance",
  "uid": "gameTest1",
  "currency": "PHP",
  "brand": "VP"
}

Parameter	Type	Required	Description
action	string	Yes	Fixed as "balance"
uid	string	Yes	Player Account
currency	string	Yes	Currency Code
brand	string	Yes	Brand code, fixed as VP

Response Format

info

Response is plaintext JSON, no encryption required.

Success Response

{
  "status": "0000",
  "errText": "",
  "balance": 12345.67,
  "responseTime": "2024-12-11T01:23:38.271Z"
}

Field	Type	Description
status	string	Status Code, see Status Code Description below
errText	string	Error message, empty string on Success
balance	number	Current available Balance
responseTime	string	Response Time

Response Status and Transaction Result

Status	Query Status	Whether to Trigger Retry
0000	Success	No
9999	Failed	Yes
Timeout	Failed	Yes

Important Notes

1. Token Validation: Token validity is verified with each query
2. Real-time Balance: The returned Balance is the real-time available Balance
3. Currency Consistency: Ensure consistency with the currency set by VP
4. Caching Strategy: Recommended for Operator to cache Balance appropriately to reduce query frequency
5. Concurrency Control: May need to wait for lock release under high concurrency
6. Query Frequency: Sends once every 10 seconds after Player enters Games, until Player leaves Games