Skip to main content

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

NameTypeRequiredDescription
tokenstringYesAuthorization code of user's session. Restrictions: 1..250
userIdstringYesThe unique identifier of the user

Response parameters

NameTypeRequiredDescription
statusbooleanYesResponse status code for Call back API
Accepted values: true, false
userIdstringYesUser identifier within third party platform system
balancedecimalYesPlayer'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:
  • Fiat currencies - 999999999999999999.99
  • Crypto currencies - 999999999999.99999999
  • nicknamestringYesNickname or Username within third party platform system
    Restrictions: 3..64
    currencystringYesIndex of player's currency
    languagestringYesLanguage code
    realBalancedecimalNoPlayer's latest balance at the time of the request completion
    Decimal format required
    Maximum possible value:
  • Fiat currencies - 999999999999999999.99
  • Crypto currencies - 999999999999.99999999
  • bonusBalancedecimalNoPlayer's latest balance at the time of the request completion
    Decimal format required
    Maximum possible value:
  • Fiat currencies - 999999999999999999.99
  • Crypto currencies - 999999999999.99999999
  • emailstringNoUser's email in third party platform system
    firstNamestringNoUser's First name within third party platform system
    lastNamestringNoUser's Last name within third party platform system
    agentIdstringNoDefine Agent for the user (Distributor option for finance statistics)
    groupIdstringNoDefine Group ID for the user (Distributor option for finance statistics)
    errorsobjectNoDescription of errors in case status = false
    errors.codenumberNoError code
    errors.errorstringNoError 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"
    }
    }