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
WebAddressandAdminMobileNumberare now optional inCreateBeneficiaryandUpdateBeneficiary.
#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:
BatchTransfer(POST /Fund/BatchTransfer): Create a batch payment.- Get the status of a batch payment by its batch ID (
GET /Fund/BatchTransfer/{CustomerBatchId}). - Get the status of one payment in a batch by its transaction ID (
GET /Fund/BatchTransfer/{CustomerBatchId}/Items/{CustomerTransactionId}).
#4.92.3
October 14, 2025
#Changed
- Adds the optional
BankPaymentMethodrequest parameter toUserWithdrawFundandBeneficiaryCompanyWithdrawFund. - Adds the
PaymentMethodsarray to theBankDetailsobject in theGetLinkedBankAccountsresponse.
#4.92.2
June 27, 2025
#Changed
- Adds the boolean
IsEligibleOwnershiptoOwnerInformation, in theCompanyAdvancedProfilerequest and theGetCompanyAdvancedProfileDetailsresponse.
#4.92.1
April 24, 2025
#Changed
- Adds
Currencyto theGetCountryresponse.
#4.92.0
February 10, 2025
#Changed
UpdateUser: Adds the optionalMobileNumber,MobileCountryISO2, andOTPrequest parameters, so you can update an individual recipient's mobile number.
#4.91.9
January 27, 2025
#Changed
- Adds
Beneficiary Transaction IdandSub Transaction Idto theGetCompanyWalletTransactionDetailsresponse. CheckBeneficiaryExist: Adds the optionalCompanyEmailDomainandPaginationrequest parameters. EitherCompanyEmailDomainorCompanyNameis required.
#4.91.8
August 10, 2023
#New
GetEntities: Get all entities created by your organization.
#Changed
- Adds the optional boolean
EmailNotificationrequest parameter toUserWithdrawFundandBeneficiaryCompanyWithdrawFund. It is off by default; turn it on to get an email notification of the transfer. - Adds
AllowWalletLinkedBankOverrideandIsBankLinkedto theGetCompanyWalletsandGetBeneficiaryWalletsresponses.IsBankLinkedistruewhen the wallet is linked to a default bank andfalsewhen it is not.AllowWalletLinkedBankOverrideis a boolean. When it istrue, a bank ID is optional in the Bank Direct flow (XTR94500) ofBeneficiaryCompanyWithdrawFund. You can let your recipients choose a bank, and the bank ID you pass overrides the bank linked to the recipient's wallet.- When
AllowWalletLinkedBankOverrideisfalse, you don't send a bank ID in the Bank Direct flow (XTR94500) ofBeneficiaryCompanyWithdrawFund, 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
- Adds
Fees,Currency, andTotal Amountto theGetCompanyWalletTransactionDetailsandGetUserWalletTransactionDetailsresponses.
#Announcements
LinkACHDebitBankBeneficiaryaccepts onlyBUSINESSinAccountType, in any letter case. Personal accounts (SAVINGSandCHECKING) can't be linked for bank debit.
#4.91.6
February 17, 2023
#Changed
LinkACHDebitBankBeneficiary: Companies can link banks for bank debit in different currencies (USD,CAD,AUD,GBP,EUR).FundWalletUsingACHDebit: Companies can fund their wallets by bank debit in different currencies (USD,CAD,AUD,GBP,EUR).
#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
RegulatoryFieldsparameter for linking a transfer bank. Its value is an array ofKeyandValuepairs. Regulatory fields vary by bank country and currency;IsRegulatoryFieldin the API response identifies them. - Adds the
AccountTypeparameter for linking a bank. Its value is the type of your bank account:BUSINESS,SAVINGS, orCHECKING. - Removes the optional parameters
RemitterLine3andRemitterLine4.
- Adds the
LinkACHDebitBankBeneficiary:- Adds the
RegulatoryFieldsparameter for linking an ACH funding bank. Its value is an array ofKeyandValuepairs. Regulatory fields vary by bank country and currency;IsRegulatoryFieldin the API response identifies them. - Removes the optional parameters
RemitterLine3andRemitterLine4.
- Adds the
SearchBankByBIC: Removes the optional parametersBankNameandCity.SearchBankByNationalID: Adds thePaginationobject and removes the optional parametersBankNameandCity.
#4.91.3
August 1, 2022
#New
ReleaseACHDebitMicrodeposit: Sends two small deposits (micro-deposits) to a bank linked for bank debit, to confirm that Xtrm has linked your company to the correct account. After your company sends the two amounts that arrived,VerifyACHDebitMicrodepositmarks the connection as correct.VerifyACHDebitMicrodeposit: Confirms the two micro-deposit amounts sent byReleaseACHDebitMicrodeposit, which shows that the bank account is your company's and is correctly linked.
#Changed
LinkACHDebitBankBeneficiary: Adds theAccountTypeparameter for linking an ACH debit bank. Its value isBUSINESS,SAVINGS, orCHECKING, depending on the bank account given inAccountNumber. Since 4.91.7, onlyBUSINESSis accepted.CompanyAdvancedProfile:- Adds the
Payments_Typeparameter, which sets whether your company paysUSA OnlyorInternational. - Adds these
BusinessEntityInformationparameters:Purpose_Of_Transactions,Expected_Currencies,Expected_Annual_Volume,Expected_Transaction_Amount,Countries_Sending_To, andCountries_Receiving_From. - Adds
Ticker_Symbolto theOwnerInformationobject.
- Adds the
GetCompanyAdvancedProfileDetails:- Adds these
BusinessEntityInformationparameters:Purpose_Of_Transactions,Expected_Currencies,Expected_Annual_Volume,Expected_Transaction_Amount,Countries_Sending_To, andCountries_Receiving_From. - Adds
Ticker_Symbolto theOwnerInformationobject.
- Adds these
#4.91.2
May 20, 2022
#Changed
BookExchange: Removes theOTPparameter, because bothFromWalletIDandToWalletIDshould belong to the givenAccountNumber.
#4.91.1
April 10, 2022
#Changed
LinkBankBeneficiary: Adds the optionalWithdrawTypeparameter inBankDetailsto 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
CardTokenparameter to fund the wallet with a linked credit card. Get theCardTokenfromGetLinkedCards. - Credit cards have two types,
identityandtransfer. Transfer cards are prepaid debit cards for receiving funds. Onlyidentitycards can fund a wallet. - Renames
PayerBillingAddress.Address1toPayerBillingAddress.AddressLine1. - Funds from a credit card may take 1–3 business days to appear in the wallet.
- Adds the optional
#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
- Adds the optional
Filtersparameter toGetUserWalletTransactionsandGetCompanyWalletTransactionsto filter the data to a specific date range. - Adds
CountryISO2toCreateUser,UpdateUser,CreateBeneficiary, andUpdateBeneficiary, and removes the country parameter from these calls. Phone numbers must not include a country code; Xtrm sets the country code from the individual's country. CompanyAdvancedProfile: Removes theDirectorInformationobject from the request and response.OwnerInformationcan have up to 4 owners whenIsPublicallyTradedisno.
#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
- Adds the
CardTokenparameter, for company-specific card tokenization, toBeneficiaryCompanyWithdrawFundandUserWithdrawFund. - Renames the
GetCompanyTypeendpoint toGetAdvancedContactCompanyType.
#Schema changes
- Adds the
CardTokenparameter to theCardobject inGetLinkedCardsResponse.
#Announcements
- Rapid Bank Transfer API: Recipients in the US can get same-day access to their funds.
- Tax Information API: The new Tax Information API (
TransferTaxInformation) takes requests for 1099 tax reporting, so Xtrm partners can offer access to tax reporting data inside their own applications.
#New features
- Rapid Bank Transfer is a new payment method in
BeneficiaryCompanyWithdrawFundandUserWithdrawFund. - The Tax Information API sends 1099 tax forms to recipients.
#Changed functionality
- The Rapid Transfer payment option is available through these existing calls:
BeneficiaryCompanyWithdrawFundandUserWithdrawFund.
#4.7
March 5, 2021
#Changed
GetUserWalletTransactionDetails:UserIDis now required, so the call returns only the transaction details for the givenUserIDandTransactionID.
#4.6
January 25, 2021
#New
GetUserWalletTransactionDetails: Get the details of a transaction in an individual recipient's wallet, using a transaction ID fromGetUserWalletTransactions.GetConnectedStatus: Get the connection status between the connected manager and an individual or company.SearchBank: Search for a bank within a country.
#Changed
GetUserWalletTransactionDetails: Adds transfers straight to a digital gift card, usingPaymentMethodId=XTR94505,UserGiftCardEmailID, andsku.UserGiftCardEmailIDis the email address the gift card goes to, andskuis the digital gift card's unique ID fromGetDigitalGiftCards. 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
DeleteBankBeneficiary: Delete a linked bank account from a recipient.
#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 addedPayments_Type, a US company that sendsUSA Onlyhas 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 withLinkACHDebitBankBeneficiary. 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,BeneficiaryDetailsandBankDetails. AllBeneficiaryDetailsparameters are required. WhichBankDetailsparameters are required depends on the values of five parameters:InstitutionName,WithdrawType,Currency,AccountNumber, andCountryISO2. When you post these details, the response lists the additional required fields as an array ofFieldNameandFieldLabel.FieldNameis the name of the additional parameter in the API call;FieldLabelis a readable label to show when you ask for the information in your interface.GetACHDebitLinkedBankAccounts: Get all banks linked for ACH debit. Banks withACHDebitApprovalStatus=Approvedcan fund a company wallet usingFundWalletUsingACHDebit.
#Changed
- Adds
AccountIdentityLevelto the response object ofCreateUser,UpdateUser,GetPersonalBeneficiaries,CreateBeneficiary,UpdateBeneficiary,GetBeneficiaries, andLinkBankBeneficiary.
#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: ReplacesCreateBankBeneficiary. The request has two sections,BeneficiaryDetailsandBankDetails. AllBeneficiaryDetailsparameters are required. Depending on the jurisdiction and regulatory environment, some or allBankDetailsmay be required. Calling this endpoint with the basic parameters (InstitutionName,WithdrawType,Currency,AccountNumber, andCountryISO2) returns any additional required parameters as an array ofFieldNameandFieldLabel.FieldNameis the additional required parameter;FieldLabelis a readable label for asking for the information in your interface.GetGiftCardDetails: Get detailed information about a gift card from its SKU.
#Changed
CreateBankBeneficiaryis deprecated. UseLinkBankBeneficiaryinstead.
#Announcements
- Version 3.0 will be discontinued in May 2018.
#4.1.1
November 2, 2018
#Changed
CreateBankBeneficiary:- Adds
AddressLine2,City,Region/State/County, andPostalCodetoBeneficiaryDetailsin the request body. - Adds
AddressLine1andCountryISO2toBankDetailsin the request body. - Adds
AccountIdentityLevelto the response.
- Adds
- Adds
AccountIdentityLevelto theCreateUser,UpdateUser,CreateBeneficiary, andUpdateBeneficiaryresponses.
#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 toUserWithdrawFund. 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. AddsUserGiftCardEmailIDandSKUto the request body.
#4.01
February 23, 2018
#New
CreateBeneficiaryCompanyWallet: Create a wallet in a specific currency for a business recipient.UpdateBeneficiaryCompanyWallet: Update information about an existing wallet.GetBeneficiaryCompanyPaymentMethods: Get the payment options a business recipient has.BeneficiaryCompanyWithdrawFund: Lets a business recipient transfer funds out of its company wallet.
#4.0
February 10, 2018
#New
GetUserWallets: Get a list of an individual recipient's wallets. The response includesWalletID,WalletName, andWalletCurrency.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
GetCompanyWallets: AddsWalletTypeto the response, for exampleStandard.FundCompanyWalletUsingCreditCard: Adds American Express as a possible value of theCreditCardTypeparameter.CheckBeneficiaryExist: For a business recipient, the response includesEmail,MasteradminFirstname, andMasteradminLastname.UserWithdrawFund: Requires a one-time password (OTP) for every transfer. The recipient receives an OTP when this call is made. To completeUserWithdrawFund, pass the OTP along with the other parameters.
#Announcements
- Recipient transfers have an extra security step: a one-time password (OTP).
#Changed functionality
UserWithdrawFundrequires a one-time password (OTP) for every transfer, as described under Changed.
#3.0
July 15, 2017
#New
GetLinkedBankAccountsSearchBank: Get a list of banks that match the search criteria.GetBankWithdrawTypes: Get a list of bank transfer types.GetBankDynamicValidationRules: Get the full template of bank details for a recipient, based on the criteria you specify.FundCompanyWalletUsingCreditCard: Fund a wallet using a credit card.