Giter Club home page Giter Club logo

stanbic-node.js's Introduction

Stanbic Node.js SDK

Stanbic Kilele Payments API Node.js SDK

Installation

Install the package from npm ny running:

npm install --save stanbic

Usage

The package needs to be configured with your app's secret and client_id from the dashboard.

Initialization

  const credentials = {
    secret: "YOUR_SECRET_ID",
    apiKey: "YOUR_CLIENT_ID"
  }

  const Stanbic = require('stanbic')(credentials)

  const snbToSnb = Stanbic.StanbicPayments

  const options = {
    identification: "8488........171",
    amount: "20"
  }

  snbToSnb.stanbicPayments(options)
    .then((response) => {
      console.log(response)
    }).catch((err) => {
      console.log(err)
    })

Services

Make service requests using the Stanbic instance

Note:

  • All methods are asynchronous
  • All phone number params are in the international format phone number 254712345678

Payments to Stanbic Accounts

  const snbToSnb = Stanbic.StanbicPayments

  const options = {
    identification: "ACCOUNT.NUMBER",
    amount: "AMOUNT"
  }

  snbToSnb.stanbicPayments(options)
  • identification: stanbic recipient account numberREQUIRED, STRING
  • amount: amount to transact REQUIRED, STRING

Stanbic to Mobile Payments

  const mobilePayments = Stanbic.MobilePayments

  const options = {
    mobileNumber: MOBILE.NUMBER,
    amount: AMOUNT
  }

  mobilePayments.mobilePayments(options)
  • mobileNumber: recipient mobile numberREQUIRED, INTEGER
  • amount: amount to transact REQUIRED, INTEGER

STK Push - M-Pesa Checkout

  const mpesa = Stanbic.STKPush

  const options = {
    billAccountRef: "ACCOUNT.NUMBER",
    amount: "AMOUNT",
    mobileNumber: "MOBILE.NUMBER"
  }

  mpesa.stkPush(options)
  • billAccountRef: Stanbic account receiving the fundsREQUIRED, STRING
  • amount: amount being deducted from M-Pesa account REQUIRED, STRING
  • mobileNumber: M-Pesa account being charged REQUIRED, STRING

Inter-Bank Transfers API via Pesalink

Note Implementing

  const pesalinkPayments = Stanbic.InterBankTransfers

  const options = {
    recipientAccountNo: "ACCOUNT.NUMBER",
    amount: "AMOUNT"
  }

  pesalinkPayments.interBankTransfers(options)
  • recipientAccountNo: Recipient's account number REQUIRED, STRING
  • amount: amount to transact REQUIRED, STRING

Development

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ochiengotieno304/stanbic-node.js.

License

The gem is available as open source under the terms of the MIT License.

stanbic-node.js's People

Contributors

ochiengotieno304 avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.