api.md

Equity

Equity

Kind: global class

• Equity
  • new Equity(consumerKey, consumerSecret, sandbox)
  • .getToken(username, password) ⇒ Promise
  • .changePassword(token, id, currentPassword, newPassword) ⇒ Promise
  • .paymentStatus(token, id) ⇒ Promise
  • .purchaseAirtime(token, mobileNumber, amount, reference, telco) ⇒ Promise
  • .onlineRemit(token, transactionReference, senderName, accountNumber, bicCode, mobileNumber, walletName, bankCode, branchCode, countryCode, currencyCode, amount, paymentType, paymentReferences, remarks) ⇒ Promise
  • .createPayment(token, mobileNumber, amount, description, type, auditNumber) ⇒ Promise

new Equity(consumerKey, consumerSecret, sandbox)

Param	Type	Description
consumerKey	String	(Required) Consumer key from Equity Bank.
consumerSecret	String	(Required) Consumer secret from Equity Bank.
sandbox	Boolean	(Optional) Enables sandbox API. Deafults to false.

equity.getToken(username, password) ⇒ Promise

Generate an access token.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
username	String	Merchant username, provided by Equity Bank.
password	String	Merchant password, provided by Equity Bank.

equity.changePassword(token, id, currentPassword, newPassword) ⇒ Promise

Change merchant password.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
token	String	Access token.
id	Number	Merchant ID. provided by Equity Bank.
currentPassword	String	Merchant Username, provided by Equity Bank.
newPassword	String	Merchant Password, provided by Equity.

equity.paymentStatus(token, id) ⇒ Promise

Get payment status.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
token	String	Access token.
id	Number	Transaction ID.

equity.purchaseAirtime(token, mobileNumber, amount, reference, telco) ⇒ Promise

Purchase airtime.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
token	String	Access token.
mobileNumber	String	Mobile Number For Which To Purchase Airtime.
amount	Number	Airtime amount.
reference	String	Airtime reference.
telco	String	Network operator.

equity.onlineRemit(token, transactionReference, senderName, accountNumber, bicCode, mobileNumber, walletName, bankCode, branchCode, countryCode, currencyCode, amount, paymentType, paymentReferences, remarks) ⇒ Promise

Online remittance.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
token	String	Access token.
transactionReference	String	Transaction reference.
senderName	String	Sender's name.
accountNumber	String	Account number.
bicCode	String	BIC code.
mobileNumber	String	Mobile number.
walletName	String	Wallet name.
bankCode	String	Bank code.
branchCode	String	Branch code.
countryCode	String	Country code.
currencyCode	String	Currency code.
amount	Number	Amount.
paymentType	String	Payment type.
paymentReferences	Array	3 Payment references.
remarks	String	Additional remarks.

equity.createPayment(token, mobileNumber, amount, description, type, auditNumber) ⇒ Promise

Create payment.

Kind: instance method of Equity Returns: Promise - Response.

Param	Type	Description
token	String	Access token.
mobileNumber	String	Mobile number.
amount	Number	Amount.
description	String	Payment description.
type	String	Payment type.
auditNumber	String	Audit number.