Skip to content

Commit

Permalink
Modify read me
Browse files Browse the repository at this point in the history
  • Loading branch information
rkterungwa16 committed Apr 7, 2019
1 parent 72ea8c8 commit ceaec2e
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 1 deletion.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,63 @@
Node.js library for the Quickteller SVA API.

[![Build Status](https://travis-ci.org/rkterungwa16/quickteller-sva-node.svg?branch=master)](https://travis-ci.org/rkterungwa16/quickteller-sva-node) [![Coverage Status](https://coveralls.io/repos/github/rkterungwa16/quickteller-sva-node/badge.svg?branch=master)](https://coveralls.io/github/rkterungwa16/quickteller-sva-node?branch=master)

[![NPM](https://nodei.co/npm/quickteller-sva-node.png)](https://nodei.co/npm/quickteller-sva-node/)

[Installation](#installation) | [Constructor](#constructor) | [Billers](#billers) | [Banks](#banks) | [BillerCategories](#biller-categories) | [Customer](#customer) | [Funds](#funds) | [Transaction](#transaction)

## Installation

```bash
npm install quickteller-sva-node
```

## Constructor

```js
import QuickTellerSva from 'quickteller-sva-node'

const quickTellerSva = new QuickTellerSva(
{
apiSecret: API_SECRET,
clientId: CLIENT_ID,
terminalId: TERMINAL_ID,
environment: 'development'
}
)
```

* `apiSecret` - API secret from interswitch .
* `clientId` - Client id from interswitch.
* `terminalId` - Application terminal id from interswitch
* `environment` - Environment (production or development)

## Billers

### Get billers

```js
quickTellerSva
.BillersResource
.getBillers()
.then((response) => {
console.log('response', response)
})
.catch((err) => {
console.log('error', err)
})
```

### Get billers by category

```js
quickTellerSva
.BillersResource
.getBillersByCategory(25)
.then((response) => {
console.log('response', response)
})
.catch((err) => {
console.log('error', err)
})
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "quickteller-sva-node",
"version": "1.0.6",
"version": "1.0.7",
"description": "A Nodejs Library for Quickteller SVA API",
"main": "dist/index.js",
"scripts": {
Expand Down

0 comments on commit ceaec2e

Please sign in to comment.