![](\"https://secure.xtrm.com/Web/XTRMExternal/Common/images/XAPI_paymentFlow.jpg\")
The Xtrm Payments API
\nContact Support:
Name: Xtrm API Help desk
Email: apisupport@xtrm.com
Created Date | Description |
|---|---|
4.92.4 | Added new endpoint BatchTransfer to make a Batch Transfer. |
4.92.4 | Added new endpoint to get the details of a Batch Transfer using Batch iD. |
4.92.4 | Added new endpoint to get the status of the Batch Transfer using Transaction ID. |
There are no new changes for the 4.92.4 release.
\n\nThere are no schema changes for the 4.92.4 release.
\n\nThere are no announcements for the 4.92.4 release.
\n\nThere are no new features for the 4.92.4 release.
\n\nThere is no changed functionality for the 4.92.4 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1d1621dd-e71e-4cb2-8996-6c3af782c1ea"},{"name":"4.92.3 Release","id":"73e45c77-c411-4750-9a35-50867191a032","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"There are no new changes for the 4.92.3 release.
\n\nCreated Date | Description |
|---|---|
4.92.3 | Added new optional parameter BankPaymentMethod in the request to UserWithdrawFund endpoint. |
4.92.3 | Added new optional parameter BankPaymentMethod in the request to BeneficiaryCompanyWithdrawFund endpoint. |
4.92.3 | Added new array object PaymentMethods within the BankDetails object in GetLinkedBankAccounts endpoint. |
There are no schema changes for the 4.92.3 release.
\n\nThere are no announcements for the 4.92.3 release.
\n\nThere are no new features for the 4.92.3 release.
\n\nThere is no changed functionality for the 4.92.3 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"73e45c77-c411-4750-9a35-50867191a032"},{"name":"4.92.2 Release","id":"155b4332-cd5b-462c-8083-3fb277d55d6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"There are no new changes for the 4.92.2 release.
\n\nCreated Date | Description |
|---|---|
4.92.2 | Added new parameter IsEligibleOwnership in the response to CompanyAdvancedProfile endpoint. |
4.92.2 | Added new parameter IsEligibleOwnership in the response to GetCompanyAdvancedProfileDetails endpoint. |
There are no schema changes for the 4.92.2 release.
\n\nThere are no announcements for the 4.92.2 release.
\n\nThere are no new features for the 4.92.2 release.
\n\nThere is no changed functionality for the 4.92.2 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"155b4332-cd5b-462c-8083-3fb277d55d6b"},{"name":"4.92.1 Release","id":"8830d03d-80eb-4b10-82ae-2f858773503e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"There are no new changes for the 4.92.1 release.
\n\nCreated Date | Description |
|---|---|
4.92.1 | Added new parameter Currency in the response to GetCountry endpoint. |
There are no schema changes for the 4.92.1 release.
\n\nThere are no announcements for the 4.92.1 release.
\n\nThere are no new features for the 4.92.1 release.
\n\nThere is no changed functionality for the 4.92.1 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"8830d03d-80eb-4b10-82ae-2f858773503e"},{"name":"4.92.0 Release","id":"91a2e43f-c508-44db-bf5a-83530a4e76a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new changes for the 4.91.9 release.
Created Date | Description |
|---|---|
4.92.0 | Added optional parameters MobileNumber , MobileCountryISO2 and OTP parameters in the request to update mobile number of the user. |
There are no schema changes for the 4.92.0 release.
There are no announcements for the 4.92.0 release.
There are no new features for the 4.92.0 release.
There is no changed functionality for the 4.92.0 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"91a2e43f-c508-44db-bf5a-83530a4e76a5"},{"name":"4.91.9 Release","id":"ff6b717c-7ad0-44ce-881f-84b2d93adacd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new changes for the 4.91.9 release.
Created Date | Description |
|---|---|
4.91.9 | Added BeneficiaryTransactionId and SubTransactionId parameters in the response. |
Created Date | Description |
|---|---|
4.91.9 | Added BeneficiaryTransactionId and SubTransactionId parameters in the response. |
Created Date | Description |
|---|---|
4.91.9 | Added Beneficiary Transaction Id and Sub Transaction Id parameters in the response. |
Created Date | Description |
|---|---|
4.91.9 | Added optional parameters CompanyEmailDomain and Pagination in the request. Note: Either of CompanyEmailDomain or CompanyName is mandatory. |
There are no schema changes for the 4.91.9 release.
There are no announcements for the 4.91.9 release.
There are no new features for the 4.91.9 release.
There is no changed functionality for the 4.91.9 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ff6b717c-7ad0-44ce-881f-84b2d93adacd"},{"name":"4.91.8 Release","id":"0ca03cf7-89ac-4eb0-9f1a-4a81d2aab0fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
Created Date | Description |
|---|---|
4.91.8 | Get all entities created by your Organization. |
Created Date | Description |
|---|---|
4.91.8 | Added optional parameter EmailNotification in the request. It is a boolean data type. EmailNotification is by default Off, you can turn On to get email notification of the transfer transaction. |
Created Date | Description |
|---|---|
4.91.8 | Added optional parameter EmailNotification in the request. It is a boolean data type. EmailNotification is by default Off, you can turn On to get email notification of the transfer transaction. |
Created Date | Description |
|---|---|
4.91.8 | Added AllowWalletLinkedBankOverride and IsBankLinked parameters in the response. IsBankLinked will be true if the wallet is linked to a default bank. AllowWalletLinkedBankOverride is a boolean data type.
|
Created Date | Description |
|---|---|
4.91.8 | Added AllowWalletLinkedBankOverride and IsBankLinked parameters in the response. IsBankLinked will be true if the wallet is linked to a default bank. AllowWalletLinkedBankOverride is a boolean data type.
|
There are no schema changes for the 4.91.8 release.
There are no announcements for the 4.91.8 release.
There are no new features for the 4.91.8 release.
There is no changed functionality for the 4.91.8 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"0ca03cf7-89ac-4eb0-9f1a-4a81d2aab0fb"},{"name":"4.91.7 Release","id":"1fb230dc-241e-4619-9ec8-56fb56fc6c63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91.7 release.
\nCreated Date | Description |
|---|---|
4.91.7 | Changed ProgramID to optional parameter. |
Created Date | Description |
|---|---|
4.91.7 | Changed ProgramID to optional parameter. |
Created Date | Description |
|---|---|
4.91.7 | Added 3 parameters in response Fees, Currency and Total Amount. |
Created Date | Description |
|---|---|
4.91.7 | Added 3 parameters in response Fees, Currency and Total Amount. |
There are no schema changes for the 4.91.7 release.
LinkACHDebitBankBeneficiary - AccountType parameter should have value 'Business' only.
There are no new features for the 4.91.7 release.
There is no changed functionality for the 4.91.7 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1fb230dc-241e-4619-9ec8-56fb56fc6c63"},{"name":"4.91.6 Release","id":"6b743d3c-2945-4ad0-9a7c-488076ba9740","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91.6 release.
\nCreated Date | Description |
|---|---|
4.91.6 | This API call allows companies to link their banks for bank debit with different currencies (USD, CAD, AUD, GBP, EUR). |
Created Date | Description |
|---|---|
4.91.6 | This API call allows companies to fund their wallets with different currencies (USD, CAD, AUD, GBP, EUR) using bank debit. |
There are no schema changes for the 4.91.6 release.
Henceforth, ACH Debit will be termed as Bank Debit.
There are no new features for the 4.91.6 release.
There is no changed functionality for the 4.91.6 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"6b743d3c-2945-4ad0-9a7c-488076ba9740"},{"name":"4.91.5 Release","id":"116bc715-233d-4a17-b890-ff201e04dd21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
Created Date | Description |
|---|---|
4.91.5 | This API call allows companies to get the fees set to their account in XTRM\n |
Created Date | Description |
|---|---|
4.91.5 | This API call allows companies to fund their wallets using bank transfer. Fund wallet can be made by sending funds to our bank account that is given in this API call response. Our bank account varies based on the input currency. Once you ACH or WIRE funds, please allow 2-7 business days for them to be credited depending on your location. A pending fund transaction will appear in your account until it is completed. |
There are no new calls for the 4.91.5 release.
\nThere are no schema changes for the 4.91.5 release.
\n\nThere are no announcements for the 4.91.5 release.
\n\nThere are no new features for the 4.91.5 release.
\n\nThere is no changed functionality for the 4.91.5 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"116bc715-233d-4a17-b890-ff201e04dd21"},{"name":"4.91.4 Release","id":"99ee0f26-efcc-4ec5-8b12-bc0c0a69ec6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91.4 release.
\nCreated Date | Description |
|---|---|
4.91.4 |
|
Created Date | Description |
|---|---|
4.91.4 |
|
Created Date | Description |
|---|---|
4.91.4 | Removed optional parameter BankName and City |
Created Date | Description |
|---|---|
4.91.4 |
|
There are no schema changes for the 4.91.4 release.
\n\nThere are no announcements for the 4.91.4 release.
\n\nThere are no new features for the 4.91.4 release.
\n\nThere is no changed functionality for the 4.91.4 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"99ee0f26-efcc-4ec5-8b12-bc0c0a69ec6a"},{"name":"4.91.3 Release","id":"dc04b85c-a6d1-4f88-8c65-208590d22054","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
Created Date | Description | |
|---|---|---|
4.91.3 | This pulls a small amount of currency (on the order of USD $0.05) (a microdeposit) to an account to ensure that XTRM has linked the remitting entity to the correct account. Once the remitting entity has verified that the funds came from the correct account, the …/Bank/VerifyACHDebitMicrodeposit API endpoint marks the connection as correct. |
Created Date | Description | |
|---|---|---|
4.91.3 | This call verifies that the microdeposit pull of funds (from the ReleaseACHDebitMicrodeposit endpoint) for a remitting entity came from the correct account, and that the account is correctly linked. |
Created Date | Description |
|---|---|
4.91.3 | Added parameter AccountType for linking an ACH debit bank. The value for this parameter should be BUSINESS or SAVINGS or CHECKING depends on the bank account of the given AccountNumber. |
Created Date | Description |
|---|---|
4.91.3 | New parameter Payments_Type
|
Created Date | Description |
|---|---|
4.91.3 | Added new parameters for BusinessEntityInformation |
There are no schema changes for the 4.91.3 release.
\n\nThere are no announcements for the 4.91.3 release.
\n\nThere are no new features for the 4.91.3 release.
\n\nThere is no changed functionality for the 4.91.3 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"dc04b85c-a6d1-4f88-8c65-208590d22054"},{"name":"4.91.2 Release","id":"c6384efd-ce04-4d85-a265-0dceb4e34f03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91.2 release.
Created Date | Description |
|---|---|
4.91.2 | Removed parameter OTP as both FromWalletID and ToWalletID should belong to the given AccountNumber. |
There are no schema changes for the 4.91.2 release.
There are no announcements for the 4.91.2 release.
There are no new features for the 4.91.2 release.
There is no changed functionality for the 4.91.2 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c6384efd-ce04-4d85-a265-0dceb4e34f03"},{"name":"4.91.1 Release","id":"e85a877e-c45c-4452-b4e5-51323df61fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91.1 release.
Created Date | Description |
|---|---|
04/10/2022 | Added an optional parameter BankDetails→WithdrawType to control how money is transfered. By default, the least expensive available transfer method is chosen, but in some cases a SWIFT transfer may be required for contractual or other reasons. Possible values are \"LV\"Use low-value rail such as ACH transfer\"HV\"Use high-value rail (SWIFT, wire transfer) |
There are no schema changes for the 4.91.1 release.
There are no announcements for the 4.91.1 release.
There are no new features for the 4.91.1 release.
There is no changed functionality for the 4.91.1 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e85a877e-c45c-4452-b4e5-51323df61fbc"},{"name":"4.91 Release","id":"7fe18d53-6e61-478b-ab10-3d80b712bdcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
There are no new calls for the 4.91 release.
\n\n\nFunding a wallet with a credit card may take from 1–3 business days for funds to appear in the wallet.
Created Date | Description |
|---|---|
03/29/2022 | Fund a wallet using a credit card Note:
|
There are no schema changes for the 4.91 release.
There are no announcements for the 4.91 release.
There are no new features for the 4.91 release.
There is no changed functionality for the 4.91 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"7fe18d53-6e61-478b-ab10-3d80b712bdcf"},{"name":"4.9 Release","id":"26aa3e59-cfc3-478e-93d1-2ca2426401a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"Index of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
Created Date | Description |
|---|---|
04/01/2022 | This API call finds the bank by SWIFT (Society for Worldwide Interbank Financial Telecommunication) code, alternatively referred to as BIC (Business/Bank Identifier Code) |
Created Date | Description |
|---|---|
4.9 | This API call finds banks by a national ID code |
Created Date | Description |
|---|---|
4.9 | This API call validates an IBAN number for a bank |
Created Date | Description |
|---|---|
4.9 04/01/2022 | Added optional parameter Filters to GetUserWalletTransactions and GetCompanyWalletTransactions to filter the data within specific date range Added CountryISO2 for CreateUser, UpdateUser, CreateBeneficiary and UpdateBeneficiary API calls Removed country param in CreateUser, UpdateUser, CreateBeneficiary and UpdateBeneficiary api calls Please Note: Phone numbers must not have a country code; the country code is automatically determined from the individual’s country. |
Created Date | Description |
|---|---|
4.9 04/01/2022 | Modified CompanyAdvancedProfile request. Removed DirectorInformation object from request and response OwnerInformation can have up to 4 owners when IsPublicallyTraded is no |
There are no schema changes for the 4.9 release.
There are no announcements for the 4.9 release.
There are no new features for the 4.9 release.
There is no changed functionality for the 4.9 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"26aa3e59-cfc3-478e-93d1-2ca2426401a2"},{"name":"4.8 Release","id":"614c7f9e-a656-4178-b44b-d913af56fe8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"\n\n\n\n\n4.8\n\n\n\n\nIndex of Changed Calls
Schema Changes
Announcements
New Features
Changed Functionality
| \nCreated Date\n | \n\n\nDescription\n | \n
|---|---|
| \n4.8 \n\n 12/09/2021 \n | \n\n\n\n\n Fetch a list of the user's linked credit and debit cards. \n\n\n | \n
| \nCreated Date\n | \n\n\nDescription\n | \n
|---|---|
| \n4.8 \n\n 12/09/2021 \n | \n\n\n\n\n This API call gives user to link their Credit / Debit cards. \n\n\n | \n
| \nCreated Date\n | \n\n\nDescription\n | \n
|---|---|
| \n4.8 \n\n 12/09/2021 \n | \n\n\n Remove a previously linked card from a user’s linked credit and debit cards \n | \n
| \nCreated Date\n | \n\n\nDescription\n | \n
|---|---|
| \n4.8 \n\n 12/09/2021 \n | \n\n\n\n\n Request that XTRM send tax information to a beneficiary’s registered email address. Currently, only 1099K forms are supported. \n\n\n | \n
| Created Date | Description |
|---|---|
| 4.8 12/09/2021 | \nAdded CardToken parameter as company-specific card tokenization |
| Created Date | Description |
|---|---|
| 4.8 12/09/2021 | \nChanged GetCompanyType endpoint to GetAdvancedContactCompanyType |
| Created Date | Description |
|---|---|
| 4.8 12/09/2021 | \nAdded CardToken parameter as company-specific card tokenization |
| Created Date | Description |
|---|---|
| 4.8 12/09/2021 | \nAdded CardToken parameter as company-specific card tokenization |
| Created Date | Description |
|---|---|
| 4.8 12/09/2021 | \nAdded CardToken parameter as company-specific card tokenization |
Added CardToken parameter to Card object in GetLinkedCardsResponse
\n\n\n\nWith the new Rapid Bank Transfer API, XTRM now offers US payees same-day access to their funds. XTRM makes payments instant and easy
\nTax Information API Enables 1099 Tax Reporting Requests. The XTRM API now features a new Tax Information (TransferTaxInformation) to enable XTRM partners to embed access to tax reporting data directly within their applications.
\n\n\nXTRM now offers a rapid transfer payment option with existing calls.
\nThese calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\nNone for this release
\nThere are no schema changes for the 4.7 release.
\nThere are no announcements for the 4.7 release.
\nThere are no new features for the 4.7 release.
\nThere is no changed functionality for the 4.7 release.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"37c0381f-e3bf-4733-acfc-cf3e25122472"},{"name":"4.6 Release","id":"1592cc14-578b-4cbd-a9e9-9f837ea10722","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
| Created Date | Description |
|---|---|
| 4.6 01/25/2021 | This API call gives details of a user wallet transaction using transaction id from GetUserWalletTransactions. |
| Created Date | Description |
|---|---|
| 4.6 01/25/2021 | This API call gives the connected status between the connected manager and a user or company. |
| Created Date | Description |
|---|---|
| 4.6 01/25/2021 | This API call allows you to search for a bank within a country. |
| Created Date | Description |
|---|---|
| 4.6 01/25/2021 | Added send direct to digital gift card using PaymentMethodId = 'XTR94505', UserGiftCardEmailID and sku where UserGiftCardEmailID is the email to which the gift card to be sent and sku is the unique digit gift card id obtained from the GetDigitalGiftCards API. Complete redemption information is provided in the API response when transfering to prepaid cards and gift cards. Redemption information can be shown to beneficiaries to allow them to redeem by following the instructions. This is in addition to the email sent to the beneficiary with the same redemption information. |
| Created Date | Description |
|---|---|
| 4.6 01/25/2021 | Complete redemption information provided in the API response while transfering to prepaid cards and gift cards. Redemption information can be shown to your beneficiaries to allow them to redeem by following the instructions. This is in addition to the email sent to the beneficiary with the same redemption information. |
There are no schema changes for the 4.6 release.
There are no announcements for the 4.6 release.
There are no new features for the 4.6 release.
There is no changed functionality for the 4.6 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1592cc14-578b-4cbd-a9e9-9f837ea10722"},{"name":"4.5 Release","id":"811d0bd4-fb45-4ddf-9177-eaecccd32cc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"\n\n\n\n4.6\n\n\n\nThese calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.5 \n11/09/2020\n | \n\n This API call deletes a linked bank account from a beneficiary. \n | \n
There are no schema changes for the 4.5 release.
\nThere are no announcements for the 4.5 release.
\nThere are no new features for the 4.5 release.
\nThere is no changed functionality for the 4.5 release.
\n\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"811d0bd4-fb45-4ddf-9177-eaecccd32cc8"},{"name":"4.4 Release","id":"802204fb-566b-467b-9caa-b358c263eb2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API calls allows your to fill and submit your or your connected company’s Advanced Profile. There are four sections in the advanced profile \n
A Unites States company must complete the first two sections (Business Entity Information and Authorized Contact Information) only; the remainder are not required. All other companies must complete all four sections. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns the status of the remitter application’s profile completion (Submitted, Pending, or Approved. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns a list of countries, and the ISO2 2-character country code for that country. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns a list of regions within a specific country, and the abbreviation for the region. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns a list of identification types. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns a list of industry types. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.4 \n10/10/2020\n | \n\n This API call returns a standard list of job titles. \n | \n
There are no changed calls for the 4.4 release
\nThere are no schema changes for the 4.4 release.
\nThere are no announcements for the 4.4 release.
\nThere are no new features for the 4.4 release.
\nThere is no changed functionality for the 4.4 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"802204fb-566b-467b-9caa-b358c263eb2a"},{"name":"4.3 Release","id":"9208c4db-39ff-445e-a3b6-f85c7a410dc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n This API call sends funds to a company wallet from a linked bank account using ACH Debit. This call can send monies only from banks linked with the LinkACHDebitBankBeneficiary call. Please note:ACH debit funding is not instantaneous. Linking a bank to an account may take from three (3) to five (5) business days. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n This API call is used to link an ACH Debit bank for approval. Once the linked bank is approved for ACH debit, you can use it to fund your company wallet. There are 2 sections of information, Beneficiary Details and Bank Details. All parameters under Beneficiary Details parameters are mandatory. Parameters under Bank Details are mandatory baesd on the inputs to these 5 parameters (InstitutionName, WithdrawType, Currency, AccountNumber, and CountryISO2). On posting with these details to the API call you will get a response with additional fields required. The response will include an array of parameters FieldName and FieldName. FieldNameis the additional parameter name in the API call. FieldName is a user-friendly designation to request information in a user interface. \nPlease see the documentation for further information. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n This API call will get all the ACH debit linked banks. Those with ACHDebitStatus = 'Approved' can be used to fund acompany wallet using the FundWalletUsingACHDebit API call. \nPlease see the documentation for further information. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.3 \n10/15/2019\n | \n\n Added AccountIdentityLevel to the response object. \n | \n
There are no schema changes for the 4.3 release.
\nThere are no announcements for the 4.3 release.
\nThere are no new features for the 4.3 release.
\nThere is no changed functionality for the 4.3 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9208c4db-39ff-445e-a3b6-f85c7a410dc6"},{"name":"4.2 Release","id":"ed26f78c-75f1-48cf-944b-ebd404feb1ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"If you have any feedback or requests please email support@xtrm.com
\nThese calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.2 \n02/15/2019\n | \n\n This API call is used to fund a user wallet using a credit card. Please note:This API calls requires special access rights and will not function without them. Contact support@xtrm.com to get access to this API call. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.2 \n02/15/2019\n | \n\n This API call replaces the CreateBankBeneficiary API call. \nThere are two sections of information: \n
All parameters for Beneficiary Details are required. \nDepending on the jurisdiction and regulatory environment, some or all of the Bank Details may be required. Calling this API call with the basic parameters will generate a response with any additional required parameters. The basic parameters are: \n
The response will include an array of FieldName and FieldLabel. The FieldName is the additional require parameter. The FieldLabel is a user-friendly designation to identify the required information in the user interface. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.2 \n02/15/2019\n | \n\n This API call returns detailed information about a particular gift card from its SKU. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.2 \n02/15/2019\n | \n\n CreateBankBeneficiary is deprecated. Use the new LinkBankBeneficiary API call instead. \n | \n
There are no schema changes for the 4.2 release.
\nThere are no announcements for the 4.2 release.
\nThere are no new features for the 4.2 release.
\nThere is no changed functionality for the 4.2 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ed26f78c-75f1-48cf-944b-ebd404feb1ae"},{"name":"4.1.1 Release","id":"baa5f463-fcf6-4a2f-9078-040b7b2552d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\nThere are no new calls for V4.1.1
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the request body, add the following fields to BeneficiaryDetails: \n
In the request body, add the following fields to BankDetails: \n
In the response, add: \n
| \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the response, add: \n
| \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the response, add: \n
| \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the response, add: \n
| \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the response, add: \n
| \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1.1 \n11/02/2018\n | \n\n In the response, add: \n
| \n
There are no schema changes for the 4.1.1 release.
\nThere are no announcements for the 4.1.1 release.
\nThere are no new features for the 4.1.1 release.
\nThere is no changed functionality for the 4.1.1 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"baa5f463-fcf6-4a2f-9078-040b7b2552d8"},{"name":"4.1 Release","id":"61f978bb-14ca-46ec-a0ea-27f00bf75082","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This API call returns a list of transactions between a specific user and specific remitter. The records contain the the amount sent by the remitter to the user. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This API call returns the real-time exchange rate between two currencies. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This moves funds between wallets of different currencies; monies are exchanged at the instantaneous real-time rate. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This allows a remitter to enable a beneficiary user to send funds to the remitter using the beneficiary’s credit card. Funds are sent to the user account, and then the deposited funds are transferred to the company’s wallet. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This allows a remitter to transfer funds from: \n
The TransferFundWallettoWallet API call may generate a six (6) digit one time password (OTP), and this password is sent to the user from whom funds will be debited. Get the six (6) digit OTP from the user in the application and resubmit the TransferFundWallettoWallet with the OTP included. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This API call returns the list of digital gift cards supported by XTRM for a particular currency. The list has a unique SKU which is used as input to the UserWithdrawFund API call. Digital gift cards are an additional withdraw method of withdrawing funds. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n Digital gift cards are now an an additional option to withdraw funds. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.1 \n05/01/2018\n | \n\n This API call now supports withdrawing funds in digital gift cards. \nTo the request body, add: \n
| \n
There are no schema changes for the 4.1 release.
\nThere are no announcements for the 4.1 release.
\nThere are no new features for the 4.1 release.
\nThere is no changed functionality for the 4.1 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"61f978bb-14ca-46ec-a0ea-27f00bf75082"},{"name":"4.01 Release","id":"2677293b-8037-4db3-994c-e891d6e77ea8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.01 \n02/23/2018\n | \n\n This API call creates a new beneficiary company wallet holding a specific currency. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.01 \n02/23/2018\n | \n\n This API call updates information about an existing wallet. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.01 \n02/23/2018\n | \n\n This API call returns the existing payment options for a beneficiary company. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n4.01 \n02/23/2018\n | \n\n This API call allows a beneficiary company to send (withdraw) funds from their company wallet. \n | \n
There are no changed calls for the 4.01 release.
\nThere are no schema changes for the 4.01 release.
\nThere are no announcements for the 4.01 release.
\nThere are no new features for the 4.01 release.
\nThere is no changed functionality for the 4.01 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2677293b-8037-4db3-994c-e891d6e77ea8"},{"name":"4.0 Release","id":"71c51856-c915-467a-9498-d34f184c5994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"description":"\n| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n ou can get a list of wallet for a particular user. The respone has WalletID, Walletname and WalletCurrency. \n | \n
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n You can get a list of wallet for a particular user. The respone has WalletID, Walletname and WalletCurrency. \n | \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n This allows you to get a list of personal beneficiaries created by you through the API or web. \n | \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n This allows to check if the personal beneficiary exists using email as input. \n | \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n Include WalletType in the response parameter. The value could be Standard or Accrual. \n | \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n Include American Express™ as a possible value to the CreditCardType parameter. \n | \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n Include in the response for a beneficiary company: \n
| \n
| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n Include a one time password (OTP) for every withdrawal. User receives an OTP once this call is invoked. To complete UserWithdrawFund, pass the OTP along with other parameters. \n | \n
There are no schema changes for the 4.0 release.
\nAdded additional security when users withdraw funds in the form of a one time password (OTP).
\nThere are no new features for the 4.0 release.
\n| \n Created Date\n | \n\n Description\n | \n
|---|---|
| \n 4.0 \n 02/10/2018\n | \n \n Include a one time password (OTP) for every withdrawal. User receives an OTP once this call is invoked. To complete UserWithdrawFund, pass the OTP along with other parameters. \n | \n
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call’s change history.
\n| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n3.0 \n07/15/2017\n | \n\n You can get a list of wallet for a particular user. The response has WalletID, Walletname and WalletCurrency. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n3.0 \n07/15/2017\n | \n\n This API call retrieves a list of banks that match the search criteria. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n3.0 \n07/15/2017\n | \n\n This API call retrieves a list of banks withdraw types. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n3.0 \n07/15/2017\n | \n\n Retrieves full beneficiary template information, based on the specified criteria. \n | \n
| \nCreated Date\n | \n\nDescription\n | \n
|---|---|
| \n3.0 \n07/15/2017\n | \n\n This API call allows funding a wallet using a credit card. \n | \n
There are no changed calls for the 3.0 release.
\nThere are no schema changes for the 3.0 release.
\nThere are no announcements for the 3.0 release.
\nThere are no new features for the 3.0 release.
\nThere is no changed functionality for the 3.0 release.
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","name":"API Release Notes","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"4ce852aa-0764-4807-8b94-a0f92a3e0e91"}],"id":"099a5eaf-73c8-4785-9cfa-acfa54ae4150","description":"Xtrm API (XAPI) Documentation
\n
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 apisupport@xtrm.com
\n\nFollow these steps to get going quickly
\n\nFrom 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 addresses are approved, we will fund your sandbox company account with USD and EUR so you can start testing.
\n\nThe 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.
\n\nThe 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.
\n\nOnce your IPs are approved, we will add $250 USD to and 250 of your local currency to two digital wallets in your account.
\n\nVersion | Release Date | Status |
|---|---|---|
V5.0 Nero | Coming Soon | Coming Soon |
V4.92.4 | 11-22-2025 | Live |
V4.92.3 | 10-14-2025 | Live |
V4.92.2 | 06-27-2025 | Live |
V4.92.1 | 04-24-2025 | Live |
V4.92.0 | 02-10-2025 | Live |
V4.91.9 | 01-27-2025 | Live |
V4.91.8 | 08-10-2023 | Live |
V4.91.7 | 04-17-2023 | Live |
V4.91.6 | 02-20-2023 | Live |
V4.91.5 | 12-02-2022 | Live |
V4.91.4 | 11-22-2022 | Live |
V4.91.3 | 08-01-2022 | Live |
V4.91.2 | 05-20-2022 | Live |
V4.91.1 | 04-10-2022 | Live |
V4.91 | 03-29-2022 | Live |
V4.9 | 04-01-2022 | Live |
V4.8 | 12-19-2021 | Live |
V4.7 | 03-05-2021 | Live |
V4.6 | 01-25-2021 | Live |
V4.5 | 11-09-2020 | Live |
V4.4 | 10-10-2020 | Live |
V4.3 | 10-31-2019 | Live |
V4.2 | 03-11-2019 | Live |
V4.1.1 | 11-02-2018 | Live |
V4.1 | 05-01-2018 | Live |
V4.01 | 02-23-2018 | Live |
V4.0 | 02-12-2018 | Live |
V3.0 | 08-20-2017 | Live |
V2.0 | 03-14-2017 | Retired |
V1.0 | 11-02-2016 | Retired |
(Required) always has value password or refresh_token
(Required) XTRM-supplied client id
\n"},{"key":"client_secret","value":"{{xtrm_client_secret}}","description":"(Required) XTRM-supplied client secret
\n"},{"key":"refresh_token","value":"66fa9c8ad2264077ab565aa1e38927b0","description":"only present when renewing a token
\n"}]},"url":"https://xapisandbox.xtrm.com/oAuth/token","description":"This API call has no security; it is the basis of
the bearer authentication. Security is provided by
the use of secure http (https) and the remitter’s
API credentials.
grant_type is either password
to get a new session token, or refresh_token
to renew a session.
The refresh_token is present only when thegrant_type has the value of refresh_token.
access_token expires after thirty minutes
of inactivity. After it expires, neither it nor
the refresh_token are valid.
API Authorization API calls.
\n","auth":{"type":"bearer","bearer":{},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"42cb8aca-6fbd-467f-a184-75ea2acce381","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9fbca6e9-6a0f-4d9b-927a-a27ba39da90d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"9741610f-6bbe-4d94-b6c8-97eae442f1ff"},{"name":"Banks","item":[{"name":"Delete a beneficiary’s linked bank","id":"c5a649d2-25fc-4cad-afa2-48f89213ef14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DeleteBankBeneficiary\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1234567\",\n\t\t\t\"RecipientAccountNumber\": \"SPN1234567\",\n\t\t\t\"BeneficiaryBankID\": \"12e6f8ac19804f90be485045f50ace57\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Bank/DeleteBankBeneficiary","description":"Delete a beneficiary’s linked bank. Get the required BankBeneficiaryID from the GetLinkedBankAccounts or GetACHDebitLinkedBankAccounts API call.
| Parameter | Description | Required |
|---|---|---|
RecipientAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
BeneficiaryBankID | Bank-dependent ID for beneficiary | true |
IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
| Parameter | Description |
|---|---|
BeneficiaryBankID | Bank-dependent ID for beneficiary |
Success | Success or failure of operation (true / false) |
Fetch a list of the Bank debit linked bank accounts (or bank transfers systems analogous to ACH). This is used to fund company wallets using the Bank debit method.
\n| Parameter | Description | Required |
|---|---|---|
RecipientUserId | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
| Parameter | Description |
|---|---|
Success | Success or failure of operation (true / false) |
TransferFee | Fee for transfer |
BankName | Bank Name |
BranchName | Bank branch identifier |
ACHDebitApprovalStatus | optional |
AccountNumber | Bank account numer |
BankBeneficiaryStatus | optional |
BeneficiaryId | Identity code for beneficiary |
BeneficiaryName | A string from 2 to 40 characters in length |
Country | Name of the country, from 1 to 255 characters |
Currency | The three-letter ISO currency code |
EntityID | Entity ID |
Retrieves a list of bank withdrawal types for the bank such as wire, ACH, and similar systems.
\n| Parameter | Description | Required |
|---|---|---|
CountryISO2 | The two-character ISO country abbreviation | true |
IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
| Parameter | Description |
|---|---|
Success | Success or failure of operation (true / false) |
WithdrawTypes | How funds are withdrawn (ACH or WIRE) |
Linking a bank beneficiary may require multiple steps. Different jurisdictions require different or additional pieces of information. The first step involves submitting five always-required pieces of information.
\nIn some cases, additional information may be requested by the bank to complete the linkage depending on its regulatory and compliance environment.\nIn such cases, the initial response may return with a 200 code, and the LinkBankBeneficiary:request:OperationStatus: Success may be false.\nThe Error field will have an ErrorMessage, and report that an additional FieldName and FieldLabel are required (possibly \"RoutingNumber\" and \"Account Number\", respectively.\nThe call is then made a second time, filling out the required field (in this example, the field LinkACHDebitBankBeneficiary:request:Beneficiary:BankDetails:RegulatoryFields).\nUnusual data will be specified as going into RegulatoryFields.
Some currencies will require currency-specific information to remit funds. This follows the two-step process above, specifying what additional data items are required to complete the linkage.
\n| Parameter | Description | Required |
|---|---|---|
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Currency | The three-letter ISO currency code\n | true |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| EntityID | Entity ID\n | false |
| InstitutionName | Name of institution | true |
| Key | AccountType\n | false |
| Value | SVGS\n | false |
| RoutingNumber | Financial institution routing number\n | true |
| SWIFTBIC | SWIFT-BIC routing code\n | true |
| AccountNumber | Institution account identifier\n | true |
| AccountType | AccountType must be with value 'BUSINESS'\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| ContactName | A string from 2 to 40 characters in length\n | true |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| PhoneNumber | A phone number, represented as a string of 1 to 25 characters\n | true |
| PostalCode | ZIP code or other code for mail delivery\n | true |
| Region | Region/State value must be either the 2 letter ISO code or the full state name\n | true |
| AddressLine1 | Street name, number, and other delivery specifics\n | true |
| AddressLine2 | Street name, number, and other delivery specifics\n | false |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| ACHDebitApprovalStatus | Pending, Approved, Declined, etc.\n |
| AccountIdentityLevel | Pending, Approved, Declined, etc.\n |
| BankBeneficiaryStatus | Pending, Approved, Declined, etc.\n |
| BeneficiaryId | Bank-dependent ID for beneficiary\n |
| Success | Success or failure of operation (true / false)\n |
Fetch a list of the beneficiary linked bank accounts. This is used when making direct pass through payments to a beneficiary’s bank account.
\n| Parameter | Description | Required |
|---|---|---|
IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
RecipientUserId | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique Xtrm account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
| Parameter | Description |
|---|---|
EntityID | Entity ID |
TransferFee | Fee for transfer |
ACHDebitApprovalStatus | optional |
AccountNumber | Bank account numer |
BankBeneficiaryStatus | optional |
BankName | Bank Name |
BranchName | Bank branch identifier |
BeneficiaryId | Identity code for beneficiary |
BeneficiaryName | A string from 2 to 40 characters in length |
Country | Name of the country, from 1 to 255 characters |
Currency | The three-letter ISO currency code |
Success | Success or failure of operation (true / false) |
Linking a bank beneficiary may require multiple steps. Different jurisdictions require different or additional pieces of information. The first step involves submitting five always-required pieces of information.
\nIn some cases, additional information may be requested by the bank to complete the linkage depending on its regulatory and compliance environment.\nIn such cases, the initial response may return with a 200 code, and the LinkBankBeneficiary:request:OperationStatus: Success may be false. The Error field will have an ErrorMessage,\nand report that an additional FieldName and FieldLabel are required (possibly \"RoutingNumber\" and \"Account Number\", respectively.\nThe call is then made a second time, filling out the required field (in this example, the field LinkBankBeneficiary:request:Beneficiary:BankDetails:RegulatoryFields).\nUnusual data will be specified as going into RegulatoryFields.
Some currencies will require currency-specific information to remit funds. This follows the two-step process above, specifying what additional data items are required to complete the linkage.
\n| Parameter | Description | Required |
|---|---|---|
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| AddressLine1 | Street name, number, and other delivery specifics\n | true |
| AddressLine2 | Street name, number, and other delivery specifics\n | false |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| ContactName | A string from 2 to 40 characters in length\n | true |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| PhoneNumber | A phone number, represented as a string of 1 to 25 characters\n | true |
| PostalCode | ZIP code or other code for mail delivery\n | true |
| Region | Region/State value must be either the 2 letter ISO code or the full state name\n | true |
| AccountNumber | Institution account identifier\n | true |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| Currency | The three-letter ISO currency code\n | true |
| EntityID | Entity ID\n | false |
| Key | AccountType\n | false |
| Value | SVGS\n | false |
| SWIFTBIC | SWIFT-BIC routing code\n | true |
| InstitutionName | Name of institution | true |
| RoutingNumber | Financial institution routing number\n | true |
| WithdrawType | Financial institution withdraw type (ACH or WIRE)\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| ACHDebitApprovalStatus | Pending, Approved, Declined, etc.\n |
| AccountIdentityLevel | Pending, Approved, Declined, etc.\n |
| BankBeneficiaryStatus | Pending, Approved, Declined, etc.\n |
| BeneficiaryId | Bank’s identifier for customer\n |
| Success | Success or failure of operation (true / false)\n |
This pulls a small amount of currency (on the order of \nUSD $0.05) (a microdeposit) to an\naccount to ensure that XTRM has linked\nthe remitting entity to the correct account.\nOnce the remitting entity has verified that the\nfunds came from the correct account, the \n…/Bank/VerifyACHDebitMicrodeposit API endpoint\nmarks the connection as correct.
XTRM sends all ACH requests immediately. However, \nthe receiving institution may take up to 2 working\ndays to acknowledge and respond to the transaction.
\nXTRM credits the account immediately upon acknowledgement\nof a successful transaction.
\n| Parameter | Description | Required |
|---|---|---|
| BeneficiaryBankID | Identification code for linked bank returned when linking a bank or using GetACHDebitLinkedBankAccounts\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| Message | We have sent micro deposit to your account XXXX6245 successfully\n |
| Success | Success or failure of operation (true / false)\n |
Search banks within a country using SwiftBIC
\n| Parameter | Description | Required |
|---|---|---|
| RecordsToSkip | Page 1-based number of results\n | true |
| RecordsToTake | Number of results per page\n | true |
| SWIFTBIC | SWIFT-BIC routing code\n | true |
| BankCountryISO2 | The two-character ISO country abbreviation\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| CountryName | Country Name |
| RoutingType | Routing Type |
| AddressLine1 | Address line 1 |
| BIC | SwiftBIC |
| BranchCode | Branch Code |
| BranchName | Branch Name |
| NationalId | National Id |
| PostalCode | Postal Code |
| AddressLine2 | Address line 2 |
| AddressLine4 | Address line 4 |
| InstitutionName | Institution Name |
| AddressLine3 | Address line 3 |
| City | City |
| CountryCode | Country Code |
| Success | Success or failure of operation (true / false)\n |
| RecordsToSkip | Page 1-based number of results\n |
| RecordsToTake | Number of results per page\n |
| RecordsTotal | Total number of records to display\n |
Search banks within a country using national id / routing code
\n| Parameter | Description | Required |
|---|---|---|
| BankCountryISO2 | The two-character ISO country abbreviation\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| NationalID | National ID code\n | true |
| RecordsToTake | Number of results per page\n | true |
| RecordsToSkip | Page 1-based number of results\n | true |
| Parameter | Description |
|---|---|
| Success | Success or failure of operation (true / false)\n |
| City | City |
| CountryName | Country Name |
| AddressLine1 | Address line 1 |
| AddressLine2 | Address line 2 |
| AddressLine3 | Address line 3 |
| AddressLine4 | Address line 4 |
| BranchInformation | Branch Information |
| CountryISO2 | Country Code ISO2 |
| InstitutionName | Institution Name |
| PostalCode | Postal Code |
| NationalIdType | A string from one (1) to one hundred (100) characters\n |
| NationalIdentifier | National ID code\n |
Validate IBAN
\n| Parameter | Description | Required |
|---|---|---|
| BankCountryISO2 | The two-character ISO country abbreviation\n | true |
| IBAN | IBAN account number\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| IsValid | True / false\n |
| Success | Success or failure of operation (true / false)\n |
| SWIFTBIC | SWIFT-BIC routing code\n |
This call verifies that the microdeposit pull of \nfunds for a remitting entity came from the correct\naccount, and that the account is correctly linked.
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Amount_1 | An amount representing some value to make micro deposit in string\n | true |
| Amount_2 | An amount representing some value to make micro deposit in string\n | true |
| Parameter | Description |
|---|---|
| Message | We have verified your bank successfully.\n |
| Success | Success or failure of operation (true / false)\n |
API calls dealing with bank connections and information
\n","_postman_id":"69f8caa1-bb38-4684-9ffe-22143aa9c064","auth":{"type":"bearer","bearer":{"token":"{{bearerToken}}"},"isInherited":true,"source":{"_postman_id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","name":"Xtrm 4.92.4 Documentation","type":"collection"}}},{"name":"Cards","item":[{"name":"Delete a beneficiary’s linked Card","id":"ef95675f-f068-4608-874d-6ffdd333ace3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"DeleteCard\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1234567\",\n\t\t\t\"UserID\": \"SPN1234567\",\n\t\t\t\"CardToken\": \"A string of at most fifty (50) characters\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Card/DeleteCard","description":"Delete a beneficiary’s linked Card. Get the required CardBeneficiaryID from the GetLinkedCards API call.
| Parameter | Description | Required |
|---|---|---|
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| CardToken | A string of at most fifty (50) characters | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| CardToken | A string of at most fifty (50) characters |
| Success | Success or failure of operation (true / false)\n |
Fetch a list of the beneficiary linked Card accounts. This is used when making direct pass through payments to a beneficiary’s Card account.
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| userid | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| City | City: Name of the city, from 1 to 25 characters\n |
| EntityID | Entity ID\n |
| PostalCode | ZIP code or other code for mail delivery\n |
| State | The two-character region code abbreviation\n |
| AddressLine1 | Street name, number, and other delivery specifics\n |
| CardType | Identifier or brand of credit card\n |
| Country | The two-character ISO country abbreviation\n |
| CardToken | A string of at most fifty (50) characters |
| LinkCardType | A string from one (1) to one hundred (100) characters\n |
| FirstName | A string of at most fifty (50) characters |
| CardNo | Card number\n |
| ExpMonth | numeric month of year '1' to '12'\n |
| ExpYear | year from 1930 forward through 2999 \n |
| LastName | A string of at most fifty (50) characters |
| NameOnCard | A string from one (1) to one hundred (100) characters\n |
| AddressLine2 | Street name, number, and other delivery specifics\n |
| Success | Success or failure of operation (true / false)\n |
Linking a Card for identity or transfer
\nWhen link card type is transfer then require USD only.
\n| Parameter | Description | Required |
|---|---|---|
| EntityID | Entity ID\n | false |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| LinkCardType | card link type identity or transfer\n | true |
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| State | The two-character region code abbreviation\n | true |
| ExpYear | year from 1930 forward through 2999 \n | true |
| FirstName | A string of at most fifty (50) characters | true |
| LastName | A string of at most fifty (50) characters | true |
| NameOnCard | A string from one (1) to one hundred (100) characters\n | true |
| AddressLine1 | Street name, number, and other delivery specifics\n | true |
| AddressLine2 | Street name, number, and other delivery specifics\n | false |
| CountryCode2 | The two-character ISO country abbreviation\n | true |
| PostalCode | no description | true |
| CardNo | Card number\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| ExpMonth | numeric month of year '1' to '12'\n | true |
| CardType | Identifier or brand of credit card\n | true |
| cvv | Card number\n | true |
| Parameter | Description |
|---|---|
| CardToken | Bank’s identifier for customer\n |
| Success | Success or failure of operation (true / false)\n |
| AccountIdentityLevel | Pending, Approved, Declined, etc.\n |
| CardStatus | Pending, Approved, Declined, etc.\n |
API calls dealing with bank credit/debit cards and information
\n","_postman_id":"7bfaa331-d158-4de5-8bde-a57281d49894","auth":{"type":"bearer","bearer":{"token":"{{bearerToken}}"},"isInherited":true,"source":{"_postman_id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","name":"Xtrm 4.92.4 Documentation","type":"collection"}}},{"name":"Beneficiary Company","item":[{"name":"Check company beneficiary existence","id":"b78ba23f-69dc-4de1-a895-f32de296320e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"CheckBeneficiaryExist\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1234567\",\n\t\t\t\"CompanyName\": \"A longer string up to one hundred (100) characters\",\n\t\t\t\"CompanyEmailDomain\": \"xtrm\",\n\t\t\t\"Pagination\": {\n\t\t\t\t\"RecordsToSkip\": \"1\",\n\t\t\t\t\"RecordsToTake\": \"25\"\n\t\t\t}\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckBeneficiaryExist","description":"Search for existing XTRM account by email address or by company name.
Often, companies have preexisting accounts within the XTRM ecosystem. This API finds all companies matching a particular name, and returns some minimal information about them.
\n| Parameter | Description | Required |
|---|---|---|
| CompanyEmailDomain | Company domain name registered with email\n | false |
| CompanyName | A string from one (1) to one hundred (100) characters\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| RecordsToSkip | Page 1-based number of results\n | true |
| RecordsToTake | Number of results per page\n | true |
| Parameter | Description |
|---|---|
| MasterAdminLastName | A string from 2 to 40 characters in length\n |
| Name | A string from 2 to 40 characters in length\n |
| Status | Status of the beneficiary (Active / Pending)\n |
| AccountIdentityLevel | Identity level of the company\n |
| AccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| A valid email address of 100 characters or less\n | |
| MasterAdminFirstName | A string from 2 to 40 characters in length\n |
| Success | Success or failure of operation (true / false)\n |
Beneficiary companies will be reviewed for\nKYC (Know Your Customer) compliance.\nEnsure that the information is real and accurate.\nDo not create test companies or emails on\nproduction servers.
\n| Parameter | Description | Required |
|---|---|---|
| AdminEmail | A valid email address of 100 characters or less\n | true |
| AdminFirstName | A string from 2 to 40 characters in length\n | true |
| AdminLastName | A string from 2 to 40 characters in length\n | true |
| AdminMobileNumber | A phone number, represented as a string of 1 to 25 characters\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | false |
| EmailNotification | True or false code\n | true |
| Region | A jurisdiction such as state, province, or region\n | false |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| PostalCode | ZIP code or other code for mail delivery\n | false |
| BeneficiaryCompanyName | A string of at most fifty (50) characters | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| SalesforcePartnerID | Salesforce identifier for partner\n | false |
| OtherPartnerID | Other identifying code for partner\n | true |
| PartnerAccountManager | Name of partner’s account manager\n | true |
| PartnerLevel | Partner status or sales level\n | true |
| Region | A jurisdiction such as state, province, or region\n | true |
| WebAddress | A string of at most fifty (50) characters | true |
| Parameter | Description |
|---|---|
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| ClientID | XTRM API User Identifier\n |
| Success | Success or failure of operation (true / false)\n |
| SecretKey | XTRM-supplied secret key\n |
Fetch a list of beneficiaries for the company.
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| RecordsToSkip | Page 1-based number of results\n | true |
| RecordsToTake | Number of results per page\n | true |
| Parameter | Description |
|---|---|
| BeneficiaryAccountIdentityLevel | Identity level of the company\n |
| BeneficiarySalesforceId | Salesforce ID for beneficiary\n |
| OtherPartnerID | Partner’s identification code\n |
| PartnerAccountManager | A string from 2 to 40 characters in length\n |
| Region | A jurisdiction such as state, province, or region\n |
| BeneficiaryCompanyName | Name of company\n |
| BeneficiaryContact | A string from 2 to 40 characters in length\n |
| BeneficiaryEmail | A valid email address of 100 characters or less\n |
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Success | Success or failure of operation (true / false)\n |
| RecordsToSkip | Page 1-based number of results\n |
| RecordsToTake | Number of results per page\n |
| RecordsTotal | Total number of records to display\n |
Fetch a list of entities for the company.
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| RecordsToSkip | Page 1-based number of results\n | true |
| RecordsToTake | Number of results per page\n | true |
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| Success | Success or failure of operation (true / false)\n |
| RecordsToSkip | Page 1-based number of results\n |
| RecordsToTake | Number of results per page\n |
| RecordsTotal | Total number of records to display\n |
| EntityId | Unique ID for entity\n |
| EntityName | Name of the entity\n |
| IsPrimeEntity | Identify the entity is primary\n |
| TotalUsers | Total # of users assigned with the entity\n |
| EntityDescription | Description of the entity\n |
This api call will update beneficiary companies. Beneficiary companies will be reviewed for KYC (Know Your Customer) compliance. Ensure that the information is real and accurate.
\n| Parameter | Description | Required |
|---|---|---|
| WebAddress | URL or other internet resource identifier\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| PostalCode | ZIP code or other code for mail delivery\n | true |
| Region | A jurisdiction such as state, province, or region\n | true |
| AdminFirstName | A string from 2 to 40 characters in length\n | true |
| AdminLastName | A string from 2 to 40 characters in length\n | true |
| BeneficiaryCompanyName | Name of company\n | true |
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| OtherPartnerID | Other identifying code for partner\n | true |
| PartnerAccountManager | Name of partner’s account manager\n | true |
| PartnerLevel | Partner status or sales level\n | true |
| Region | A jurisdiction such as state, province, or region\n | true |
| SalesforcePartnerID | Salesforce identifier for partner\n | false |
| Parameter | Description |
|---|---|
| AccountIdentityLevel | Identity level of the company\n |
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Success | Success or failure of operation (true / false)\n |
This API calls allows you to fill and submit your or your connected company’s Advanced Profile. There are 4 sections in the advanced profile. Business Entity Information, Authorized Contact Information, Director Information, and Ownership Information. If you are completing this form for a US company, you must complete Business Entity Information and Authorized Contact Information; the rest of the sections are not required. If you are completing this form for a non US company, you must complete all the four sections (Business entity, Authorized contact, Director and Ownership information).
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Ticker_Symbol | A string of at most one character | false |
| IsPublicallyTraded | Value must be yes or no\n | true |
| Middle_Name | A string of at most fifty (50) characters | false |
| Postal_Code | ZIP code or other code for mail delivery\n | true |
| Region_Code2 | The two-character region code abbreviation\n | true |
| Country_Code2 | The two-character ISO country abbreviation\n | true |
| First_Name | A string of at most fifty (50) characters | true |
| Job_Title | A string from one (1) to one hundred (100) characters\n | true |
| Date_of_Birth | mm/dd/yyyy, from 1930 forward. The month and day must be two (2) digits, and the year must be four digits.\n | true |
| Email_Address | A valid email address of 100 characters or less\n | true |
| Last_Name | A string of at most fifty (50) characters | true |
| Percentage_Owned | An integer upto 6 characters in length\n | true |
| Address_Line_1 | Street name, number, and other delivery specifics\n | true |
| Citizenship | The two-character ISO country abbreviation\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| Payments_Type | Payments type of the Beneficiary, must be a string with value 'USA Only' or 'International'\n | false |
| Address_Line_1 | Street name, number, and other delivery specifics\n | false |
| Citizenship | The two-character ISO country abbreviation\n | true |
| Country_Code2 | The two-character ISO country abbreviation\n | false |
| First_Name | A string of at most fifty (50) characters | true |
| Job_Title | A string from one (1) to one hundred (100) characters\n | true |
| Postal_Code | A string of at most fifty (50) characters | false |
| Business_Phone | A string of at most fifty (50) characters | true |
| City | A string of at most fifty (50) characters | false |
| Date_Of_Birth | mm/dd/yyyy, from 1930 forward. The month and day must be two (2) digits, and the year must be four digits.\n | true |
| Email_Address | A valid email address of 100 characters or less\n | true |
| Last_Name | A string of at most fifty (50) characters | true |
| Region_Code2 | The two-character region code abbreviation\n | false |
| BeneficiaryAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Company_Type | Company type\n | true |
| Countries_Sending_To | A string from one (1) to one hundred (100) characters\n | false |
| Identification_Type | A string of at most fifty (50) characters | true |
| Industry_Classification | A general taxonomic identification of the business (Accommodation, utilities, etc.)\n | false |
| Postal_Code | ZIP code or other code for mail delivery\n | true |
| Tax_Identification_Number | TaxId: A string such as a US SSN, or some other tax jurisdiction’s identifier, of 100 characters or less.\n | true |
| Address_Line_2 | Street name, number, and other delivery specifics\n | false |
| Address_Line_3 | Street name, number, and other delivery specifics\n | false |
| Country_Of_Incorporation_Code2 | The two-character ISO country abbreviation\n | true |
| Expected_Annual_Volume | An amount representing some value in a specific currency, as a string\n | false |
| Expected_Transaction_Amount | An amount representing some value in a specific currency, as a string\n | false |
| Region_Of_Incorporation_Code2 | The two-character region code abbreviation\n | true |
| Website | URI of the domain | true |
| Address_Line_1 | Street name, number, and other delivery specifics\n | true |
| City | City: Name of the city, from 1 to 25 characters\n | true |
| Expected_Currencies | A string from one (1) to one hundred (100) characters\n | false |
| FictitiousName | Name of company\n | false |
| Identification_Number | A string of at most fifty (50) characters | true |
| Purpose_Of_Transactions | A string from one (1) to one hundred (100) characters\n | true |
| Region_Code2 | The two-character region code abbreviation\n | true |
| Countries_Receiving_From | A string from one (1) to one hundred (100) characters\n | false |
| Country_Code2 | The two-character ISO country abbreviation\n | true |
| Country_Of_Registration_Code2 | The two-character ISO country abbreviation\n | true |
| Parameter | Description |
|---|---|
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Success | Success or failure of operation (true / false)\n |
| message | no description |
This API call is used to get the status of the\nremitter application using company advanced profile.\nThe status would be one of:
\n| Parameter | Description | Required |
|---|---|---|
| BeneficiaryAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| BeneficiaryID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Message | Status is one of Submitted, Pending, or Approved\n |
| Success | Success or failure of operation (true / false)\n |
This API call returns standard company types.
\n| Parameter | Description | Required |
|---|---|---|
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| Parameter | Description |
|---|---|
| CompanyType | The legal structure of the company (Incorporated, Limited Liability Company, etc)\n |
| Success | Success or failure of operation (true / false)\n |
Return the list of countries
\n\n
This request has an empty body
\n| Parameter | Description |
|---|---|
| CountryCode | The two-character ISO country abbreviation\n |
| CountryName | The full name of the country\n |
| Success | Success or failure of operation (true / false)\n |
Fetch a list of standard job titles
\n\n
This request takes an empty request body.
\n| Parameter | Description |
|---|---|
| JobTitle | Typical job title\n |
| Success | Success or failure of operation (true / false)\n |
For a particular country, get the list of\nregions (states, provinces, regions, etc
\n| Parameter | Description | Required |
|---|---|---|
| CountryCode | The two-character ISO country abbreviation\n | false |
| Parameter | Description |
|---|---|
| StateCode | Two letter abbreviation for state\n |
| StateName | Full name of state\n |
| Success | Success or failure of operation (true / false)\n |
This API fetches the advanced profile details for a company for which your account has read access (either your company, or a connected company).
\n| Parameter | Description | Required |
|---|---|---|
| BeneficiaryAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| Countries_Sending_To | A string from one (1) to one hundred (100) characters\n |
| Country_Of_Incorporation_Code2 | The two-character ISO country abbreviation\n |
| Expected_Currencies | A string from one (1) to one hundred (100) characters\n |
| FictitiousName | Name of company\n |
| Industry_Classification | A general taxonomic identification of the business (Accommodation, utilities, etc.)\n |
| Address_Line_2 | Street name, number, and other delivery specifics\n |
| Address_Line_3 | Street name, number, and other delivery specifics\n |
| Countries_Receiving_From | A string from one (1) to one hundred (100) characters\n |
| Region_Code2 | The two-character region code abbreviation\n |
| Tax_Identification_Number | TaxId: A string such as a US SSN, or some other tax jurisdiction’s identifier, of 100 characters or less.\n |
| Expected_Per_Transaction_Amount | An amount representing some value in a specific currency, as a string\n |
| Purpose_Of_Transactions | A string from one (1) to one hundred (100) characters\n |
| Expected_Annual_Volume | An amount representing some value in a specific currency, as a string\n |
| Identification_Number | A string of at most fifty (50) characters |
| Identification_Type | A string of at most fifty (50) characters |
| Region_Of_Incorporation_Code2 | The two-character region code abbreviation\n |
| Website | URI of the domain |
| Address_Line_1 | Street name, number, and other delivery specifics\n |
| City | City: Name of the city, from 1 to 25 characters\n |
| Company_Type | Company type\n |
| Country_Code2 | The two-character ISO country abbreviation\n |
| Postal_Code | ZIP code or other code for mail delivery\n |
| Country_Of_Registration_Code2 | The two-character ISO country abbreviation\n |
| IsPublicallyTraded | Value must be yes or no\n |
| Email_Address | A valid email address of 100 characters or less\n |
| Last_Name | A string of at most fifty (50) characters |
| Percentage_Owned | An integer upto 6 characters in length\n |
| Address_Line_1 | Street name, number, and other delivery specifics\n |
| Citizenship | The two-character ISO country abbreviation\n |
| City | City: Name of the city, from 1 to 25 characters\n |
| Date_of_Birth | mm/dd/yyyy, from 1930 forward. The month and day must be two (2) digits, and the year must be four digits.\n |
| Postal_Code | ZIP code or other code for mail delivery\n |
| Region_Code2 | The two-character region code abbreviation\n |
| Country_Code2 | The two-character ISO country abbreviation\n |
| First_Name | A string of at most fifty (50) characters |
| Job_Title | A string from one (1) to one hundred (100) characters\n |
| Middle_Name | A string of at most fifty (50) characters |
| Ticker_Symbol | A string of at most one character |
| Payments_Type | Type of payment (Personal, credits, debits ...)\n |
| Status | no description |
| Address_Line_1 | Street name, number, and other delivery specifics\n |
| Citizenship | The two-character ISO country abbreviation\n |
| Country_Code2 | The two-character ISO country abbreviation\n |
| First_Name | A string of at most fifty (50) characters |
| Job_Title | A string from one (1) to one hundred (100) characters\n |
| Postal_Code | A string of at most fifty (50) characters |
| Business_Phone | A string of at most fifty (50) characters |
| City | A string of at most fifty (50) characters |
| Date_Of_Birth | mm/dd/yyyy, from 1930 forward. The month and day must be two (2) digits, and the year must be four digits.\n |
| Email_Address | A valid email address of 100 characters or less\n |
| Last_Name | A string of at most fifty (50) characters |
| Region_Code2 | The two-character region code abbreviation\n |
| BeneficiaryAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
Get the list of identification types
\n\n
This request has an empty body
\n| Parameter | Description |
|---|---|
| IdentificationType | Name and nature of the identity document\n |
| Success | Success or failure of operation (true / false)\n |
This API call returns standard industry types
\nThe body consists of the empty JSON object:\n`{ }`
\n| Parameter | Description |
|---|---|
| Industry | A general taxonomic identification of the business (Accommodation, utilities, etc.)\n |
| Success | Success or failure of operation (true / false)\n |
API calls dealing with corporate beneficiaries
\n","_postman_id":"36cc1bb2-8b35-4517-8016-18f2c7f4a0a4","auth":{"type":"bearer","bearer":{"token":"{{bearerToken}}"},"isInherited":true,"source":{"_postman_id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","id":"d8003db3-b4ba-4a4d-b723-9af167bbc895","name":"Xtrm 4.92.4 Documentation","type":"collection"}}},{"name":"Beneficiary User","item":[{"name":"Check beneficiary existence","id":"60387777-e415-4d15-b7b6-a9f00f235372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"CheckUserExist\": {\n\t\t\"request\": {\n\t\t\t\"IssuerAccountNumber\": \"SPN1234567\",\n\t\t\t\"Email\": \"genevieveshefa@xtrm.com\"\n\t\t}\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"https://xapisandbox.xtrm.com/API/v4/Beneficiary/CheckUserExist","description":"This returns some minimal details about a user, if the user exists.
\n| Parameter | Description | Required |
|---|---|---|
| A valid email address of 100 characters or less\n | true | |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| Parameter | Description |
|---|---|
| Success | Success or failure of operation (true / false)\n |
| AccountIdentityLevel | Identity level of the company\n |
| AccountNo | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Country | The two-character ISO country abbreviation\n |
| Employer | Name or type of employer\n |
| Name | A string from 2 to 40 characters in length\n |
| State | A jurisdiction such as state, province, or region\n |
| Status | Status of the beneficiary (Active / Pending)\n |
This allows you to get a list of your personal (non-company) beneficiaries.
\n| Parameter | Description | Required |
|---|---|---|
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| RecordsToSkip | Page 1-based number of results\n | true |
| RecordsToTake | Number of results per page\n | true |
| Parameter | Description |
|---|---|
| Country | Country\n |
| A valid email address of 100 characters or less\n | |
| Employer | Name or type of employer\n |
| Name | A string from 2 to 40 characters in length\n |
| State | A jurisdiction such as state, province, or region\n |
| AccountIdentityLevel | Identity level of the company\n |
| AccountNo | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| Success | Success or failure of operation (true / false)\n |
| RecordsToSkip | Page 1-based number of results\n |
| RecordsToTake | Number of results per page\n |
| RecordsTotal | Total number of records to display\n |
This creates a beneficiary user account where the beneficiary can send and receive all payments. A wallet is also created for the user, holding the currency for the country specified during creation. These will be reviewed for KYC (Know Your Customer) compliance so information submitted must be real and accurate. Do not create test users or emails on production servers.
\n| Parameter | Description | Required |
|---|---|---|
| LegalFirstName | A string from 2 to 40 characters in length\n | true |
| EmailNotification | True or false code\n | true |
| Day | numeric day of month '1' to '31'\n | false |
| Month | numeric month of year '1' to '12'\n | false |
| Year | year from 1930 forward through 2999 \n | false |
| EmailAddress | A valid email address of 100 characters or less\n | true |
| IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n | true |
| LegalLastName | A string from 2 to 40 characters in length\n | true |
| MobilePhone | A phone number, represented as a string of 1 to 25 characters\n | false |
| TaxId | TaxId: A string such as a US SSN, or some other tax jurisdiction’s identifier, of 100 characters or less.\n | false |
| CountryISO2 | The two-character ISO country abbreviation\n | true |
| PostalCode | ZIP code or other code for mail delivery\n | false |
| Region | A jurisdiction such as state, province, or region\n | false |
| AddressLine1 | Street name, number, and other delivery specifics\n | false |
| AddressLine2 | Street name, number, and other delivery specifics\n | false |
| AptSuitNum | Street name, number, and other delivery specifics\n | false |
| City | City: Name of the city, from 1 to 25 characters\n | false |
| Parameter | Description |
|---|---|
| Success | Success or failure of operation (true / false)\n |
| UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries.\n |
| AccountIdentityLevel | Pending, Approved, Declined, etc.\n |
You must be connected to the user account to make updates.
\nIf the user's profile does not have a mobile number, it can be updated without requiring an OTP.
\nIf a mobile number is already saved, updating it will require an OTP, which will be sent to the user's registered mobile number and must be provided for verification.
\n| Parameter | Description | Required |
|---|---|---|
MobileCountryISO2 | The two-character ISO country abbreviation | false |
MobileNumber | A phone number, represented as a string of 1 to 25 characters | false |
OTP | A one-time password string consisting of exactly six digits. | false |
City | City: Name of the city, from 1 to 25 characters | false |
CountryISO2 | The two-character ISO country abbreviation | true |
PostalCode | ZIP code or other code for mail delivery | false |
Region | A jurisdiction such as state, province, or region | false |
AddressLine1 | Street name, number, and other delivery specifics | false |
AddressLine2 | Street name, number, and other delivery specifics | false |
AptSuitNum | Street name, number, and other delivery specifics | false |
Day | numeric day of month '1' to '31' | false |
Month | numeric month of year '1' to '12' | false |
Year | year from 1930 forward through 2999 | false |
LegalLastName | A string from 2 to 40 characters in length | true |
TaxId | TaxId: A string such as a US SSN, or some other tax jurisdiction’s identifier, of 100 characters or less. | false |
UserId | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
IssuerAccountNumber | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries. | true |
LegalFirstName | A string from 2 to 40 characters in length | true |
| Parameter | Description |
|---|---|
AccountIdentityLevel | Pending, Approved, Declined, etc. |
Success | Success or failure of operation (true / false) |
UserID | the AccountID, IssuerAccountNumber, UserID (and possibly some others) is a unique XTRM account identifier, starting with SPN for companies or PAT for individual beneficiaries. |