The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here
NPM is installed by default when Node is installed
To check if node and npm have been successfully installed, write the following commands in command prompt:
node --versionnpm -versionNow use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):
npm install
This will install all dependencies in the node_modules folder.
Once dependencies are resolved, you will need to move the folder SWAPXRESTB2BAPILib in to your node_modules folder.
The following section explains how to use the library in a new project.
Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
Click on File and select Open Folder.
Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.
Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:
var lib = require('lib');
Save changes.
To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:
node index.js
These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:
mocha --recursive to run all the tests.../test/Controllers/ directory from command prompt.mocha * to run all the tests.../test/Controllers/ directory from command prompt.mocha SWAPX REST B2B APIController to run all the tests in that controller file.To increase mocha's default timeout, you can change the
TEST_TIMEOUTparameter's value inTestBootstrap.js.
API client can be initialized as following:
const lib = require('lib');
BankingControllerThe singleton instance of the BankingController class can be accessed from the API Client.
var controller = lib.BankingController;
getBankingCreateAccountCreate a GBP and EUR account for the user
function getBankingCreateAccount(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The ID of the user |
var userId = uniqid();
controller.getBankingCreateAccount(userId, function(error, response, context) {
});
Get all accounts for a user
function getBankingGetUserAccounts(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getBankingGetUserAccounts(userId, function(error, response, context) {
});
Block all accounts for a user
function getBankingBlockUserAccounts(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getBankingBlockUserAccounts(userId, function(error, response, context) {
});
Unblock all accounts for a user
function getBankingUnblockUserAccounts(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getBankingUnblockUserAccounts(userId, function(error, response, context) {
});
Make a payment from a Lerex bank account to a beneficiary
function createBankingMakePayment(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | the model |
var input = new SwapXRESTB2BModelsBanksBankingPaymentModel({"key":"value"});
controller.createBankingMakePayment(input, function(error, response, context) {
});
Get all accounts
function getBankingGetAllCard(callback)
controller.getBankingGetAllCard(function(error, response, context) {
});
Close an account - this is not reversible
function deleteBankingCloseAccount(userId, accountId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The ID of the user. |
| accountId | Required | The account ID to terminate (for security reason). |
var userId = uniqid();
var accountId = uniqid();
controller.deleteBankingCloseAccount(userId, accountId, function(error, response, context) {
});
The singleton instance of the CardsController class can be accessed from the API Client.
var controller = lib.CardsController;
Get a card
function getCardsGetCard(cardId, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card to retrieve |
var cardId = 7;
controller.getCardsGetCard(cardId, function(error, response, context) {
});
Get all cards
function getCardsGetAllCard(callback)
controller.getCardsGetAllCard(function(error, response, context) {
});
Order a new Card
function getCardsOrderCard(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The ID of the user to order a card for |
var userId = uniqid();
controller.getCardsOrderCard(userId, function(error, response, context) {
});
Order a new Card with the ability to set PIN and design
function createCardsOrderCardWithPIN(model, callback)
| Parameter | Tags | Description |
|---|---|---|
| model | Required | The model. |
var model = new SwapXRESTB2BModelsCardsOrderCardModel({"key":"value"});
controller.createCardsOrderCardWithPIN(model, function(error, response, context) {
});
Get all active card holders
function getCardsGetCardsHolder(callback)
controller.getCardsGetCardsHolder(function(error, response, context) {
});
Activate a card
function getCardsActivateCard(cardId, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card to activate. |
var cardId = 7;
controller.getCardsActivateCard(cardId, function(error, response, context) {
});
Change the card PIN
function getCardsSavePin(cardId, userId, pin, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card to send the PIN of. |
| userId | Required | The ID of the card user (for security reason) |
| pin | Required | The new 4 digits PIN code |
var cardId = 7;
var userId = uniqid();
var pin = 'pin';
controller.getCardsSavePin(cardId, userId, pin, function(error, response, context) {
});
Unblock the card PIN
function getCardsUnblockPin(cardId, userId, pin, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card to send the PIN of. |
| userId | Required | The ID of the card user (for security reason) |
| pin | Required | TODO: Add a parameter description |
var cardId = 7;
var userId = uniqid();
var pin = 'pin';
controller.getCardsUnblockPin(cardId, userId, pin, function(error, response, context) {
});
Get the card PIN
function getCardsGetPin(cardId, userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card |
| userId | Required | The ID of the card user (for security reason) |
var cardId = 7;
var userId = uniqid();
controller.getCardsGetPin(cardId, userId, function(error, response, context) {
});
Get the list of Merchant Category Codes which are blocked
function getCardsGetUserCardConfiguration(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getCardsGetUserCardConfiguration(userId, function(error, response, context) {
});
Create/Update the list of Merchant Category Codes which are blocked
function createCardsSetUserCardConfiguration(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | TODO: Add a parameter description |
var input = new SwapXRESTB2BModelsCardsBlockMccCardRequestModel({"key":"value"});
controller.createCardsSetUserCardConfiguration(input, function(error, response, context) {
});
Block the user card
function getCardsBlockCardByUser(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getCardsBlockCardByUser(userId, function(error, response, context) {
});
Unblock the user card
function getCardsUnblockCardByUser(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getCardsUnblockCardByUser(userId, function(error, response, context) {
});
Cancel / delete a card - this is not reversible
function deleteCardsCancelCard(cardId, userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| cardId | Required | The ID of the card to activate. |
| userId | Required | The ID of the card user (for security reason). |
var cardId = 7;
var userId = uniqid();
controller.deleteCardsCancelCard(cardId, userId, function(error, response, context) {
});
Allow to get the full card PAN (encrypted)
function createCardsGetCardFullPAN(model, callback)
| Parameter | Tags | Description |
|---|---|---|
| model | Required | The request model. |
var model = new SwapXRESTB2BModelsCardsCardFullPANRequestModel({"key":"value"});
controller.createCardsGetCardFullPAN(model, function(error, response, context) {
});
The singleton instance of the CurrenciesController class can be accessed from the API Client.
var controller = lib.CurrenciesController;
Get currency
function getCurrenciesGetCurrenciesById(id, callback)
| Parameter | Tags | Description |
|---|---|---|
| id | Required | TODO: Add a parameter description |
var id = 7;
controller.getCurrenciesGetCurrenciesById(id, function(error, response, context) {
});
Get all currencies.
function getCurrenciesGetAllCurrencies(callback)
controller.getCurrenciesGetAllCurrencies(function(error, response, context) {
});
Get currencies by ISO code
function getCurrenciesGetCurrenciesByName(code, callback)
| Parameter | Tags | Description |
|---|---|---|
| code | Required | TODO: Add a parameter description |
var code = 'code';
controller.getCurrenciesGetCurrenciesByName(code, function(error, response, context) {
});
Get all currencies which are available as a wallet
function getCurrenciesGetAvailableWallet(callback)
controller.getCurrenciesGetAvailableWallet(function(error, response, context) {
});
Get rate and fee for buy currency
function getCurrenciesGetRateAndFeeByCurrencies(sellCurrencyCode, buyCurrencyCode, callback)
| Parameter | Tags | Description |
|---|---|---|
| sellCurrencyCode | Required | The ISO code of the currency to sell. |
| buyCurrencyCode | Required | The ISO code of the currency to buy. |
var sellCurrencyCode = 'sellCurrencyCode';
var buyCurrencyCode = 'buyCurrencyCode';
controller.getCurrenciesGetRateAndFeeByCurrencies(sellCurrencyCode, buyCurrencyCode, function(error, response, context) {
});
Get all currencies with their rate
function getCurrenciesGetAllRatesToGbp(callback)
controller.getCurrenciesGetAllRatesToGbp(function(error, response, context) {
});
The singleton instance of the FXOrderController class can be accessed from the API Client.
var controller = lib.FXOrderController;
Get exchange rate from quote request
function getFXOrderGetQuote(baseCurrencyId, baseAmount, targetCurrencyId, buySell, callback)
| Parameter | Tags | Description |
|---|---|---|
| baseCurrencyId | Required | TODO: Add a parameter description |
| baseAmount | Required | TODO: Add a parameter description |
| targetCurrencyId | Required | TODO: Add a parameter description |
| buySell | Required | TODO: Add a parameter description |
var baseCurrencyId = 7;
var baseAmount = 7.23211333725234;
var targetCurrencyId = 7;
var buySell = 7;
controller.getFXOrderGetQuote(baseCurrencyId, baseAmount, targetCurrencyId, buySell, function(error, response, context) {
});
Execute a quote
function getFXOrderExecuteQuote(quoteId, memo, callback)
| Parameter | Tags | Description |
|---|---|---|
| quoteId | Required | TODO: Add a parameter description |
| memo | Required | TODO: Add a parameter description |
var quoteId = uniqid();
var memo = 'memo';
controller.getFXOrderExecuteQuote(quoteId, memo, function(error, response, context) {
});
Retrieve all past and pending FX Orders
function getFXOrderGetAll(quoteId, memo, callback)
| Parameter | Tags | Description |
|---|---|---|
| quoteId | Required | TODO: Add a parameter description |
| memo | Required | TODO: Add a parameter description |
var quoteId = uniqid();
var memo = 'memo';
controller.getFXOrderGetAll(quoteId, memo, function(error, response, context) {
});
The singleton instance of the HealthCheckController class can be accessed from the API Client.
var controller = lib.HealthCheckController;
An Endpoint for API Health Checking
function getHealthCheckCheck(callback)
controller.getHealthCheckCheck(function(error, response, context) {
});
The singleton instance of the InsuranceManagementController class can be accessed from the API Client.
var controller = lib.InsuranceManagementController;
Update an insurance user
function updateInsuranceManagementUpdateUser(userToUpdate, callback)
| Parameter | Tags | Description |
|---|---|---|
| userToUpdate | Required | User to update |
var userToUpdate = new SwapXRESTB2BModelsInsuranceRestUpdatePolicyHolderModel({"key":"value"});
controller.updateInsuranceManagementUpdateUser(userToUpdate, function(error, response, context) {
});
Add an insurance user
function createInsuranceManagementAddUser(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | User to add |
var input = new SwapXRESTB2BModelsUserRestAddPolicyHolderModel({"key":"value"});
controller.createInsuranceManagementAddUser(input, function(error, response, context) {
});
Gets list of users.
function getInsuranceManagementGetListUsersRest(searchTerm, pageNumber, pageSize, sortBy, orderBy, callback)
| Parameter | Tags | Description |
|---|---|---|
| searchTerm | Required | The search term. |
| pageNumber | Required | The page number. |
| pageSize | Required | Size of the page. |
| sortBy | Optional | The sort by. |
| orderBy | Optional | The order by. |
var searchTerm = 'searchTerm';
var pageNumber = 7;
var pageSize = 7;
var sortBy = Object.keys(sortBy)[0];
var orderBy = Object.keys(orderBy)[0];
controller.getInsuranceManagementGetListUsersRest(searchTerm, pageNumber, pageSize, sortBy, orderBy, function(error, response, context) {
});
Update policy.
function updateInsuranceManagementUpdatePolicy(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | Update policy |
var input = new SwapXRESTB2BModelsUserRestUpdatePolicy({"key":"value"});
controller.updateInsuranceManagementUpdatePolicy(input, function(error, response, context) {
});
Create certificate information.
function createInsuranceManagementPostCertificateInfo(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | The value to post. |
var input = new SwapXRESTB2BModelsUserRestAddPolicy({"key":"value"});
controller.createInsuranceManagementPostCertificateInfo(input, function(error, response, context) {
});
The singleton instance of the OrganisationController class can be accessed from the API Client.
var controller = lib.OrganisationController;
Get organisation account details
function getOrganisationGetOrganisationDetails(callback)
controller.getOrganisationGetOrganisationDetails(function(error, response, context) {
});
Get organisation wallet details
function getOrganisationGetWalletAmounts(callback)
controller.getOrganisationGetWalletAmounts(function(error, response, context) {
});
Create a new deposit
function createOrganisationAddDeposit(model, callback)
| Parameter | Tags | Description |
|---|---|---|
| model | Required | TODO: Add a parameter description |
var model = new SwapXRESTB2BModelsBanksAddDepositViewModel({"key":"value"});
controller.createOrganisationAddDeposit(model, function(error, response, context) {
});
| Error Code | Error Description |
|---|---|
| 400 | BadRequest |
StaticDataControllerThe singleton instance of the StaticDataController class can be accessed from the API Client.
var controller = lib.StaticDataController;
Get all countries
function getStaticDataGetAllCountries(callback)
controller.getStaticDataGetAllCountries(function(error, response, context) {
});
Get all transaction types
function getStaticDataGetAllTransactionTypes(callback)
controller.getStaticDataGetAllTransactionTypes(function(error, response, context) {
});
Get all transaction statuses
function getStaticDataGetAllTransactionStatuses(callback)
controller.getStaticDataGetAllTransactionStatuses(function(error, response, context) {
});
Get all card statuses
function getStaticDataGetAllCardStatuses(callback)
controller.getStaticDataGetAllCardStatuses(function(error, response, context) {
});
Get all KYC statuses
function getStaticDataGetAllKYCStatuses(callback)
controller.getStaticDataGetAllKYCStatuses(function(error, response, context) {
});
Get all bank account statuses
function getStaticDataGetAllBankAccountStatuses(callback)
controller.getStaticDataGetAllBankAccountStatuses(function(error, response, context) {
});
The singleton instance of the SubscriptionController class can be accessed from the API Client.
var controller = lib.SubscriptionController;
Subscribe to transaction activity
function getSubscriptionGetTransactionSubscription(callback)
controller.getSubscriptionGetTransactionSubscription(function(error, response, context) {
});
Subscribe to load activity
function getSubscriptionGetLoadSubscription(callback)
controller.getSubscriptionGetLoadSubscription(function(error, response, context) {
});
Subscribe to rejected transactions activity
function getSubscriptionGetRejectSubscription(callback)
controller.getSubscriptionGetRejectSubscription(function(error, response, context) {
});
The singleton instance of the TransactionsController class can be accessed from the API Client.
var controller = lib.TransactionsController;
Get organisation activity (all fields are optional and used for filtering)
function getTransactionsGetUserActivity(userId, currencyId, filter, pageSize, page, startDate, endDate, sortBy, orderBy, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Optional | userId |
| currencyId | Optional | CurrencyId |
| filter | Optional | Filter keyword |
| pageSize | Optional | Record per page |
| page | Optional | Page index |
| startDate | Optional | From date |
| endDate | Optional | To date |
| sortBy | Optional | The sort by. |
| orderBy | Optional | The order by. |
var userId = uniqid();
var currencyId = 7;
var filter = 'filter';
var pageSize = 7;
var page = 7;
var startDate = date("D M d, Y G:i");
var endDate = date("D M d, Y G:i");
var sortBy = Object.keys(sortBy1)[0];
var orderBy = Object.keys(orderBy)[0];
controller.getTransactionsGetUserActivity(userId, currencyId, filter, pageSize, page, startDate, endDate, sortBy, orderBy, function(error, response, context) {
});
Get details for a given transaction
function getTransactionsTransactionDetail(id, callback)
| Parameter | Tags | Description |
|---|---|---|
| id | Required | The transaction identifier. |
var id = 7;
controller.getTransactionsTransactionDetail(id, function(error, response, context) {
});
The singleton instance of the UsersController class can be accessed from the API Client.
var controller = lib.UsersController;
Get all users
function getUsersGetAllUsers(filter, pageSize, page, order, orderBy, callback)
| Parameter | Tags | Description |
|---|---|---|
| filter | Optional | The filter. |
| pageSize | Optional | Size of the page. |
| page | Optional | The page. |
| order | Optional | The order. |
| orderBy | Optional | The order by. |
var filter = 'filter';
var pageSize = 7;
var page = 7;
var order = 'order';
var orderBy = 'orderBy';
controller.getUsersGetAllUsers(filter, pageSize, page, order, orderBy, function(error, response, context) {
});
Update a user
function updateUsersUpdateUser(model, callback)
| Parameter | Tags | Description |
|---|---|---|
| model | Required | The model. |
var model = new SwapXRESTB2BModelsUsersUpdateUserModel({"key":"value"});
controller.updateUsersUpdateUser(model, function(error, response, context) {
});
| Error Code | Error Description |
|---|---|
| 400 | BadRequest |
createUsersCreateNewUserCreate new user
function createUsersCreateNewUser(model, callback)
| Parameter | Tags | Description |
|---|---|---|
| model | Required | The model. |
var model = new SwapXRESTB2BModelsUsersAddUserModel({"key":"value"});
controller.createUsersCreateNewUser(model, function(error, response, context) {
});
| Error Code | Error Description |
|---|---|
| 400 | BadRequest |
getUsersGetUserGet a single user
function getUsersGetUser(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The ID of the user. |
var userId = uniqid();
controller.getUsersGetUser(userId, function(error, response, context) {
});
Soft delete the user.
function deleteUsersDeleteUser(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.deleteUsersDeleteUser(userId, function(error, response, context) {
});
Get all active users
function getUsersGetAllActiveUsers(callback)
controller.getUsersGetAllActiveUsers(function(error, response, context) {
});
Updates the user account blocked.
function createUsersUpdateUserAccountBlocked(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | The input. |
var input = new SwapXRESTB2BModelsUsersUpdateUserAccountBlockModel({"key":"value"});
controller.createUsersUpdateUserAccountBlocked(input, function(error, response, context) {
});
Checks the account blocked status.
function getUsersCheckAccountBlockedStatus(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The user identifier. |
var userId = uniqid();
controller.getUsersCheckAccountBlockedStatus(userId, function(error, response, context) {
});
Get the pending users.
function getUsersGetPendingUsers(callback)
controller.getUsersGetPendingUsers(function(error, response, context) {
});
Updates the user 3D Secure information.
function createUsersUpdate3DSInfo(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | The input. |
var input = new SwapXRESTB2BModelsUsersUpdateUser3DSInfoModel({"key":"value"});
controller.createUsersUpdate3DSInfo(input, function(error, response, context) {
});
Updates the user KYC Status.
function getUsersUpdateKYCStatus(userId, kYCStatus, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | The guid of the user to update. |
| kYCStatus | Required | The new status of the user. |
var userId = uniqid();
var kYCStatus = 7;
controller.getUsersUpdateKYCStatus(userId, kYCStatus, function(error, response, context) {
});
The singleton instance of the WalletController class can be accessed from the API Client.
var controller = lib.WalletController;
Get all users wallet
function getWalletGetUserWallets(callback)
controller.getWalletGetUserWallets(function(error, response, context) {
});
Get a users wallet
function getWalletGetUserWallets1(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | TODO: Add a parameter description |
var userId = uniqid();
controller.getWalletGetUserWallets1(userId, function(error, response, context) {
});
Unload a User wallet
function createWalletWalletUnLoad(userId, callback)
| Parameter | Tags | Description |
|---|---|---|
| userId | Required | Guid of the user to unload |
var userId = uniqid();
controller.createWalletWalletUnLoad(userId, function(error, response, context) {
});
| Error Code | Error Description |
|---|---|
| 400 | BadRequest |
createWalletWalletLoadLoad wallet for one or multiple user
function createWalletWalletLoad(input, callback)
| Parameter | Tags | Description |
|---|---|---|
| input | Required | Load wallet input |
var input = new SwapXCoreModelsWalletUsersWalletLoadInputModel({"key":"value"});
controller.createWalletWalletLoad(input, function(error, response, context) {
});
| Error Code | Error Description |
|---|---|
| 400 | BadRequest |
FAQs
SDK for integrating with Lerex (formerly Swapx) B2B API
The npm package lerex receives a total of 2 weekly downloads. As such, lerex popularity was classified as not popular.
We found that lerex demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenAI rotated macOS signing certificates after a malicious Axios package reached its CI pipeline in a broader software supply chain attack.
Security News
Open source is under attack because of how much value it creates. It has been the foundation of every major software innovation for the last three decades. This is not the time to walk away from it.
Security News
Socket CEO Feross Aboukhadijeh breaks down how North Korea hijacked Axios and what it means for the future of software supply chain security.