Get Account

Get Account

Info

The Get Account endpoint retrieves player profile information required for gameplay, including unique ID, currency, location, and account balances.

Overview

The Get Account method is typically the first transaction API call made when a player launches a game. It verifies the player’s session and returns essential player details needed for the game to function correctly. Game providers use this information to configure the game session, set currency display, and initialize the player’s balance.

Flow Diagram

sequenceDiagram participant Player participant Game as Game Provider participant Groove as Groove Platform participant Casino as Casino Operator Player->>Game: Launch Game Game->>Groove: Get Account Request Groove->>Casino: Forward Get Account Request Casino->>Casino: Validate Session Casino->>Casino: Retrieve Player Details Casino->>Groove: Player Account Response Groove->>Game: Forward Account Response Game->>Player: Initialize Game with Player Settings

Casino Responsibilities

The casino platform must perform the following operations when processing a Get Account request:

  1. Session Validation

    • Confirm the incoming game session ID is valid
    • Verify the session is associated with the provided account ID
    • Reject the request if validation fails

  2. Player Data Retrieval

    • Return consistent player identifiers for the same player across sessions
    • Provide accurate player location information
    • Return the current player balances (real money and bonus)
    • Include the correct currency setting for the player

  3. Consistency Requirements

    • The account ID must be unique per player and consistent across sessions
    • This is particularly important for retry and rollback operations

Request Details

Endpoint

{casino_endpoint}?request=getaccount&[parameters]

Request Parameters

Parameter Data type Required Description
accountid String(60) - [0-9a-zA-Z] Yes Player’s unique identifier
Example: 5179068
apiversion String Yes API version
Example: 1.2
device String Yes Player’s device type
Valid values: desktop, mobile
gamesessionid String(64) Yes Game session ID
Example: 11_99d71938-c2d9-4844-b950-d598c2es
request String Yes Request method name
Value: getaccount

Example Request

GET {casino_endpoint}?request=getaccount&gamesessionid=123_jdhdujdk&accountid=111&device=desktop&apiversion=1.2

Response Details

Response Parameters

Parameter Data type Required Description
accountid String Yes Player’s unique identifier
Example: 5179068
apiversion String Yes API version
Example: 1.2
city String(32) Yes Player’s city location
Examples: London, Tel Aviv
code Integer Yes Response code (see Appendix)
Example: 200
country String Yes Player’s country (ISO 3166-1 alpha-2 code)
Examples: IL, UK, US
currency String Yes Player’s currency (ISO 4217 code)
Example: EUR
gamesessionid String(64) Yes Game session ID (should be the same as in game launch)
Example: 11_99d71938-c2d9-4844-b950-d598c2es
real_balance Decimal (32,10) with max 2 decimal places Yes Player’s real money balance
Example: 100.00
bonus_balance Decimal (32,10) with max 2 decimal places Yes Player’s bonus balance
Example: 50.00
status String Yes Response status (see Appendix)
Example: Success
game_mode Integer Yes* Game mode:
1 - Real money mode
2 - Bonus mode
*Required for CMA-compliant games
order String Yes* Order type:
cash_money - Real money
bonus_money - Bonus money
*Required for CMA-compliant games
Note

**Note on Cryptocurrencies**: For Fugaso game provider, the following cryptocurrencies are also supported: BTC, LTC, DOG, ETH, BCH, USDT, and XRP.

Example Success Response

{
  "code": 200,
  "status": "Success",
  "accountid": "8877",
  "city": "London",
  "country": "GB",
  "currency": "EUR",
  "gamesessionid": "11_99d71938-c2d9-4844-b950-d598c2es",
  "real_balance": 100.00,
  "bonus_balance": 50.00,
  "game_mode": 1,
  "order": "cash_money",
  "apiversion": "1.2"
}

Error Handling

Common Error Codes

Code Status Description
1 Technical error Internal server error
1000 Not logged on Player session is invalid or expired
1003 Authentication failed Invalid session credentials or account mismatch
Tip

For a complete list of error codes, refer to [Appendix A: Transaction Response Status Codes](/appendix-a-transaction-response-status-codes/).

Implementation Notes

  1. Player Identification:

    • The accountid must be consistent for the same player across different sessions
    • This consistency is crucial for transaction reconciliation and player tracking

  2. Location Information:

    • The country parameter uses ISO 3166-1 alpha-2 country codes (e.g., US, GB, DE)
    • Location data is used for regulatory compliance and localization

  3. Currency Handling:

    • The currency parameter uses ISO 4217 currency codes (e.g., EUR, USD, GBP)
    • Cryptocurrency support varies by game provider
    • Games will display monetary values in the specified currency format

  4. CMA Compliance:

    • For UK Gambling Commission (UKGC) regulated operators, game_mode and order parameters are required
    • These parameters control how funds are consumed for wagers (real money vs. bonus money)

Security

When Signature Validation is enabled:

  1. Include the X-Groove-Signature header in your request
  2. Calculate signature using query parameters (excluding request)
  3. See Signature Validation for detailed implementation

Signature Example

For the request:

GET {casino_endpoint}?request=getaccount&gamesessionid=123_jdhdujdk&accountid=111&device=desktop&apiversion=1.2

Query parameters for signature (alphabetically sorted):

  • accountid: “111”
  • apiversion: “1.2”
  • device: “desktop”
  • gamesessionid: “123_jdhdujdk”

Concatenated values: 1111.2desktop123_jdhdujdk

With security key "test_key", the signature would be:

X-Groove-Signature: be426d042cd71743970779cd6ee7881d71d1f0eb769cbe14a0081c29c8ef2a09
  • Get Balance - Retrieves current player balance
  • Wager - Places a bet and updates player balance
  • Result - Updates player balance after a game round completes