Skip to content

Flutterwave/Vue-v3

Repository files navigation

Flutterwave Vue.JS (Vue2) Library

Publish Vue.js Package npm npm NPM

The Vue SDK helps you create seamless payment experiences in your Vue(2.X) mobile/web app. By connecting to our modal, you can start collecting payment in no time.

Available features include:

  • Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
  • Recurring payments: Tokenization and Subscriptions.
  • Split payments

Table of Contents

  1. Requirements
  2. Installation
  3. Initialization
  4. Usage
  5. Debugging errors
  6. Support
  7. Contribution
  8. License

Requirements

  1. Flutterwave for business V3 API keys
  2. Vue version = 2.x.x

Installation

Install the SDK

$ npm install flutterwave-vue-v3

# OR

$ yarn  add  flutterwave-vue-v3

Initialization

  1. Import the Flutterwave Library in the 'main.js' file.

  2. Add the Flutterwave plugin to your app passing in your Flutterwave Public Key (optional)

Note 💡: For a Typescript project sample, please see the project in the example directory of the project repository.

If Public key is not added you will have to pass in the public_key parameter to the provided payment component button and payment function

//main.js
import Vue from 'vue'
import App from './App.vue'
import Flutterwave from  'flutterwave-vue-v3'


Vue.use(Flutterwave, { publicKey: 'FLWPUBK_TESTXXXXXXXXXX' } )

new Vue({
  render: h => h(App),
}).$mount('#app')

Usage

  1. Collections
  2. Recurring Payments
  3. Split payments

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, please create an issue on the Github repo or 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

We welcome contributions from the community. Please see the community guide for contributions guidelines.

License

By contributing to this library, you agree that your contributions will be licensed under its MIT license.

Copyright (c) Flutterwave Inc.