Confirm payment completion
Step 2A: Confirms and completes a pending purchase that was previously registered. IMPORTANT: Expects HTTP error status (3xx, 4xx, 5xx) codes for failed purchases.
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
Request Body
application/json
Request to confirm and complete a pending purchase that was previously registered.
TypeScript Definitions
Use the request body type in TypeScript.
Request to confirm and complete a pending purchase that was previously registered.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/purchase/confirm" \ -H "Content-Type: application/json" \ -d '{ "playerId": "string", "transactionId": "string", "currency": "string", "decimalPlaces": 0, "tax": 0, "total": 0, "timeMillis": "string", "items": [ { "guid": "string", "productId": "string", "quantity": 0, "cents": 0 } ] }'{ "results": [ { "guid": "string", "productId": "string" } ]}How is this guide?
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.
Register payment intent POST
Step 1: Registers a purchase intent with the game backend. The game backend is expected to reserve inventory for the purchase. IMPORTANT: Always expects HTTP 200 OK response with inline error codes in the body.