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
| Environment | API base URL | Token URL |
|---|---|---|
| Sandbox | https://xapisandbox.xtrm.com/API/v4 | https://xapisandbox.xtrm.com/oAuth/token |
| Production | https://xapi.xtrm.com/API/v4 | https://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.
- POST
/API/v4/Beneficiary/CheckBeneficiaryExistSearch for existing company accounts - POST
/API/v4/Beneficiary/CreateBeneficiaryCreate a business recipient - POST
/API/v4/Beneficiary/UpdateBeneficiaryUpdate a business recipient - POST
/API/v4/Beneficiary/GetBeneficiariesList business recipients - POST
/API/v4/Beneficiary/GetEntitiesList your organization's entities
#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.
- POST
/API/v4/Register/CompanyAdvancedProfileSubmit a company advanced profile - POST
/API/v4/Register/CompanyAdvancedProfileStatusGet the status of an advanced profile - POST
/API/v4/Register/GetCompanyAdvancedProfileDetailsGet advanced profile details - POST
/API/v4/Register/GetAdvancedContactCountryList countries for an advanced profile - POST
/API/v4/Register/GetAdvancedContactStateList regions for an advanced profile - POST
/API/v4/Register/GetAdvancedContactCompanyTypeList company types for a country - POST
/API/v4/Register/GetNAICSList NAICS industry types - POST
/API/v4/Register/GetAdvancedContactJobTitlesList standard job titles - POST
/API/v4/Register/GetIdentificationTypeList identification types
#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.
- POST
/API/v4/Wallet/CreateCompanyWalletCreate a company wallet - POST
/API/v4/Wallet/GetCompanyWalletsList company wallets - POST
/API/v4/Wallet/UpdateCompanyWalletRename a company wallet - POST
/API/v4/Wallet/CreateUserWalletCreate an individual recipient's wallet - POST
/API/v4/Wallet/GetUserWalletsList an individual recipient's wallets - POST
/API/v4/Wallet/GetUserWalletBalanceGet an individual recipient's wallet balance - POST
/API/v4/Wallet/UpdateUserWalletRename an individual recipient's wallet - POST
/API/v4/Wallet/CreateBeneficiaryCompanyWalletCreate a business recipient's wallet - POST
/API/v4/Wallet/GetBeneficiaryWalletsList a recipient's wallets - POST
/API/v4/Wallet/UpdateBeneficiaryCompanyWalletRename a business recipient's wallet
#Wallet transactions
Wallet transactions are the credits and debits recorded in a wallet.
- POST
/API/v4/Wallet/GetCompanyWalletTransactionsList company wallet transactions - POST
/API/v4/Wallet/GetCompanyWalletTransactionDetailsGet the details of a company wallet transaction - POST
/API/v4/Wallet/GetUserWalletTransactionsList an individual recipient's wallet transactions - POST
/API/v4/Wallet/GetUserWalletTransactionDetailsGet the details of an individual recipient's wallet transaction - POST
/API/v4/Wallet/GetUserWalletTransactionsByRemitterList an individual recipient's transactions from one company
#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.
- POST
/API/v4/Bank/LinkBankBeneficiaryLink a bank account to a recipient - POST
/API/v4/Bank/GetLinkedBankAccountsList a recipient's linked bank accounts - POST
/API/v4/Bank/DeleteBankBeneficiaryDelete a linked bank account - POST
/API/v4/Bank/ValidateIBANValidate an IBAN - POST
/API/v4/Bank/SearchBankByNationalIDSearch banks by national ID - POST
/API/v4/Bank/SearchBankByBICSearch banks by SWIFT-BIC - POST
/API/v4/Bank/GetBankWithdrawTypesList bank transfer types for a country
#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.
- POST
/API/v4/Bank/LinkACHDebitBankBeneficiaryLink a bank account for bank debit funding - POST
/API/v4/Bank/ReleaseACHDebitMicrodepositSend micro-deposits to a linked bank - POST
/API/v4/Bank/VerifyACHDebitMicrodepositVerify micro-deposit amounts - POST
/API/v4/Bank/GetACHDebitLinkedBankAccountsList bank accounts linked for bank debit
#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.
- POST
/API/v4/Programs/ProgramCategoryList program categories - POST
/API/v4/Programs/ProgramTypeList program types for a category - POST
/API/v4/Programs/CreateProgramCreate a payment program - POST
/API/v4/Programs/UpdateProgramUpdate a payment program - POST
/API/v4/Programs/GetProgramsList your company's 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.