@sendyit/payment

In-depth documentation can be found using the link below

https://sendy.atlassian.net/wiki/spaces/PF/pages/edit-v2/1966440548

How to use

npm install @sendyit/payments

got to the src/main.js and add the following lines

import router from './router'
import store from './store'
import payments from '@sendyit/payments';

Vue.use(payments, {
  store,
  router,
  config: {
    BASE_URL: '/payment-service-base-url', // add payment service base URl
    VGS_VAULT_ID: 'txxxxxxxxxxx',
    VGS_ENVIRONMENT: 'sandbox', // environment is 'sandbox' for staging and 'live' for prod environment.
  },
});

How to call the payment library.

So there 4 entry points:

1. checkout
2. payment-option
3. choose-payment
4. Choose-payment-checkout - Choose payment page with checkout.

To go to checkout page call the following method as shown below by passing the Bu payload

 const buPayload = {
   user_id: 1,
   entity_id: 1,
   currency: 'KES',
   country_code: 'KE',
   amount: '100',
   success_callback_url: '',
   fail_callback_url: '',
   txref: this.txref,
   bulk: false,
   paybill_no: '4444444',
   email: '[email protected]',
   authToken: '', //Add Jwt token for authentication.
   firstname: 'John',
   lastname: 'doe',
   payment_options: [1, 2],// This are the payment_methods_id you get from the paymeht methods available. They are used to filter the payment methods you want the user shown.
   company_code: 'SKML', // add compnay code to associate a transaction to it's repective company.
   locale: 'en', // add locale. 'en' & 'fr' are the supported languages now.
 };

 this.$paymentInit(buPayload, 'checkout'); //the 2nd argument can be a 'checkout', 'payment-option', 'choose-payment' or 'choose-payment-checkout, in order to access the three entry points of the Bu.

How test and collaborate

In order to help and collaborate, clone this repo, then add what you can improve, and build the npm version of the repo locally in the dist file in the root of the folder, using the below command

npm run build-lib

To version the App

Use the below command for versioning of the app.

npm version patch -m "Add a comment for the versioning"

publish

in order to publish the app, use the below command

npm publish

Customize configuration

See Configuration Reference.