> ## Documentation Index
> Fetch the complete documentation index at: https://docs.playstarters.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Balance Read

> Handle the BALANCE operation: return the player's current balance when a game is opened.

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

```json theme={null}
{
  "playerId": "your_unique_user_id",
  "type": "BALANCE",
  "amount": 0,
  "currency": "EUR",
  "requestId": "request_uuid"
}
```

### Field reference

<ResponseField name="playerId" type="string">
  Your unique identifier for the player.
</ResponseField>

<ResponseField name="type" type="string">
  Always `BALANCE` for this operation.
</ResponseField>

<ResponseField name="amount" type="number">
  Always `0` for `BALANCE`.
</ResponseField>

<ResponseField name="currency" type="string">
  ISO 4217 currency code.
</ResponseField>

<ResponseField name="requestId" type="string">
  Unique identifier for this request. Safe to ignore for idempotency on read operations, but log it for support.
</ResponseField>

## Response — 200 OK

```json theme={null}
{
  "balance": 150.50
}
```

<ResponseField name="balance" type="number">
  The player's current balance in their wallet currency.
</ResponseField>

<Note>
  `BALANCE` is a read-only operation — do not move any funds. Just return the current balance.
</Note>
