Show Menu

XTRM API (XAPI) Documentation

Version 4.X

We've developed the XTRM API (XAPI) for you to embed global 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 embedding XAPI into your site, mobile app, or platform. Please don't hesitate to contact us with any questions by emailing [email protected]

Quick Start Guide

Follow these steps to get going quickly

  1. Create your Sandbox Company account
  2. Login to your account. Goto 'Setting', then 'Integrations' then click 'Get Credentials'
From this screen you can get your API credentials plus request access from whichever server(s) you are going to be connecting the the XTRM API listeners.
Once your IP’s are approved, we will fund your sandbox company account with USD and EUR so you can start testing.

Sandbox environment (

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 production environment

  1. The Sandbox contains only test data and is completely separate from your production account
  2. Actual money is not sent or received as part of test transactions. Real financial data should never be used in the Sandbox.
  3. All Access API endpoints have a base URL of in sandbox and 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.

Sandbox setup

Once your IP’s are approved, we will add $250 USD to and 250 of your local currency to two digital wallets in your account.