Masspay-js-sdk NPM

Welcome to our masspay-js-sdk. We are committed to providing you with the best SDK services experience possible. Please use our step-by-step instructions to become familiar with how to use our SDK.

Current API version: 1.0.0
Current package version: 2.0.0

Requirements

Installed Node.js, stable version >= 12. If you do not currently have Node.js locally installed, please refer to the Node website
MassPay.io API credentials.

Installation

Use these commands to install masspay-js-sdk in your terminal, based on your preferences.

npm

npm install masspay-js-sdk

yarn

yarn add masspay-js-sdk

Usage

In case that you successfully installed our masspay-js-sdk please execute this code:

import { MasspayJsSdk } from 'masspay-js-sdk';

const sdk = new MasspayJsSdk({
  AUTHORIZER_NAME_API_KEY: 'YOUR API KEY',
});
(async () => {
  try {
    const response = await sdk.AccountService.getAccountBalance({
      /* query parameters */
    });
    // use response data
  } catch (error) {
    // handle error
  }
})();

Features

Kindly note that every URI is relative to https://api.masspay.io/v1.0.0.

The table displays all features categorized based on their specific purposes.

Class	Method	HTTP request	Description
MasspayJsSdk.AccountService	getAccountBalance	GET /payout/account/balance	Get current available balance
MasspayJsSdk.AccountService	getAccountStatement	GET /payout/account/statement	Get certified account statement
MasspayJsSdk.AttributeService	getAllAttrs	GET /payout/attribute/{user_token}	Get all stored user attributes
MasspayJsSdk.AttributeService	storeAttrs	POST /payout/attribute/{user_token}/{destination_token}/{currency}	Store user attributes
MasspayJsSdk.AttributeService	getAttrs	GET /payout/attribute/{user_token}/{destination_token}/{currency}	Get user attributes for destination_token
MasspayJsSdk.CardService	getWalletCardInfo	GET /payout/wallet/{user_token}/{wallet_token}/card	Get MassPay card information
MasspayJsSdk.CardService	updateWalletCardInfo	PUT /payout/wallet/{user_token}/{wallet_token}/card	Update MassPay card information
MasspayJsSdk.CatalogService	getCountryList	GET /payout/country/list	Gets a list of countries where services offered.
MasspayJsSdk.CatalogService	getCountryServices	GET /payout/country/{country_code}	Gets a list of Companies and their service offerings for the given country code.
MasspayJsSdk.CatalogService	getCheapestCountryServices	GET /payout/country/{country_code}/cheapest	Gets a list of Companies and their cheapest service offerings for the given country code.
MasspayJsSdk.CatalogService	getDestinationTokenAlternatives	GET /payout/service/{destination_token}/alternatives	Returns list of alternative service to a provided service
MasspayJsSdk.CatalogService	getDestinationToken	GET /payout/service/{destination_token}	Returns provided service
MasspayJsSdk.CatalogService	getUserAgreement	GET /payout/user-agreements	Get user agreement
MasspayJsSdk.CatalogService	getUserAgreementsNames	OPTIONS /payout/user-agreements	Get available user agreements
MasspayJsSdk.KycService	findAttributesVelocity	POST /payout/attribute/{user_token}/velocity	Attributes velocity check
MasspayJsSdk.KycService	getUserUserTokenKycAu10Tix	GET /payout/user/{user_token}/kyc/au10tix	Get an Au10tix session link
MasspayJsSdk.KycService	uploadIdPhotos	POST /payout/user/{user_token}/kyc/id	Upload ID photos
MasspayJsSdk.KycService	getUserUserTokenKycAttempts	GET /payout/user/{user_token}/kyc/id	Get all KYC sessions
MasspayJsSdk.KycService	getUserUserTokenKycVeriff	GET /payout/user/{user_token}/kyc/veriff	Get a Veriff session link
MasspayJsSdk.LoadService	resendBalanceNotification	PUT /payout/wallet/{user_token}	Resend balance notification
MasspayJsSdk.LoadService	loadUser	POST /payout/load/{user_token}	Initiate a load transaction
MasspayJsSdk.LoadService	getUserLoadsByToken	GET /payout/load/{user_token}	Get history of loads by user token
MasspayJsSdk.LoadService	resendLoadNotification	PUT /payout/load/{user_token}	Resend load notification
MasspayJsSdk.LoadService	cancelUserLoad	DELETE /payout/load/{user_token}	Reverse a user load
MasspayJsSdk.PayoutService	initiatePayout	POST /payout/{user_token}	Initiate a payout transaction
MasspayJsSdk.PayoutService	getUserPayoutsByToken	GET /payout/{user_token}	Get history of payouts by user token
MasspayJsSdk.PayoutService	commitPayoutTxn	PUT /payout/{user_token}/{payout_token}	Commit payout transaction
MasspayJsSdk.PayoutService	getPayoutStatus	GET /payout/{user_token}/{payout_token}	Get status of a payout by payout token
MasspayJsSdk.PayoutService	getTransactionConfirmationDetails	PATCH /payout/{user_token}/{payout_token}	Get transaction confirmation details
MasspayJsSdk.SpendBackService	getUserSpendbacksByToken	GET /payout/spendback/{user_token}	Get history of spend backs by user token
MasspayJsSdk.SpendBackService	initiateSpendback	POST /payout/spendback/{user_token}	Initiate a spend back transaction
MasspayJsSdk.SubaccountService	createSubaccount	POST /subaccount	Create a subaccount
MasspayJsSdk.SubaccountService	getSubaccountSubaccountTokenUbo	POST /subaccount/{subaccount_token}/ubo	Add UBOs to subaccount
MasspayJsSdk.SubaccountService	uploadSubaccountUboId	POST /subaccount/{subaccount_token}/ubo/{ubo_token}/id	Upload UBO ID photos
MasspayJsSdk.TaxService	getTaxUsers	GET /payout/tax	Get list of users' annual balance
MasspayJsSdk.TaxService	getTaxInterviewLink	GET /payout/{user_token}/tax	Get link for tax interview
MasspayJsSdk.UserService	createUser	POST /payout/user	Create a user
MasspayJsSdk.UserService	getUserByToken	GET /payout/user/{user_token}	Get user by user token
MasspayJsSdk.UserService	updateUser	PUT /payout/user/{user_token}	Updated user
MasspayJsSdk.UserService	userLookup	GET /payout/user/lookup	Lookup an existing user
MasspayJsSdk.UserService	getUserHistory	GET /payout/user/{user_token}/history	Transactions history
MasspayJsSdk.UserService	getAllUsersHistory	GET /payout/user/history	All Users' Transactions history
MasspayJsSdk.WalletService	getWallet	GET /payout/wallet/{user_token}	Retrieve all available wallets for a user
MasspayJsSdk.WalletService	getAutopayoutRules	GET /payout/wallet/{user_token}/{wallet_token}/autopayout	Get all AutoPayout rules
MasspayJsSdk.WalletService	createAutopayoutRule	POST /payout/wallet/{user_token}/{wallet_token}/autopayout	Add AutoPayout rule
MasspayJsSdk.WalletService	deleteAutopayoutRule	DELETE /payout/wallet/{user_token}/{wallet_token}/autopayout	Delete AutoPayout rule

Contributing

To learn more about the possibility of contributing to the subsequent development of this SDK, please visit our contributing page. Kindly note that contributions are limited by a unique set of rules in order to ensure clarity.