waverlite
v1.1.6
Published
💰Waverlite API package to help implement direct deposit into users bank account.
Downloads
19
Readme
KOTANIPAY WAVERLITE API
💰Waverlite API package to help implement direct deposit into users bank account.
Only basic endpoints are supported
At this time, the package doesn't support all the endpoints of the Waverlite API, as it is made for specific needs of our current operations and will be updated with new endpoints base on new requirements .
Installation
yarn add waverlite or
npm install waverlite
DIRECT DEPOSIT
const waverlite = require('waverlite');
const request = new waverlite.Waverlite({
privateKey: 'API_KEY',
walletKey: 'WALLET_KEY',
country: 'Country CODE eg: NGA or ZAF',
});
const depositData = {
account_number: 'bank account number', // bank account number to receive deposit
institution: 'institution reference id', // access institution id from get institutions api
amount: 'amount',
reference: await request.getTransactionReference(),
customer_key: 'customer key', // access customer key from create customer endpoint
};
return await request.directDeposit(depositData);
CREATE CUSTOMER
const customer = {
{
"bio": {
"first_name": "first name",
"surname": "surname",
"gender": "FEMALE",
"date_of_birth": "1990-04-20",
"occupation": "users occupation"
},
"contact": {
"phone_number": "valid country phone number",
"email_address": "email",
"address": {
"line": "Location details",
"province": "users province",
"municipality": "users municipality",
"city": "City of residence"
}
},
"kyc": {
"identification": {
"type": "NATIONAL_ID",
"number": "valid national id number"
}
},
"reference": "unique reference id"
}
}
await request.createCustomerKey(customer);
GET INSTITUTIONS
await request.getInstitutions(country); // pass country code eg: NGA or ZAF
GET TRANSACTION STATUS
await request.getTransactionStatus(reference); // pass transaction reference
GENERATE REFERENCE ID
await request.getTransactionReference();