Skip to content
Star GameStar Game Docs

Current balance of a player

POST
/players/balance
curl --request POST \
  --url https://operator.example.com/game-wallet/v1/players/balance \
  --header 'Content-Type: application/json' \
  --header 'webhook-signature: <webhook-signature>' \
  --data '{ "player_id": "example", "session_id": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
player_id
required
string
session_id
string

Example generated

{
  "player_id": "example",
  "session_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Balance

Media typeapplication/json
object
balance
required

Integer amount in minor units, as a decimal string.

string
/^-?[0-9]{1,19}$/
currency
string

Example 

{
  "balance": "1500"
}

404

Section titled “404”

player_not_found

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
Allowed values: invalid_signature invalid_launch_code malformed_request player_not_found transaction_not_found rate_limited unavailable internal not_found
detail
string

Example 

{
  "type": "https://game-platform.dev/problems/rate_limited",
  "code": "invalid_signature"
}

default

Section titled “default”

RFC 9457 problem details

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
code
required
string
Allowed values: invalid_signature invalid_launch_code malformed_request player_not_found transaction_not_found rate_limited unavailable internal not_found
detail
string

Example 

{
  "type": "https://game-platform.dev/problems/rate_limited",
  "code": "invalid_signature"
}