Skip to main content
PlayStarters calls your wallet endpoint with type: "BALANCE" whenever it needs to display the player’s current balance — typically when a game is opened.

Request

{
  "player_id": "your_unique_user_id",
  "type": "BALANCE",
  "amount": 0,
  "currency": "EUR",
  "request_id": "request_uuid",
  "game_id": ""
}

Field reference

player_id
string
Your unique identifier for the player.
type
string
Always BALANCE for this operation.
amount
number
Always 0 for BALANCE.
currency
string
ISO 4217 currency code.
request_id
string
Unique identifier for this request. Safe to ignore for idempotency on read operations, but log it for support.
game_id
string
Empty string for BALANCE operations.

Response — 200 OK

{
  "balance": 150.50
}
balance
number
The player’s current balance in their wallet currency.
BALANCE is a read-only operation — do not move any funds. Just return the current balance.