flutterwave-node-v3

Flutterwave v3 NodeJS Library

Introduction

The Node library provides easy access to Flutterwave for Business (F4B) v3 APIs for your Node apps. It abstracts the complexity involved in direct integration and allows you to make quick calls to the APIs. Available features include:

• Collections: Card, Account, Mobile money, Bank Transfers, USSD, Apple Pay, Google Pay, Fawry Pay, eNaira.
• Payouts and Beneficiaries.
• Recurring payments: Tokenization and Subscriptions.
• Split payments
• Card issuing
• Transactions dispute management: Refunds and Chargebacks.
• Transaction reporting: Collections, Payouts, Settlements, Refunds, Chargebacks and Transaction timeline.
• Bill payments: Airtime, Data bundle, Cable, Power, Toll, E-bills, and Remitta.
• Identity verification: Resolve bank account, resolve BVN information and generate OTP.

Table of Content

1. Requirements
2. Installation
3. Initialization
4. Usage
5. Testing
6. Debugging Errors
7. Support
8. Contribution guidelines
9. License
10. Changelog

Requirements

1. Flutterwave for business (F4B) API Keys
2. Node 12 or higher.

Installation

To install the package, run the following command in your Node terminal:

npm install flutterwave-node-v3

Initialization

const Flutterwave = require('flutterwave-node-v3');
const flw = new Flutterwave(process.env.FLW_PUBLIC_KEY, process.env.FLW_SECRET_KEY);

For staging (Test environment), use the TEST API Keys and for production (Live environment), use LIVE API KEYS. You can get your process.env.FLW_PUBLIC_KEY and process.env.FLW_SECRET_KEY from the Flutterwave dashboard. Read the requirement section for more information on how to get your API keys.

Usage

1. Collections
2. Tokenization
3. Subscriptions
4. Transfers
5. Virtual Account
6. Bill payments
7. Transactions and reporting
8. Beneficiaries
9. Banks
10. Settlements
11. OTP
12. Ebills
13. Misc
14. Virtual Cards
15. Collection Subaccounts
16. Payment-plan

Testing

All of the libraries tests are run on Mocha. Available tests include rave.bank.test, rave.beneficiaries.test, rave.bills.test, rave.charge.test, rave.ebills.test, rave.settlements.test, rave.subscriptions.test. They can be run by running the test command in your terminal.

npm run test or npm test

Debugging Errors

We understand that you may run into some errors while integrating our library. You can read more about our error messages here. For authorization and validation error responses, double-check your API keys and request. If you get a server error, kindly engage the team for support.

Support

For additional assistance using this library, contact the developer experience (DX) team via email or on slack. You can also follow us @FlutterwaveEng and let us know what you think 😊.

Contribution guidelines

Read more about our community contribution guidelines here

License

By contributing to this library, you agree that your contributions will be licensed under its MIT license. Copyright (c) Flutterwave Inc.

Changelog

1.1.11 | 2024-09-10

Update account_bank validation in create schema.

Version Changes

• [FIXED] Update minLength & maxLength validation for account_bank parameter.