Show Menu

API Release Notes

Version Release Date Status  
V4.4 Coming Soon Coming Soon  
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  

 

Announcement


Version 4.4


V4.4 will be released soon.


If you have any feedback or requests please email apisupport@xtrm.com

Version 4.3

Index of Changed Calls - 4.3

Schema Changes - 4.3

Announcements - 4.3

New Features - 4.3

Changed Functionality - 4.3

Index of Changed Calls - 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 ACH Debit. To use this API call you have to link an ACH Debit bank using LinkACHDebitBankBeneficiary API call. ACH 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 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, 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 ACH debit linked banks. Those with ACHDebitStatus = 'Apporved' 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

Schema Changes - 4.3

None for this release.

Announcements - 4.3

None for this release.

New Features - 4.3

None for this release.

Changed Functionality - 4.3

None for this release.

Back to top

Version 4.2


If you have any feedback or requests please email apisupport@xtrm.com

Version 4.2

Index of Changed Calls - 4.2

Schema Changes - 4.2

Announcements - 4.2

New Features - 4.2

Changed Functionality - 4.2

Index of Changed Calls - 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 support@xtrm.com 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.

Schema Changes - 4.2

None for this release.

Announcements - 4.2

None for this release.

New Features - 4.2

None for this release.

Changed Functionality - 4.2

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

Index of Changed Calls - 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.

Schema Changes - 4.1.1

None for this release.

Announcements - 4.1.1

None for this release.

New Features - 4.1.1

None for this release.

Changed Functionality - 4.1.1

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

Index of Changed Calls - 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.

Schema Changes - 4.1

None for this release.

Announcements - 4.1

None for this release.

New Features - 4.1

None for this release.

Changed Functionality - 4.1

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

Index of Changed Calls - 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.

Schema Changes - 4.01

None for this release.

Announcements - 4.01

None for this release.

New Features - 4.01

None for this release.

Changed Functionality - 4.01

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

Index of Changed Calls - 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.

Schema Changes - 4.0

None for this release.

Announcements - 4.0

Added more security to withdraw funds.

New Features - 4.0

None for this release.

Changed Functionality - 4.0

  • 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

Index of Changed Calls - 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.

Schema Changes - 3.0

None for this release.

Announcements - 3.0

None for this release.

New Features - 3.0

Changed Functionality - 3.0

None for this release.

Back to top