Get Player Balance (To be implemented by Operator)
POST
{callbackURL}/getBalanceEndpoint for PHL to sync player's balance from operator periodically.
PHL will only invoke this endpoint when player haven't synced in X minutes of periods or player choose to manually click on refresh button from site.
X = 5 minutes (Configurable in PHL)
Envelope
Please encode the following parameters into JSON, then encode them using Base64 and put them into the data field of a generic request/response. Signature: refer to Signature Description.
Request Schema
| Property | Field Type | Mandatory | Description | Sample value |
|---|---|---|---|---|
| username | String | Y | Username used from the operator. Note: such field should be unique across operator system | JOHNDOE |
| currency | String | Y | Currency Code | PHP |
Response Schema
| Property | Field Type | Mandatory | Description | Sample value |
|---|---|---|---|---|
| code | String | Y | Status code, refers Response Code | 8000 |
| balanceAmount | Decimal | Y | Balance (real credit plus free credit) | 3900.00 |
| currency | String | Y | Currency wallet transfer to/from. See System Code – Currency | PHP |
| realCredit | Decimal | Y | Real credit. If your company has not enabled the free credit function, then no need to return this attribute | 2000.00 |
| freeCredit | Decimal | Y | Free credit. If your company has not enabled the free credit function, then no need to return this attribute | 1900.00 |
| lastSyncedDate | Decimal | Y | Balance query time in ISO 8601 with offset. Format: yyyy-MM-dd'T'HH:mm:ss'+08:00' | 2023-10-16T11:24:42+08:00 |
Request Sample
{
"username": "JOHNDOE",
"currency": "PHP"
}
Response Sample
{
"balanceAmount": 3900,
"currency": "PHP",
"realCredit": "2000.00",
"freeCredit": "1900.00",
"lastSyncedDate": "2023-10-16T11:24:42+08:00"
}