E-levy NPM | npm.io

image banner

Official E-levy API

Visist more information on our Documentaion Page or you can visit our website

Installation

npm install e-levy

for yarn

yarn add e-levy

Usage

Easy and Fast to use

const anyVariableName  =  require('e-levy')

const amount = 200;
	
const telco = 'MTN' // VODAFONE , AIRTELTIGO
	
const {elevyCharge, chargedAmount, deductedAmount, moneyToSend, telcoCharge , imageReference,message} = anyVariableName(telco,amount)
 
// do what you want to with the distructured data...

Params

Parameters to be passed to the function

name	description	default	type
amount	`this is the money to be sent to the user`	0	integer
telco	`"Telecommunication Services"` MTN , VODAFONE , AIRTELTIGO	"MTN"	strings

Response

returns a JSON object

name	description	type
elevyCharge	`this is the percentage charge on E-levy`	double
chargedAmount	`Amount charged on e-levy percentage"`	double
deductedAmount	`Amount after deduction of e-levy charges"`	double
telcoCharge	`Charges taken by respective telecommunication services eg.MTN (0.75)"`	double
telcoName	`name of the telecommunication service eg.MTN"`	string
amount	`amount sent"`	double
moneyToSend	`this give you the money need to be sent in order to payoff e-levy charges"`	double
message	`information on the results"`	string
imageReference	`an image url to reference api eg."`	string