API Release Notes

 

Announcement

Version 4.9

V4.9 will be released soon.

If you have any feedback or requests please email [email protected]

Version 4.8

Index of Changed Calls - 4.8

Schema Changes - 4.8

Announcements - 4.8

New Features - 4.8

Changed Functionality - 4.8

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.

New Calls

• None for this release.

Changed Calls

• TransferFund

  Created Date	Description
  4.8 09/30/2021	Added check direct to this API call. New fields related to check are included and can be found the in api document.

• TransferFundtoCompany

  Created Date	Description
  4.8 09/30/2021	Added check direct to this API call. New fields related to check are included and can be found the in api document.

• UserWithdrawFund

  Created Date	Description
  4.8 09/30/2021	Added two optional parameters (SendTransferCodetoEmail, SendTransferCodetoMobile) to receive one time transfer verification code to this API call. One of the parameter have to be true.

• BeneficiaryCompanyWithdrawFund

  Created Date	Description
  4.8 09/30/2021	Added two optional parameters (SendTransferCodetoEmail, SendTransferCodetoMobile) to receive one time transfer verification code to this API call. One of the parameter have to be true.

• CompanyAdvancedProfile

  Created Date	Description
  4.8 09/30/2021	Modified director and owner parameters to array.

• GetCompanyAdvancedProfileDetails

  Created Date	Description
  4.8 09/30/2021	Modified director and owner parameters to array.

• GetPaymentMethods

  Created Date	Description
  4.8 09/30/2021	Added Check as option to send check directly to Individual and Companies. Can be used to send check in US and Canada.

None for this release.

None for this release.

None for this release.

None for this release.

Version 4.7

Index of Changed Calls - 4.7

Schema Changes - 4.7

Announcements - 4.7

New Features - 4.7

Changed Functionality - 4.7

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.

New Calls

• None for this release.

Changed Calls

• GetUserWalletTransactionDetails

  Created Date	Description
  4.7 03/05/2021	Added UserID as a mandatory field to restrict the API to return transaction details of the given user id and transaction id.

None for this release.

None for this release.

None for this release.

None for this release.

Version 4.6

Index of Changed Calls - 4.6

Schema Changes - 4.6

Announcements - 4.6

New Features - 4.6

Changed Functionality - 4.6

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.

New Calls

• GetUserWalletTransactionDetails

  Created Date	Description
  4.6 01/25/2021	This API call gives details of a user wallet transaction using transaction id from GetUserWalletTransactions.

• GetConnectedStatus

  Created Date	Description
  4.6 01/25/2021	This API call gives the connected status between the connected manager and a user or company.

• SearchBank

  Created Date	Description
  4.6 01/25/2021	This API call allows you to search a bank within a country.

Changed Calls

• TransferFund

  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 GetDigitalGiftCards API. 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.

• UserWithdrawFund

  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.

None for this release.

None for this release.

None for this release.

None for this release.

Version 4.5

Index of Changed Calls - 4.5

Schema Changes - 4.5

Announcements - 4.5

New Features - 4.5

Changed Functionality - 4.5

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.

New Calls

• DeleteBankBeneficiary

  Created Date	Description
  4.5 11/09/2020	This API call to delete a linked bank account of a beneficiary.

Changed Calls

None for this release.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.44

Index of Changed Calls - 4.4

Schema Changes - 4.4

Announcements - 4.4

New Features - 4.4

Changed Functionality - 4.4

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.

New Calls

• CompanyAdvancedProfile

  Created Date

  Description

  4.4 10/10/2020

  TThis API calls allows your to fill and submit your or your connected company's Advanced Profile. There are 3 sections in the advanced profile. Business Entity Informations, Authorized Contact Information, Director Information, Ownership Information. If you are completing this form for a US company, you have to complete Business Entity Information and Authorized Contact Information rest of the sections are not required. If you are completing this form for a non US company, you have to complete all the four sections (Business entity, Authorized contact, Director and Ownership information).

• CompanyAdvancedProfileStatus

  Created Date	Description
  4.4 10/10/2020	This API call is used to get the status of the remitter application using company advanced profile. The status would be one of these Submitted, Pending or Approved.

• GetAdvancedContactCountry

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of country name and country code.

• GetAdvancedContactState

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of state/county/region and its code.

• GetCompanyType

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of company types.

• GetIdentificationType

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of identification types.

• GetNAICS

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of industry types.

• GetAdvancedContactJobTitles

  Created Date	Description
  4.4 10/10/2020	This API calls will get you the list of job titles.

Changed Calls

• None for this release.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.3

Index of Changed Calls - 4.3

Schema Changes - 4.3

Announcements - 4.3

New Features - 4.3

Changed Functionality - 4.3

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.

New Calls

• FundWalletUsingACHDebit

  Created Date	Description
  4.3 10/15/2019	This API call is used to fund a company wallet using Bank Debit. To use this API call you have to link a Bank Debit using LinkACHDebitBankBeneficiary API call. Bank Debit funding is not instant, it will take 3 to 5 business days to reflect in your company wallet.

• LinkACHDebitBankBeneficiary

  Created Date

  Description

  4.3 10/15/2019

  This API call is used to link a Bank Debit for approval. Once the linked bank is approved for Bank 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, CountryISO2). On posting with these details to the API call you will get a response with additional fields required. The response will include Field name and Field Label. Field Name is the additional parameter name in the API call. Field Label is the Label to be displayed to your users to get additional information.

• GetACHDebitLinkedBankAccounts

  Created Date	Description
  4.3 10/15/2019	This API call will get all the Bank Debit linked banks. Those with ACHDebitStatus = 'Approved' can be used to fund your company wallet using FundWalletUsingACHDebit API call.

Changed Calls

• CreateUser

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

• UpdateUser

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

• GetPersonalBeneficiaries

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

• CreateBeneficiary

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

• UpdateBeneficiary

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

• GetBeneficiaries

  Change Date	Description
  4.3 10/15/2019	Added 'BeneficiaryAccountIdentityLevel' in the response object

• LinkBankBeneficiary

  Change Date	Description
  4.3 10/15/2019	Added 'AccountIdentityLevel' in the response object

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.2

If you have any feedback or requests please email [email protected]

Version 3.0 will be discontinued with effect from May 2018.

Version 4.2

Index of Changed Calls - 4.2

Schema Changes - 4.2

Announcements - 4.2

New Features - 4.2

Changed Functionality - 4.2

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.

New Calls

• FundUsertoUserWalletUsingCreditCard

  Created Date	Description
  4.2 02/15/2019	This API call is used to fund a user wallet using Credit Card. This API calls requires special access rights and would not function without them. Please contact [email protected] to get access to this API call.

• LinkBankBeneficiary

  Created Date

  Description

  4.2 02/15/2019

  This API call will replace the previous API call(CreateBankBeneficiary) to link a bank. 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, CountryISO2). On posting with these details to the API call you will get a response with additional fields required. The response will include Field name and Field Label. Field Name is the additional parameter name in the API call. Field Label is the Label to be displayed to your users to get additional information.

• GetGiftCardDetails

  Created Date	Description
  4.2 02/15/2019	This API call is your to get detailed information of a selected digital gift card sku.

Changed Calls

• CreateBankBeneficiary

  Change Date	Description
  4.2 02/15/2019	CreateBankBeneficiary API is replaced with LinkBankBeneficiary API.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.1.1

Index of Changed Calls - 4.1.1

Schema Changes - 4.1.1

Announcements - 4.1.1

New Features - 4.1.1

Changed Functionality - 4.1.1

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.

New Calls

None for this release.

Changed Calls

• CreateBankBeneficiary

  Change Date	Description
  4.1.1 11/02/2018	Included AddressLine2, City, Region/State/County, PostalCode under BeneficiaryDetails and AddressLine1, CountryISO2 under BankDetails. Included AccountIdentityLevel in the Response.

• CreateUser

  Change Date	Description
  4.1.1 11/02/2018	Included AccountIdentityLevel in the Response.

• UpdateUser

  Change Date	Description
  4.1.1 11/02/2018	Included AccountIdentityLevel in the Response.

• CreateBeneficiary

  Change Date	Description
  4.1.1 11/02/2018	Included AccountIdentityLevel in the Response.

• UpdateBeneficiary

  Change Date	Description
  4.1.1 11/02/2018	Included AccountIdentityLevel in the Response.

• TransferFund

  Change Date	Description
  4.1.1 11/02/2018	Included Amount, Fee, TotalAmount, Currency in the Response.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.1

Index of Changed Calls - 4.1

Schema Changes - 4.1

Announcements - 4.1

New Features - 4.1

Changed Functionality - 4.1

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.

New Calls

• GetUserWalletTransactionsByRemitter

  Change Date	Description
  4.1 05/29/2018	This call allows you to get list of transactions of a specific user and remitter. Records will contain amount sent by the remitter to the user.

• GetExchangeRate

  Change Date	Description
  4.1 05/01/2018	This allows you to get exchange rate between two currencies.

• BookExchange

  Change Date	Description
  4.1 05/01/2018	This allows to move fund from one currency wallet to a different currency wallet.

• TransferFundUsertoCompanyUsingCC

  Change Date	Description
  4.1 05/01/2018	This allows you to receive fund from a beneficiary user using their Credit Card. It is a two step process. Fund is deposited in user account followed by sending the deposited fund to the company wallet. a

• TransferFundWallettoWallet

  Change Date

  Description

  4.1 05/01/2018

  This allows you to transfer fund from a user wallet to company wallet, user wallet to another user wallet, company wallet to user wallet, company wallet ot another company wallet. On TransferFundWallettoWallet call a 6 digit one time password(OTP) is generated and sent to user from whom the fund is going to debited. Get the 6 digit OTP value from the user in your application and resubmit TransferFundWallettoWallet with OTP included.

• GetDigitalGiftCards

  Change Date	Description
  4.1 05/01/2018	This allows to get the list of digital gift cards supported by XTRM. The list has a unique SKU which is used as input the the userwithdrawfund API call. Digital Gift Card is added an additional withdraw method for the user.

Changed Calls

• GetUserPaymentMethods

  Change Date	Description
  4.1 05/01/2018	Digital Gift Card is included as an additional withdraw fund option for the users only.

• UserWithdrawFund

  Change Date	Description
  4.1 05/01/2018	Included UserGiftCardEmailID as an input parameter to withdraw user fund to digital gift card. Included sku as an input parameter to refer the unique Digital Gift Card.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.01

Index of Changed Calls - 4.01

Schema Changes - 4.01

Announcements - 4.01

New Features - 4.01

Changed Functionality - 4.01

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.

New Calls

• CreateBeneficiaryCompanyWallet

  Change Date	Description
  4.01 02/23/2018	This allows you to create beneficiary company wallets and specify wallet currency.

• UpdateBeneficiarycompanywallet

  Change Date	Description
  4.01 02/23/2018	You can update beneficiary company wallet details.

• GetBeneficiaryCompanyPaymentMethods

  Change Date	Description
  4.01 02/23/2018	A Beneficiary Company can transfer to end points Bank from their XTRM 'AnyPay™' digital wallet.

• BeneficiaryCompanyWithdrawFund

  Change Date	Description
  4.01 02/23/2018	This allows beneficiary company to withdraw funds to their Bank from their XTRM 'AnyPay™' Digital Wallet. On UserWithdrawFund call a 6 digit one time password(OTP) is generated and sent to user. Get the 6 digit OTP value from the user in your application and resubmit UserWithdrawFund with OTP included.

Changed Calls

None for this release.

None for this release.

None for this release.

None for this release.

None for this release.

Back to top

Version 4.0

Index of Changed Calls - 4.0

Schema Changes - 4.0

Announcements - 4.0

New Features - 4.0

Changed Functionality - 4.0

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.

New Calls

• GetUserWallet

  Change Date	Description
  4.0 02/10/2018	You can get a list of wallet for a particular user. The respone has WalletID, Walletname and WalletCurrency.

• GetPersonalBeneficiaries

  Change Date	Description
  4.0 02/10/2018	This allows you to get a list of your Personal beneficiaries created by you through API or Web.

• CheckUserExist

  Change Date	Description
  4.0 02/10/2018	This allows to check if the personal beneficiary exists using email as input.

Changed Calls

• GetCompanywallets

  Change Date	Description
  4.0 02/10/2018	Included Wallettype in the response parameter. The value could be Standard or Accrual.

• FundCompanyWalletUsingCreditCard

  Change Date	Description
  4.0 02/10/2018	Included Amex Card as one of the value to CreditCardType paramter.

• CheckBeneficiaryExist

  Change Date	Description
  4.0 02/10/2018	Included Email, Masteradmin Firstname and Masteradmin Lastname of the beneficiary company.

• UserWithdrawFund

  Change Date	Description
  4.0 02/10/2018	Included One Time Password for every withdraw. User receives an OTP once this call is invoked. To complete withdrawfund you have to pass the OTP along with other parameters.

None for this release.

Added more security to withdraw funds.

None for this release.

• UserWithdrawFund

  Change Date	Description
  4.0 02/10/2018	Included One Time Password for every withdraw. User receives an OTP once this call is invoked. To complete withdrawfund you have to pass the OTP along with other parameters.

Back to top

Version 3.0

Index of Changed Calls - 3.0

Schema Changes - 3.0

Announcements - 3.0

New Features - 3.0

Changed Functionality - 3.0

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.

New Calls

• GetLinkedBankAccounts

  Change Date	Description
  3.0 07/15/2017	You can get a list of wallet for a particular user. The respone has WalletID, Walletname and WalletCurrency.

• SearchBank

  Change Date	Description
  3.0 07/15/2017	Retrieves a list of banks that match the search criteria.

• GetBankWithdrawTypes

  Change Date	Description
  3.0 07/15/2017	Retrieves a list of banks withdraw types.

• GetBankDynamicValidationRules

  Change Date	Description
  3.0 07/15/2017	Retrieves full beneficiary template information, based on the specified criteria.

• CreateBankBeneficiary

  Change Date	Description
  3.0 07/15/2017	A structure that contains the information needed to create a new beneficiary template.

• FundCompanyWalletUsingCreditCard

  Change Date	Description
  3.0 07/15/2017	This call allows you to fund a wallet using credit card.

Changed Calls

None for this release.

None for this release.

None for this release.

None for this release.

Back to top