Merge pull request #145 from Dekunledev/master

Hotfixes and support for the new NIBBS BVN verification flow

Author: corneliusyaovi

CHANGELOG.md

@@ -1,26 +1,36 @@
 # Changelog
 
+## 1.1.8 | 2024-02-19
+This release, we've addressed several Hotfixes and added support for the new NIBBS BVN verification flow. Check out the details below:
+
+### Version Changes.
+- [ADDED] NIBBS BVN verification flow.
+- [ADDED] unit tests for the new BVN verification flow, transaction fees, and Card Collection into subaccounts.
+- [ADDED] 'subaccounts' as an optional body parameter for card charge and PWBT (Pay with Bank Transfer).
+- [FIXED] "URL Not Found" Error returned from Validate Bill Service method.
+- [FIXED] "Invalid currency provided" Error returned from the Transaction fees method.
+
 ## 1.1.7 | 2024-01-25
-This release includes the addition of Fawrypay and Tanzania mobilemoney, updates to NG (mono), UK & EU bank charge, googlepay, applepay, enaira and Hotfix to add and update parameters for the update payment plan method, bulk transfers, and single transfers.
-### Version changes.
-- [ADDED] Support for Tanzania mobilemoney and tests for TZS mobilemoney.
-- [ADDED] Support for Fawzy pay charge.
-- [ADDED] Unit tests for Fawry pay, googlepay, applepay and eNaira charge.
-- [ADDED] "beneficiary_name" as a required body parameter and "currency" & "bank_name" as optional body parameters in the beneficiarySchema.
-- [ADDED] createBulkTransferSchema to accept both "title" and "bulk_data" to create bulk transfers.
-- [ADDED] "expires" as an optional body parameters for PWBT(pay with bank transfer).
-- [ADDED] tests for the payment plan, Charge NG Bank Account (mono), Charge with Bank Transfer (PWBT), and Change UK & EU Bank Account.
-- [ADDED] schema for the USSD charge (ussdChargeSchema).
+In this release, we've enhanced payment methods and addressed various housekeeping issues to ensure a smoother experience. Check out the details below:
+
+### Version Changes.
+- [ADDED] Tanzania mobile money payment method.
+- [ADDED] Fawry Pay payment method.
+- [ADDED] Additional unit tests for Fawry Pay, Google Pay, Apple Pay, and eNaira.
+- [FIXED] Optional parameters in beneficiarySchema.
+- [ADDED] Supplementary parameters in the createBulkTransferSchema.
+- [ADDED] Introduced "expires" as an optional body parameter for PWBT (Pay with Bank Transfer).
+- [ADDED] New tests for payment plans, Charge NG Bank Account (Mono), Charge with Bank Transfer (PWBT), and Change UK & EU Bank Account.
+- [ADDED] Schema for USSD charge (ussdChargeSchema).
 - [ADDED] "status" as a body parameter in the updatePlanSchema.
-- [FIXED] updated the transaction tests to stub response.
-- [FIXED] "id" in the fetchSchema to accept only integer values.
-- [FIXED] "authorization.zipcode" in the cardChargeSchema to accept string values.
-- [FIXED] "billing_zip" in the chargeSchema to accept string values.
-- [FIXED] updated the length of "account_bank" values in the transferSchema.
-- [FIXED] updated the UK & USSD bank charge.
-- [FIXED] updated the README.md file and documentation wikis.
-- [FIXED] updated the NG bank charge(mono).
-- [REMOVED] "amount" as a body parameter in the updatePlanSchema.
+- [FIXED] Updated transaction tests to stub response.
+- [FIXED] Modified "id" in the fetchSchema to accept only integer values.
+- [FIXED] Adjusted "authorization.zipcode" in the cardChargeSchema to accept string values.
+- [FIXED] Adapted "billing_zip" in the chargeSchema to accept string values.
+- [FIXED] Extended the length of "account_bank" values in the transferSchema.
+- [FIXED] Updated the UK & USSD bank charge.
+- [FIXED] Revised the NG bank charge (Mono).
+- [REMOVED] Eliminated the "amount" parameter in the updatePlanSchema.
 
 ## 1.1.6 | 2023-06-21
 Hotfix on Transfer fees and Bank lists.

lib/rave.misc.js

@@ -1,6 +1,7 @@
 const balances_currency = require('../services/misc/rave.balances-currency');
 const get_bal = require('../services/misc/rave.balances');
-const bankBVN = require('../services/misc/rave.bvn');
+const initBVN = require('../services/misc/rave.initiate.bvn');
+const verifBVN = require('../services/misc/rave.verify.bvn')
 const resolve_act = require('../services/misc/rave.resolve.account');
 
 function Misc(RaveBase) {
@@ -13,8 +14,13 @@ function Misc(RaveBase) {
   };
 
   this.bvn = function (data) {
-    return bankBVN(data, RaveBase);
+    return initBVN(data, RaveBase);
   };
+
+  this.verifybvn = function (data) {
+    return verifBVN(data, RaveBase);
+  }
+
   this.verify_Account = function (data) {
     return resolve_act(data, RaveBase);
   };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "flutterwave-node-v3",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "The official Node.JS library for Flutterwave v3 payment APIs",
   "main": "index.js",
   "scripts": {

services/bills/rave.validate-bill.js

@@ -5,6 +5,7 @@ const { validateSchema } = require('../schema/bill');
 async function service(data, _rave) {
   validator(validateSchema, data);
   data.method = 'GET';
+  data.excludeQuery = true;
   const { body: response } = await _rave.request(
     `v3/bill-items/${data.item_code}/validate?code=${data.code}&customer=${data.customer}`,
     data,

services/misc/rave.bvn.js services/misc/rave.initiate.bvn.jsservices/misc/rave.bvn.js renamed to services/misc/rave.initiate.bvn.js

@@ -1,15 +1,14 @@
 const { logger } = require('../../utils/logger');
 const { validator } = require('../../utils/validator');
-const { validateBVNSchema } = require('../schema/auxillary');
+const { initiateBVNSchema } = require('../schema/auxillary');
 
 async function service(data, _rave) {
-  validator(validateBVNSchema, data);
-  data.method = 'GET';
+  validator(initiateBVNSchema, data);
   const { body: response } = await _rave.request(
-    `v3/kyc/bvns/${data.bvn}`,
+    `v3/bvn/verifications`,
     data,
   );
-  logger(`Resolve BVN details`, _rave);
+  logger(`Initiate BVN consent`, _rave);
   return response;
 }
 

services/misc/rave.verify.bvn.js

@@ -0,0 +1,17 @@
+const { logger } = require('../../utils/logger');
+const { validator } = require('../../utils/validator');
+const { verifyBVNSchema } = require('../schema/auxillary');
+
+async function service(data, _rave) {
+  validator(verifyBVNSchema, data);
+  data.method = 'GET';
+  data.excludeQuery = true;
+  const { body: response } = await _rave.request(
+    `v3/bvn/verifications/${data.reference}`,
+    data,
+  );
+  logger(`Verify BVN consent`, _rave);
+  return response;
+}
+
+module.exports = service;

services/schema/auxillary.js

@@ -139,8 +139,15 @@ const validateSchema = joi.object({
 });
 
 // validate a BVN
-const validateBVNSchema = joi.object({
+const initiateBVNSchema = joi.object({
   bvn: joi.string().length(11).required(),
+  firstname: joi.string().max(100).required(),
+  lastname: joi.string().max(100).required(),
+  redirect_url: joi.string().uri(),
+});
+
+const verifyBVNSchema = joi.object({
+  reference: joi.string().trim().max(100).required(),
 });
 
 module.exports = {
@@ -158,5 +165,6 @@ module.exports = {
   updateTokenSchema,
   withdrawalSchema,
   validateSchema,
-  validateBVNSchema,
+  initiateBVNSchema,
+  verifyBVNSchema
 };

services/schema/create.js

@@ -249,6 +249,14 @@ const cardChargeSchema = joi.object({
   }),
   payment_plan: joi.string(),
   meta: joi.object().pattern(/^[a-zA-Z0-9_]*$/, joi.any()),
+  subaccounts: joi.array().items(
+    joi.object({
+      id: joi.string().trim().max(100).required(),
+      transaction_split_ratio: joi.number().positive(),
+      transaction_charge_type: joi.string().valid('flat', 'percentage', 'flat_subaccount'),
+      transaction_charge: joi.number().positive(),
+    })
+  ).min(1),
 });
 
 // initiate collections for different payment methods
@@ -282,6 +290,14 @@ const chargeSchema = joi.object({
   billing_zip: joi.string(),
   meta: joi.object().pattern(/^[a-zA-Z0-9_]*$/, joi.any()),
   expires: joi.number().positive().max(31536000),
+  subaccounts: joi.array().items(
+    joi.object({
+      id: joi.string().trim().max(100).required(),
+      transaction_split_ratio: joi.number().positive(),
+      transaction_charge_type: joi.string().valid('flat', 'percentage', 'flat_subaccount'),
+      transaction_charge: joi.number().positive(),
+    })
+  ).min(1),
 });
 
 // create eNaira charge

services/transactions/rave.fee.js

@@ -5,6 +5,7 @@ const { feeSchema } = require('../schema/auxillary');
 async function service(data, _rave) {
   validator(feeSchema, data);
   data.method = 'GET';
+  data.excludeQuery = true;
   const { body: response } = await _rave.request(
     `v3/transactions/fee?amount=${data.amount}&currency=${data.currency}`,
     data,

test/rave.charge.test.js

@@ -738,4 +738,92 @@ describe('#Rave charge', function () {
       expect(err.message).to.include('"currency" is required');
     }
   });
+
+  it('should return charge into collection subaccounts', async function () {
+    this.timeout(10000);
+
+    const createCardChargeStub = sinon.stub(chargeInstance, 'card').resolves({
+      status: 'success',
+      message: 'Successful',
+      data: {
+        id: 4918672,
+        tx_ref: 'MC-3243e000',
+        flw_ref: 'FLW-MOCK-365702bdb12af7938bdd02860caf2bc2',
+        device_fingerprint: 'N/A',
+        amount: 100,
+        charged_amount: 100,
+        app_fee: 1.4,
+        merchant_fee: 0,
+        processor_response: 'Please enter the OTP sent to your mobile number 080****** and email te**@rave**.com',
+        auth_model: 'NOAUTH',
+        currency: 'NGN',
+        ip: '54.75.161.64',
+        narration: 'CARD Transaction ',
+        status: 'successful',
+        auth_url: 'https://ravesandboxapi.flutterwave.com/mockvbvpage?ref=FLW-MOCK-365702bdb12af7938bdd02860caf2bc2&code=00&message=Approved.%20Successful&receiptno=RN1708329200239',
+        payment_type: 'card',
+        plan: null,
+        fraud_status: 'ok',
+        charge_type: 'normal',
+        created_at: '2024-02-19T07:53:20.000Z',
+        account_id: 20937,
+        customer: {
+          id: 2356420,
+          phone_number: null,
+          name: 'Yolande Aglaé',
+          email: 'user@example.com',
+          created_at: '2024-02-19T07:53:20.000Z'
+        },
+        card: {
+          first_6digits: '553188',
+          last_4digits: '2950',
+          issuer: 'MASTERCARD  CREDIT',
+          country: 'NG',
+          type: 'MASTERCARD',
+          expiry: '09/32'
+        }
+      }
+    })
+
+    var payload = {
+      card_number:"5531886652142950",
+      cvv:"564",
+      expiry_month:"09",
+      expiry_year:"32",
+      currency:"NGN",
+      amount:"100",
+      fullname:"Yolande Aglaé Colbert",
+      email:"user@example.com",
+      tx_ref:"MC-3243e000",
+      redirect_url:"https://www,flutterwave.ng",
+      enckey: process.env.ENCRYPTION_KEY,
+      subaccounts: [
+        {
+          id: "RS_93667D2B73110DFFEF8449A8A0A32415",
+          transaction_split_ratio: 2,
+          transaction_charge_type: "flat",
+          transaction_charge: 100,
+        },
+        {
+          id: "RS_47CC41E35953182AC35E952D4F4CA713",
+          transaction_split_ratio: 3,
+          transaction_charge_type: "flat",
+          transaction_charge: 100,
+        },
+        {
+          id: "RS_EEF0D016C26BBF1543F09CEF6090AB49",
+          transaction_split_ratio: 5,
+          transaction_charge_type: "flat",
+          transaction_charge: 100,
+        },
+      ],
+    };
+    var resp = await chargeInstance.card(payload);
+    expect(createCardChargeStub).to.have.been.calledOnce;
+    expect(createCardChargeStub).to.have.been.calledOnceWith(payload);
+
+    expect(resp).to.have.property('status', 'success');
+
+    expect(resp.data).to.have.property('status', 'successful');
+  });
 });