Implementation Guide
Integrate String Checkout into your Game
Everything you need to complete the String Checkout implementation can be found in the sections below.
Start with the Setup and once your development environment is ready, follow our step-by-step guide in Integration Steps section.
If you need more clarification try searching the Web Payload Guide or the Checkout FAQs.
SDK Overview
The SDK exports the StringPay
object to be integrated into your game's codebase.
This class is exposed in the browser's window
object, where it can be accessed through window.StringPay
. It contains useful attributes to help you manage the state of your game, such as:
init
- This method allows you to pass your API key and control which environment the SDK uses.isLoaded
- This boolean flag lets you know if the SDK's iframe has been successfully rendered.onFrameLoad
- This method allows you to pass a function to be executed upon loading String's iframe.onFrameClose
- This method allows you to pass a function to be executed once the iframe has been closed.onTxSuccess
- This method will be called in the event of a successful transaction.onTxError
- This method will be called in the event of a failed transaction.
Updated over 1 year ago
Whatโs Next