Get Balance
Wallet API
Get Balance
Retrieves the current balance of a player based on their player ID.
Get Balance
Documentation Index
Fetch the complete documentation index at: https://docs.game-services.work/llms.txt
Use this file to discover all available pages before exploring further.
GET /balance
Headers
| Name | Type | Description |
|---|---|---|
| X-Auth-Token | string | Custom authentication header in the format X-Auth-Token: your_token_here. This token is required to authorize API requests. |
Request Parameters
| Name | Type | Description |
|---|---|---|
| playerId | string | Unique identifier of the player whose balance is being retrieved. |
| gameUuid | string | Unique identifier of the game for which the request is being made. |
| sessionId | string | Unique identifier of the player’s session. |
| promotionExternalId | string | External identifier of the promotion session. This parameter must be sent for promo or free bet requests and omitted for regular game requests. |
| currency | string | The currency code for the transaction, typically in ISO 4217 format. |
Response Parameters
| Name | Type | Description |
|---|---|---|
| balance | decimal | The current balance of the player. |
Error
If an error occurs while processing a request, the API must return a response with
HTTP Status Code: 400 Bad Request| Name | Type | Description |
|---|---|---|
| error_code | string | Error code describing the specific issue. |
Assert that the incoming sessionId is valid, and return the player’s current balance. If
promotionExternalId is present, resolve the balance in the context of the promo or free bet session identified by this value.