Player details
Request
URI: /playerDetails?{parameters}
Example usage: https://{callback_url}/playerDetails?{parameters}
The request is executed using the GET
method.
This method is used to retrieve player data.
note
If user first time try to play FUNGAMESS will register new users based on playerDetails Response received by ThirdParty Platform.
A new player registers with the parameters userId, nickname, currency.
The parameters used during registration cannot be changed for this player.
Request parameters
Name | Type | Required | Description |
---|---|---|---|
token | string | Yes | Authorization code of user's session. Restrictions: 1..250 |
userId | string | Yes | The unique identifier of the user |
Response parameters
Name | Type | Required | Description |
---|---|---|---|
status | boolean | Yes | Response status code for Call back API Accepted values: true , false |
userId | string | Yes | User identifier within third party platform system |
balance | decimal | Yes | Player's latest balance at the time of the request completion Decimal format required balance is the sum of realBalance and bonusBalance parameters Maximum possible value: 999999999999999999.99 999999999999.99999999 |
nickname | string | Yes | Nickname or Username within third party platform system Restrictions: 3..64 |
currency | string | Yes | Index of player's currency |
language | string | Yes | Language code |
realBalance | decimal | No | Player's latest balance at the time of the request completion Decimal format required Maximum possible value: 999999999999999999.99 999999999999.99999999 |
bonusBalance | decimal | No | Player's latest balance at the time of the request completion Decimal format required Maximum possible value: 999999999999999999.99 999999999999.99999999 |
string | No | User's email in third party platform system | |
firstName | string | No | User's First name within third party platform system |
lastName | string | No | User's Last name within third party platform system |
agentId | string | No | Define Agent for the user (Distributor option for finance statistics) |
groupId | string | No | Define Group ID for the user (Distributor option for finance statistics) |
errors | object | No | Description of errors in case status = false |
errors.code | number | No | Error code |
errors.error | string | No | Error description |
Example of a successful response
Response: /playerDetails?{parameters}
{
"status": true,
"userId": "3234",
"balance": 148229.67,
"nickname": "alex",
"currency": "EUR",
"language": "en",
"realBalance": 148229.67,
"bonusBalance": 0,
"email": "[email protected]",
"firstName": "Alex",
"lastName": "Amberson",
"agentId": "Agent Default",
"groupId": "Group Default"
}
Example of an unsuccessful response
Response: /playerDetails?{parameters}
{
"status": false,
"errors": {
"code": 400,
"error": "Description"
}
}