otp.md

OTPS

We recommend reading the main readme first, to understand the requirements for using the library and how to initiate this in your apps. This guide assumes you've read that.

Manage Otps via any of these methods:

1. Create Otp
2. Validate Otp

Create Otp

This describes how to create an otp

const Flutterwave = require('flutterwave-node-v3');

const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );

const createOTP = async () => {

    try {

        const payload = {
            "length": 7,
            "customer": {
                "name": "Kazan",
                "email": "kazan@mailinator.com",
                "phone": "2348131149273"
            },
            "sender": "Test Sender",
            "send": true,
            "medium": [
                "email",
                "whatsapp"
            ],
            "expiry": 5
        }

        const response = await flw.Otp.create(payload)
        console.log(response);
    } catch (error) {
        console.log(error)
    }

}


createOTP();

Sample Response

{
   "status": "success",
   "message": "OTP generated successfully",
   "data": [
      {
         "medium": "email",
         "reference": "CF-BARTER-20230305031441503636",
         "otp": "1495545",
         "expiry": "2023-03-05T03:19:41.8110726+00:00"
      },
      {
         "medium": "whatsapp",
         "reference": "CF-BARTER-20230305031443536582",
         "otp": "1495545",
         "expiry": "2023-03-05T03:19:43.4362097+00:00"
      }
   ]
}

Validate Otp

This describes how to validate an otp

const Flutterwave = require('flutterwave-node-v3');

const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY  );


const validateOTP = async () => {

    try {

        const payload = {
            "reference": "CF-BARTER-20190420022611377491",
            "otp": "481208"
        }

        const response = await flw.Otp.validate(payload)
        console.log(response);
    } catch (error) {
        console.log(error)
    }

}


validateOTP();

Sample Response

{
    "status": "success",
    "message": "Otp Authenticated successfully",
    "data": null
}