Overview of the steps for API / Sandbox setup for testing.
We've developed the XTRM API (XAPI) for you to integrate global rewards and payments into your system. This overview gives you an understanding of the types of calls possible with XAPI. You can explore the calls and responses you'll use while integrating XAPI into your site, mobile app, or platform. Please don't hesitate to contact us with any questions by emailing firstname.lastname@example.org.
Quick Start Guide
Follow these steps to get going quickly
- Create your Sandbox Company account.
- Login to your account.
- Go to 'Setting.'
- Click on 'Integrations.'
- Then, click 'Get Credentials.'
From this screen, you can get your API credentials and request access from whichever server(s) you are going to be connecting the XTRM API listeners. Once your IPs are approved, we will fund your sandbox company account with USD and EUR, so you can start testing.
Sandbox environment (sandbox.xtrm.com)
The Sandbox environment is a complete replica of the XTRM production environment, supporting all of the same API endpoints. Applications should be tested against the Sandbox environment before being used in production.
Differences from the production environment
- The sandbox contains only test data and is completely separate from your production account.
- Actual money is not sent or received as part of test transactions. Real financial data should never be used in the sandbox.
- All Access API endpoints have a base URL of https://xapisandbox.xtrm.com/ in sandbox and http://xapi.xtrm.com in production.
Transfer behavior in the sandbox
The Sandbox environment does not actually make any payments, so a pending transfer will not be processed as it would in production. It will simply remain in the pending state indefinitely.
Once your IPs are approved, we will add $250 USD and 250 of your local currency to two digital wallets in your account.
Once your IPs are approved, we will add $250 USD and €250 EUR to two digital wallets in your account. Once your account is created, you'll be redirected to your company account dashboard, where you can view your API key and secret and generate an OAuth access token.
Now you're ready. You can jump straight into the API docs.