Npm_xpresspay NPM

Github Repository

Please checkout our Github repo for more details

npm_xpressPay

This is a JavaScript library for implementing XpressPay payment gateway

Demo

Get Started

This Javascript library provides a wrapper to add XpressPay Payment to your React, Vue, Angular and any other Javascript Framework application

Install

npm install i npm_xpresspay

or with yarn

yarn add npm_xpresspay

Usage

This library can be implemented into any Javascript framework applications

Sample Function Request and Responses

Request for calling InitialisePayment function.

{
      "amount":  "2000.00", 
      "transactionId": "Math.floor(Math.random() * 1000000)", 
      "email": "sample@mail.com",
      "publicKey": "xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "currency": "NGN",
      "mode": "Debug",
      "callbackUrl": "window.location.href/?transactionId=12345678",
      "metadata": [
        {
          "name": "sample",
          "value": "test",
        },
      ],
}

Response from calling InitialisePayment function

Param	Type	Description
success	`boolean`	Shows whether the intialise payment function call was successful or not
message	`string`	description of the response data
data	`object`	it includes `authorizeUrl` which is the url that you will use to redirect your customers to make payment and `reference` which is the unique transaction identification generated from us.

{
  "success":true,
  "message":"sucessfully initialized payment",
  "data": {
                "authorizeUrl": "http://xpay.com/xxxxxxxx",
                "reference": "xxxxxxxx",
          }
}

Request for calling VerifyPayment function.

{
    "publicKey": "xxxxxxxxxxxxxx",
    "transactionId":"1234567890",
    "mode": "Debug",
}

Response from calling VerifyPayment function

Param	Type	Description
success	`boolean`	Shows whether the intialise payment function call was successful or not
message	`string`	description of the response data

data object

Param	Type	Description
amount	`string`	amount debited from customer
currency	`string`	amount currency
status	`string`	status from the transaction made by cusstomer
paymentType	`string`	type of payment made by customer eg Card, Bank, USSD, QR....
gatewayResponse	`string`	response from payment gateway
transactionId	`string`	unique transaction identification generated by you for the customer transaction.

histories objects ($values)

Param	Type	Description
type	`string`	Identicates the title of the summary of what happened during customer transaction on our payment page at a particular period of time. eg `action` which means customer inputed details or clicks a button `success` which means transaction was successful `error` which means error occured at the end of the transaction `redirect` which means user was redirected
message	`string`	Description of what customer did or happened during the particular period of making transaction on our payment page
status	`string`	The status from the transaction made by customer
date	`string`	The date customer or system executed this process
time	`string`	The time the customer or system executed this process

{
  "success":true,
  "message":"sucessfully initialized payment",
   "data": {
    "$id": "2",
    "amount": "10.00",
    "currency": "NGN",
    "status": "Transaction Successful",
    "paymentType":"Card",
    "gatewayResponse": "Transaction Successful. Approved",
    "transactionId": "1234567",
    "histories": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "type": "action",
          "message": "Filled these fields: card number, card expiry, card cvv and card pin",
          "date": "15 Sep 2021",
          "time": "08:14 AM"
        },
        {
          "$id": "5",
          "type": "action",
          "message": "Attempt to pay",
          "date": "15 Sep 2021",
          "time": "08:17 AM"
        },
         {
          "$id": "6",
          "type": "success",
          "message": "Successful transaction",
          "date": "15 Sep 2021",
          "time": "08:18 AM"
        },
        {
          "$id": "7",
          "type": "redirect",
          "message": "Redirected user back to your app",
          "date": "15 Sep 2021",
          "time": "08:19 AM"
        }
      ]
    }
  }
}