XTRM
XTRM is a powerful global payment platform powered by an intelligent digital wallet architecture that allows consumers and companies of all sizes to receive, manage and make any type of B2B, B2C, C2C and C2B global payments.
52 subscribers
67 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
XTRM endpoints
| Method | Endpoint | Description |
|---|---|---|
| Authorization | ||
| POST |
newAuthToken /oAuth/token |
## Initial authorization token request 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… |
| Banks | ||
| POST |
GetACHDebitLinkedBankAccounts /Bank/GetACHDebitLinkedBankAccounts |
Fetch a list of the ACH debit linked bank accounts (or bank transfers systems analogous to ACH). This is used to fund company wallets using the ACH debit method. |
| POST |
DeleteBankBeneficiary /Bank/DeleteBankBeneficiary |
Delete a beneficiary’s linked bank. Get the required ``BankBeneficiaryID`` from the ``GetLinkedBankAccounts`` API call. |
| POST |
GetBankWithdrawTypes /Bank/GetBankWithdrawTypes |
Retrieves a list of bank withdrawal types for the bank such as wire, ACH, and similar systems. |
| POST |
LinkACHDebitBankBeneficiary /Bank/LinkACHDebitBankBeneficiary |
Link Beneficiary’s Bank for ACH debit ACH is a specific low-cost currency transfer system in the US and Canada; other countries and regions have similar systems, and this API… |
| POST |
SearchBank /Bank/SearchBank |
Search banks within a country using bank name |
| POST |
GetLinkedBankAccounts /Bank/GetLinkedBankAccounts |
Fetch a list of the beneficiary linked bank accounts. This is used when making direct pass through payments to a beneficiary’s bank account. |
| POST |
LinkBankBeneficiary /Bank/LinkBankBeneficiary |
# Link Bank Beneficiary Linking a bank beneficiary may require multiple steps. Different jurisdictions may require different or additional pieces of information. The first step… |
| Beneficiary Company | ||
| POST |
UpdateBeneficiary /Beneficiary/UpdateBeneficiary |
# THIS CALL LACKS DOCUMENTATION ``/Beneficiary/UpdateBeneficiary`` lacks documentation. |
| POST |
CompanyAdvancedProfileStatus /Register/CompanyAdvancedProfileStatus |
This API call is used to get the status of the remitter application using company advanced profile. The status would be one of: Submitted Pending Approved |
| POST |
CheckBeneficiaryExist /Beneficiary/CheckBeneficiaryExist |
Check to see if an existing email address is associated with an XTRM account Often, companies have preexisting accounts within the XTRM ecosystem. This API finds all companies… |
| POST |
GetCompanyType /Register/GetCompanyType |
This API call returns standard company types. The body consists of the empty JSON object: ``{ }`` |
| POST |
GetAdvancedContactCountry /Register/GetAdvancedContactCountry |
Return the list of countries This request has an empty body |
| POST |
CreateBeneficiary /Beneficiary/CreateBeneficiary |
Create a beneficiary company Beneficary companies will be reviewed for KYC (Know Your Customer) compliance. Ensure that the information is real and accurate. Do not create test… |
| POST |
GetAdvancedContactState /Register/GetAdvancedContactState |
For a particular country, get the list of regions (states, provinces, regions, etc |
| POST |
GetNAICS /Register/GetNAICS |
## Get standard industry job types This API call returns standard industry types The body consists of the empty JSON object: ``{ }`` |
| POST |
GetIdentificationType /Register/GetIdentificationType |
Get the list of identification types This request has an empty body |
| POST |
GetAdvancedContactJobTitles /Register/GetAdvancedContactJobTitles |
Fetch a list of standard job titles   This request takes an empty request body. |
| POST |
GetBeneficiaries /Beneficiary/GetBeneficiaries |
Fetch a list of beneficiaries for the company. |
| Beneficiary User | ||
| POST |
CreateUser /Register/CreateUser |
## Create Beneficiary User Account This creates a beneficiary user account where the beneficiary can send and receive all payments. A wallet is also created for the user, holding… |
| POST |
UpdateUser /Register/UpdateUser |
## Update Beneficiary User Account This will update a user’s beneficiary account or digital wallet. |
| POST |
CheckUserExist /Beneficiary/CheckUserExist |
# Check User Exist This returns some minimal details about a user, if the user exists. |
| POST |
GetPersonalBeneficiaries /Beneficiary/GetPersonalBeneficiaries |
# Get Personal Beneficiaries This allows you to get a list of your personal (non-company) beneficiaries. |
| OTP | ||
| POST |
GetConnectedStatus /OTP/GetConnectedStatus |
This allows you to get the connected status of the remitter and the user or company. If they are not connected, you can use ``GetOTPAuthorizedVendor`` to send a one time password… |
| POST |
ValidateOTPAuthorizeVendor /OTP/ValidateOTPAuthorizeVendor |
This is used to validate the one time password to allow the user to transfer funds and is used in conjunction with ‘Authorize Vendor’ |
| POST |
GetOTPAuthorizedVendor /OTP/GetOTPAuthorizedVendor |
This is used to generate an authentication one time password to allow the vendor (remitter) to be authorized by the user (beneficiary) to transfer funds, access wallets, access… |
| Payment Methods | ||
| POST |
GetUserPaymentMethods /Payment/GetUserPaymentMethods |
# Remitter Payment Methods Choose the payment method. You can pay to the XTRM ‘AnyPay™’ digital wallet (recommended) where the user can choose how to transfer the funds out… |
| POST |
GetPaymentMethods /Payment/GetPaymentMethods |
# Remitter Payment Methods Choose the payment method. You can pay to the XTRM AnyPay™ digital wallet (recommended) where the user can choose how to transfer the funds out of… |
| POST |
GetBeneficiaryCompanyPaymentMethods /Payment/GetBeneficiaryCompanyPaymentMethods |
A beneficiary company may transfer to bank endpoints from their XTRM AnyPay™ digital wallet. The body consists of the empty JSON string: **` { } `** |
| Programs | ||
| POST |
GetPrograms /Programs/GetPrograms |
This allows you to get a list of your company payment programs or projects for use with the Transfer Funds API request. |
| POST |
UpdatePrograms /Programs/UpdatePrograms |
Update your company payment programs or projects |
| POST |
CreateProgram /Programs/CreateProgram |
Fetch a list of your company payment programs or projects for use with the Transfer Funds API request. |
| POST |
ProgramCategory /Programs/ProgramCategory |
Fetch a list of program categories. Used along with the program type to create new programs. |
| POST |
ProgramType /Programs/ProgramType |
Return the available program types |
| Transfer Funds | ||
| POST |
BeneficiaryCompanyWithdrawFund /Fund/BeneficiaryCompanyWithdrawFund |
This allows beneficiary company to transfer funds to their bank from their XTRM ‘AnyPay™’ Digital Wallet. On UserWithdrawFund call an OTP (one time password) is… |
| POST |
TransferFundToCompany /Fund/TransferFundToCompany |
This allows you to make transfers from a company wallet to a beneficiary company wallet, *‘AnyPay&trade’) or pass-through payments to a beneficiaries Bank account or… |
| POST |
TransferFundWalletToWallet /Fund/TransferFundWalletToWallet |
This allows you to transfer funds between wallets in any combination. i.e from a user wallet to company wallet, user wallet to another user wallet, company wallet to user wallet… |
| POST |
TransferFundUsertoCompanyUsingCC /Fund/TransferFundUsertoCompanyUsingCC |
This allows you to receive funds from a beneficiary user using the beneficiary’s credit card. This single call results in two sequential transactions. First, funds are deposited… |
| POST |
GetConnectedCompanyFundRequest /Fund/GetConnectedCompanyFundRequest |
# There is no documentation on this API call. |
| POST |
TransferFundDynamicAccountCreateUser /Fund/TransferFundDynamicAccountCreateUser |
This allows the transfer of funds from a company wallet to a new user or existing user’s wallet. The user is created dynamically if the email id used does not already exist… |
| POST |
GetPrepaidCards /GiftCard/GetPrepaidCards |
NO DOCUMENTATION |
| POST |
GetPrepaidCardDetails /GiftCard/GetPrepaidCardDetails |
NO DOCUMENTATION |
| POST |
TransferFund /Fund/TransferFund |
This allows you to make transfers from a company wallet to a beneficiary user wallet, (AnyPay™) or pass-through payments to a beneficiaries Bank account or Prepaid Virtual Visa.… |
| POST |
GetDigitalGiftCards /GiftCard/GetDigitalGiftCards |
Gets the list of digital gift cards supported by XTRM. The list has a unique SKU which is used as input to the `userwithdrawfund` API call. Digital Gift Card is added as an… |
| POST |
GetGiftCardDetails /GiftCard/GetGiftCardDetails |
Gets the specifics of a gift card supported by XTRM. The list has a unique SKU which is used as input to the `userwithdrawfund` API call. |
| POST |
UserWithdrawFund /Fund/UserWithdrawFund |
This allows beneficiary to withdraw funds using one of the payment methods from their XTRM 'AnyPay™' Digital Wallet. On UserWithdrawFund call a 6 digit one time password (OTP) is… |
| Wallets | ||
| POST |
FundCompanyWalletUsingCreditCard /Wallet/FundCompanyWalletUsingCreditCard |
companies may fund their own company wallets using the company’s own credit card. ** *Please note:* This call is not intended to take payments from consumers; it meant only for… |
| POST |
UpdateCompanyWallet /Wallet/UpdateCompanyWallet |
Change the name of a company’s wallet. The other elements of a wallet (the `WalletID` and currency) cannot be changed. |
| POST |
GetBeneficiaryWallets /Wallet/GetBeneficiaryWallets |
Fetch the wallets belonging to a beneficiary |
| POST |
CreateBeneficiaryCompanyWallet /Wallet/CreateBeneficiaryCompanyWallet |
create beneficiary company wallets and specify the currency |
+ 17 more endpoints on the provider's documentation.
XTRM pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
