Get player by ID
Retrieves an existing player by ID. Returns player information including profile data and in-game currency balance.
Authorization
hmac Versioned HMAC-SHA256 signature for server-to-server communication between game backends and Stash services. Recommended over the deprecated legacyHmac scheme for the best security. Header format: v1;{shopId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} signed with your Egress API key, where {requestBody} is the compact request JSON. The timestamp must be within 5 minutes of Stash server time. Your shopId is your immutable shop identifier; it and your Egress API key are available in Stash Studio under Project Settings > API Secrets.
In: header
Query Parameters
The player ID to retrieve
The originating Stash shop identifier (mirrors the shopId sent in webhooks)
Payment environment for the request
"PAYMENT_ENVIRONMENT_UNSPECIFIED"Value in
- "PAYMENT_ENVIRONMENT_UNSPECIFIED"
- "PAYMENT_ENVIRONMENT_TEST"
- "PAYMENT_ENVIRONMENT_PRODUCTION"
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/player?playerId=string"{ "player": { "playerId": "string", "name": "string", "avatarUrl": "string", "language": "string", "inGameLevel": 0, "inGameCurrency": 0 }}How is this guide?
Get offer details GET
Retrieves detailed information about a specific offer, including reward details and tabbed content with structured data tables for each item.
Cancel pending payment POST
Step 2B: Cancels a pending purchase that was previously registered. IMPORTANT: Always expects HTTP 200 OK response with inline error codes in the body.