API reference

API reference

Xtrm is a global payment platform. With the Xtrm API you fund a wallet and pay people and businesses in one batch. Each recipient is paid to their Xtrm wallet, bank account, card, gift card or check. The other 75 endpoints set up what a batch needs (recipients, wallets, bank accounts, cards) and report on what it did. Each endpoint shows its parameters, a request ready to run in cURL, Node.js, Python, C#, Java and PHP, and example responses.

Payments and currency exchange are executed by regulated financial partners.

New to the API?

Start with the Quickstart to create your first batch payment in the sandbox, then read How batch payments work and Requests & responses.

#Base URLs

EnvironmentAPI base URLToken URL
Sandboxhttps://xapisandbox.xtrm.com/API/v4https://xapisandbox.xtrm.com/oAuth/token
Productionhttps://xapi.xtrm.com/API/v4https://xapi.xtrm.com/oAuth/token

Every request except the token request needs an Authorization: Bearer <access_token> header. See Authentication.

#Start here

#Batch payments

A batch payment pays many recipients in one request, by wallet, bank, card, gift card or check.

#Authentication

The Xtrm API authenticates requests with bearer tokens.

#Recipients

#Individual recipients

An individual recipient is a person with a personal Xtrm account, identified by an account number that starts with PAT.

#Business recipients

A business recipient is a company with an Xtrm account, identified by an account number that starts with SPN.

#Advanced profile (KYB)

The advanced profile is the application for identity and sanctions checks (KYC/KYB) that a company completes to make payments through Xtrm.

#Money movement

#Funding

Funding endpoints put money into your company's own wallets.

#Recipient transfers

A recipient transfer moves money out of a recipient's Xtrm wallet to a payment method such as a bank account, Rapid Transfer, a prepaid card or a digital gift card.

#Currency exchange

Use the currency exchange endpoints to convert money between wallets that hold different currencies.

#Wallets

#Wallets

A wallet holds money in one currency for an Xtrm account.

#Wallet transactions

Wallet transactions are the credits and debits recorded in a wallet.

#Payment destinations

#Payment methods

These endpoints list the payment methods available in Xtrm.

#Bank accounts

These endpoints link a recipient's bank account to their Xtrm account so you can pay to it, and look up bank details.

#Bank debit (ACH)

Bank debit funds your company's wallets by debiting a bank account linked to your Xtrm account, over ACH or a similar bank transfer system.

#Cards

Link credit or debit cards to a recipient's Xtrm account, list the linked cards, and delete them.

#Gift cards & prepaid cards

Use these endpoints to look up the digital gift cards and prepaid cards that Xtrm supports: list the cards available in a currency, then get the details of one card from its SKU.

#Platform

#Programs

Programs are your company's payment programs or projects, such as remittance, payment or budget programs.

#OTP & connections

Use these endpoints to check whether your company is connected to a personal (PAT) or company (SPN) account, and to connect to an existing account with a one-time password (OTP) that its holder gives you.

#Reference data

Use these endpoints to look up countries and the regions (states, provinces, and so on) within a country.

#Fees & reports

Use these endpoints to read a company's wallet fees, get credit and debit totals for a connected company, and email tax forms to an individual recipient.