Resources

Changelog

Changes to the Xtrm API (v4), newest first. Operation names link to their current reference entry; operations without a link were renamed or retired in a later release.

#4.92.6

May 22, 2026

No changes to the endpoints documented on this site.

#4.92.5

May 21, 2026

#Changed

#4.92.4

November 22, 2025

#New

  • Batch payments: pay many recipients from one of your wallets in a single request. The API calls a batch payment a batch, and each payment in it an item. Three endpoints make up batch payments:

#4.92.3

October 14, 2025

#Changed

#4.92.2

June 27, 2025

#Changed

#4.92.1

April 24, 2025

#Changed

#4.92.0

February 10, 2025

#Changed

  • UpdateUser: Adds the optional MobileNumber, MobileCountryISO2, and OTP request parameters, so you can update an individual recipient's mobile number.

#4.91.9

January 27, 2025

#Changed

#4.91.8

August 10, 2023

#New

  • GetEntities: Get all entities created by your organization.

#Changed

  • Adds the optional boolean EmailNotification request parameter to UserWithdrawFund and BeneficiaryCompanyWithdrawFund. It is off by default; turn it on to get an email notification of the transfer.
  • Adds AllowWalletLinkedBankOverride and IsBankLinked to the GetCompanyWallets and GetBeneficiaryWallets responses.
    • IsBankLinked is true when the wallet is linked to a default bank and false when it is not.
    • AllowWalletLinkedBankOverride is a boolean. When it is true, a bank ID is optional in the Bank Direct flow (XTR94500) of BeneficiaryCompanyWithdrawFund. You can let your recipients choose a bank, and the bank ID you pass overrides the bank linked to the recipient's wallet.
    • When AllowWalletLinkedBankOverride is false, you don't send a bank ID in the Bank Direct flow (XTR94500) of BeneficiaryCompanyWithdrawFund, and you should not let your recipients choose a bank. Xtrm takes the bank ID from the bank linked to the recipient's wallet.

#4.91.7

February 17, 2023

#Changed

#Announcements

  • LinkACHDebitBankBeneficiary accepts only BUSINESS in AccountType, in any letter case. Personal accounts (SAVINGS and CHECKING) can't be linked for bank debit.

#4.91.6

February 17, 2023

#Changed

#Announcements

  • ACH Debit is now called Bank Debit.

#4.91.5

December 2, 2022

#New

  • GetCompanyFees: Get the fees set on your Xtrm account.
  • FundWalletUsingBankTransfer: Fund your wallets by bank transfer to the Xtrm bank account given in the response. That account varies by the input currency. After you move funds by ACH or wire, allow 2–7 business days for them to be credited, depending on your location. A pending fund transaction appears in your account until the transfer completes.

#4.91.4

November 22, 2022

#Changed

  • LinkBankBeneficiary:
    • Adds the RegulatoryFields parameter for linking a transfer bank. Its value is an array of Key and Value pairs. Regulatory fields vary by bank country and currency; IsRegulatoryField in the API response identifies them.
    • Adds the AccountType parameter for linking a bank. Its value is the type of your bank account: BUSINESS, SAVINGS, or CHECKING.
    • Removes the optional parameters RemitterLine3 and RemitterLine4.
  • LinkACHDebitBankBeneficiary:
    • Adds the RegulatoryFields parameter for linking an ACH funding bank. Its value is an array of Key and Value pairs. Regulatory fields vary by bank country and currency; IsRegulatoryField in the API response identifies them.
    • Removes the optional parameters RemitterLine3 and RemitterLine4.
  • SearchBankByBIC: Removes the optional parameters BankName and City.
  • SearchBankByNationalID: Adds the Pagination object and removes the optional parameters BankName and City.

#4.91.3

August 1, 2022

#New

#Changed

  • LinkACHDebitBankBeneficiary: Adds the AccountType parameter for linking an ACH debit bank. Its value is BUSINESS, SAVINGS, or CHECKING, depending on the bank account given in AccountNumber. Since 4.91.7, only BUSINESS is accepted.
  • CompanyAdvancedProfile:
    • Adds the Payments_Type parameter, which sets whether your company pays USA Only or International.
    • Adds these BusinessEntityInformation parameters: Purpose_Of_Transactions, Expected_Currencies, Expected_Annual_Volume, Expected_Transaction_Amount, Countries_Sending_To, and Countries_Receiving_From.
    • Adds Ticker_Symbol to the OwnerInformation object.
  • GetCompanyAdvancedProfileDetails:
    • Adds these BusinessEntityInformation parameters: Purpose_Of_Transactions, Expected_Currencies, Expected_Annual_Volume, Expected_Transaction_Amount, Countries_Sending_To, and Countries_Receiving_From.
    • Adds Ticker_Symbol to the OwnerInformation object.

#4.91.2

May 20, 2022

#Changed

  • BookExchange: Removes the OTP parameter, because both FromWalletID and ToWalletID should belong to the given AccountNumber.

#4.91.1

April 10, 2022

#Changed

  • LinkBankBeneficiary: Adds the optional WithdrawType parameter in BankDetails to control how money is transferred. By default, Xtrm chooses the least expensive available transfer method, but in some cases a SWIFT transfer may be required for contractual or other reasons. Possible values:
    • LV: Use a low-value rail, such as ACH transfer.
    • HV: Use a high-value rail (SWIFT, wire transfer).

#4.91

March 29, 2022

#Changed

  • FundCompanyWalletUsingCreditCard:
    • Adds the optional CardToken parameter to fund the wallet with a linked credit card. Get the CardToken from GetLinkedCards.
    • Credit cards have two types, identity and transfer. Transfer cards are prepaid debit cards for receiving funds. Only identity cards can fund a wallet.
    • Renames PayerBillingAddress.Address1 to PayerBillingAddress.AddressLine1.
    • Funds from a credit card may take 1–3 business days to appear in the wallet.

#4.9

April 1, 2022

#New

  • SearchBankByBIC: Find a bank by its SWIFT (Society for Worldwide Interbank Financial Telecommunication) code, also called a BIC (Business/Bank Identifier Code).
  • SearchBankByNationalID: Find banks by a national ID code.
  • ValidateIBAN: Validate a bank's IBAN.

#Changed

#4.8

December 9, 2021

#New

  • GetLinkedCards: List the credit and debit cards linked to an individual recipient.
  • LinkCard: Link a credit or debit card to an individual recipient.
  • DeleteCard: Remove a linked credit or debit card from an individual recipient.
  • TransferTaxInformation: Have Xtrm email tax information to a recipient's registered email address. Currently, only 1099K forms are supported.

#Changed

#Schema changes

  • Adds the CardToken parameter to the Card object in GetLinkedCardsResponse.

#Announcements

#New features

#Changed functionality

#4.7

March 5, 2021

#Changed

#4.6

January 25, 2021

#New

#Changed

  • GetUserWalletTransactionDetails: Adds transfers straight to a digital gift card, using PaymentMethodId = XTR94505, UserGiftCardEmailID, and sku. UserGiftCardEmailID is the email address the gift card goes to, and sku is the digital gift card's unique ID from GetDigitalGiftCards. For transfers to prepaid cards and gift cards, the API response includes the full redemption details. You can show them to your recipients so they can redeem the card by following the instructions. Xtrm also emails the same redemption details to the recipient.
  • UserWithdrawFund: For transfers to prepaid cards and gift cards, the API response includes the full redemption details. You can show them to your recipients so they can redeem the card by following the instructions. Xtrm also emails the same redemption details to the recipient.

#4.5

November 9, 2020

#New

#4.4

October 10, 2020

#New

  • CompanyAdvancedProfile: Fill in and submit the Advanced Profile for your company or a connected company. The advanced profile has four sections: Business Entity Information, Authorized Contact Information, Director Information, and Ownership Information. A United States company must complete only the first two sections (Business Entity Information and Authorized Contact Information); the rest are not required. All other companies must complete all four sections. (Release 4.9 removed Director Information: the authorized contact is the company's director or signatory. Since release 4.91.3 added Payments_Type, a US company that sends USA Only has a lighter onboarding: the authorized contact information is required only in an international profile.)
  • CompanyAdvancedProfileStatus: Get the completion status of your company's profile (Submitted, Pending, or Approved).
  • GetAdvancedContactCountry: Get a list of countries with the ISO2 two-character code for each country.
  • GetAdvancedContactState: Get a list of the regions within a specific country, with the abbreviation for each region.
  • GetIdentificationType: Get a list of identification types.
  • GetNAICS: Get a list of industry types.
  • GetAdvancedContactJobTitles: Get a standard list of job titles.

#4.3

October 15, 2019

#New

  • FundWalletUsingACHDebit: Fund a company wallet from a linked bank account by ACH debit. Funds can come only from banks linked with LinkACHDebitBankBeneficiary. ACH debit funding takes time: linking a bank to an account may take three to five business days.
  • LinkACHDebitBankBeneficiary: Link an ACH debit bank for approval. Once the bank is approved for ACH debit, you can use it to fund your company wallet. The request has two sections, BeneficiaryDetails and BankDetails. All BeneficiaryDetails parameters are required. Which BankDetails parameters are required depends on the values of five parameters: InstitutionName, WithdrawType, Currency, AccountNumber, and CountryISO2. When you post these details, the response lists the additional required fields as an array of FieldName and FieldLabel. FieldName is the name of the additional parameter in the API call; FieldLabel is a readable label to show when you ask for the information in your interface.
  • GetACHDebitLinkedBankAccounts: Get all banks linked for ACH debit. Banks with ACHDebitApprovalStatus = Approved can fund a company wallet using FundWalletUsingACHDebit.

#Changed

#4.2

February 15, 2019

#New

  • FundUserToUserWalletUsingCreditCard: Fund an individual recipient's wallet with a credit card. This call requires special access rights and does not work without them. Contact [email protected] for access.
  • LinkBankBeneficiary: Replaces CreateBankBeneficiary. The request has two sections, BeneficiaryDetails and BankDetails. All BeneficiaryDetails parameters are required. Depending on the jurisdiction and regulatory environment, some or all BankDetails may be required. Calling this endpoint with the basic parameters (InstitutionName, WithdrawType, Currency, AccountNumber, and CountryISO2) returns any additional required parameters as an array of FieldName and FieldLabel. FieldName is the additional required parameter; FieldLabel is a readable label for asking for the information in your interface.
  • GetGiftCardDetails: Get detailed information about a gift card from its SKU.

#Changed

#Announcements

  • Version 3.0 will be discontinued in May 2018.

#4.1.1

November 2, 2018

#Changed

  • CreateBankBeneficiary:
    • Adds AddressLine2, City, Region/State/County, and PostalCode to BeneficiaryDetails in the request body.
    • Adds AddressLine1 and CountryISO2 to BankDetails in the request body.
    • Adds AccountIdentityLevel to the response.
  • Adds AccountIdentityLevel to the CreateUser, UpdateUser, CreateBeneficiary, and UpdateBeneficiary responses.

#4.1

May 1, 2018

#New

  • GetUserWalletTransactionsByRemitter: Get a list of transactions between one individual recipient and one paying company. Each record has the amount that company paid the recipient.
  • GetExchangeRate: Get the real-time exchange rate between two currencies.
  • BookExchange: Move funds between wallets of different currencies, exchanged at the real-time rate.
  • GetDigitalGiftCards: Get the list of digital gift cards Xtrm supports for a particular currency. Each card has a unique SKU, which you use as input to UserWithdrawFund. Digital gift cards are another way for recipients to transfer funds.

#Changed

  • GetUserPaymentMethods: Digital gift cards are now another option for transferring funds.
  • UserWithdrawFund: Recipients can transfer funds to digital gift cards. Adds UserGiftCardEmailID and SKU to the request body.

#4.01

February 23, 2018

#New

#4.0

February 10, 2018

#New

  • GetUserWallets: Get a list of an individual recipient's wallets. The response includes WalletID, WalletName, and WalletCurrency.
  • GetPersonalBeneficiaries: Get a list of the individual recipients you created through the API or the web.
  • CheckUserExist: Check whether an individual recipient exists, using an email address as input.

#Changed

#Announcements

  • Recipient transfers have an extra security step: a one-time password (OTP).

#Changed functionality

  • UserWithdrawFund requires a one-time password (OTP) for every transfer, as described under Changed.

#3.0

July 15, 2017

#New