High-Level Flow
Learn the high-level overview of the Stash Pay integration flow, including how a checkout session is created, presented to the player, and confirmed via webhook. Understand the initial setup requirements and failsafe purchase flow that ensures secure transactions.
This article provides a high-level overview of the Stash Pay integration flow. It shows how a checkout session is created, presented to the player, and confirmed via webhook.
To integrate Stash Pay, the only prerequisite is to generate an API key using Stash Studio, our developer portal.
If you don't have access to Stash Studio, contact the Stash team. They'll set up your game instance and enable payment processing for you.
Initial setup requirements
Set up Stash Pay instance
To get started with Stash Pay, reach out to the Stash team. After an initial conversation, you'll receive access to our developer portal, Stash Studio. We'll set up your instance for you (including payment processing) so you can begin integrating quickly and efficiently.
Get your API key
Once you have your Stash Studio instance all set up, the only prerequisite to get started with Stash Pay is creating your first API key to call our API endpoints.
Interactive Demo
Payment Flow Overview
Requesting Checkout
Request a checkout session via the Stash API. Provide user details and item data.
Get Checkout URL
Receive a customized URL and a unique checkout ID.
Show Checkout
Display the checkout to the player via redirect, popup, or in-app browser.
Finish Purchase
Once the payment is completed, Stash sends a webhook notification to your backend.
Failsafe Purchase Flow
The failsafe purchase flow ensures players are only charged after your game server confirms item delivery.
Stash pre-authorizes payment, holds the funds, and notifies your game server through a webhook. Your server grants the items and confirms fulfillment before Stash finalizes the charge.
How is this guide?