To initialize the transaction, you'll need to pass information such as email, first name, last name amount, publicKey, etc. Email and amount are required. You can also pass any other additional information in the metadata object field. Here is the full list of parameters you can pass:

Param	Type	Default	Required	Description
amount	`string`	undefined	`true`	Amount you want to debit customer e.g 1000.00, 10.00...
transactionId	`string`	undefined	`true`	Unique case sensitive transaction identification
email	`string`	undefined	`true`	Email address of customer
publicKey	`string`	undefined	`true`	Your public key from XpressPay.
currency	`string`	`NGN`	`true`	Currency charge should be performed in. Allowed only `NGN`.
mode	`string`	`Debug`	`true`	Allowed values are `Debug` or `Live`.
callBackUrl	`string`	your current url page	`false`	CallbackUrl is the url you want your customer to be redirected to when payment is successful. The default url is the page url where customer intialized payment.
metadata	`object`	empty `object`	`false`	Object containing any extra information you want recorded with the transaction.

{
      "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.

To verify payment, you'll need to pass information such as publicKey, transactionId and mode are required. Here is the full list of parameters you can pass:

Param	Type	Default	Required	Description
transactionId	`string`	undefined	`true`	Unique case sensitive transaction identification
publicKey	`string`	undefined	`true`	Your public key from XpressPay.
mode	`string`	`Debug`	`true`	Allowed values are `Debug` or `Live`.

{
    "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"
        }
      ]
    }
  }
}

Thanks! Olumuyiwa Aro

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Keywords

xpresspay

npm_xpresspay

Github Repository

npm_xpressPay

Demo

Get Started

Install

Usage

Sample Function Request and Responses

Request for calling InitialisePayment function.

Response from calling InitialisePayment function

Request for calling VerifyPayment function.

Response from calling VerifyPayment function

data object

histories objects ($values)

1. Using React

2. Using Angular

3. Using Vue

4. Using CDN

How can I thank you?

License

Keywords