Webhook

A webhook allows your application to receive notifications when updates are made on your account on Payant. Webhook update notifications are sent as POST requests to a callback URL that you supply.
Setting Up a Webhook
The Payant Dashboard Settings to setup a webhook subscription. You will be required to specify:
Webhook URL - a URL to your endpoint that can process both verification and notification requests.
Verify Token - a string that you supply which we will include whenever we send a verification request.
Webhook URL
You need to setup a webhook endpoint before you setup a subscription to it on Payant. Your endpoint must be HTTPs and must be able to receive both GET and POST requests.

If you need help setting up HTTPs on your endpoint, check out the Getting Started Guide from Let's Encrypt
Verification Request
We'll send a GET request while setting up your webhook. The request will include the following parameters appended to the end of your webhook URL.
type=subscribe
challenge - A random string
verify_token - a string that you supply to setup the webhook
When your endpoint receives the verification request, it must:
Verify that the verify_token corresponds to the token your supplied when setting up your webhook.
Respond with the challenge value.
Notification Request
Whenever their are changes on your account, we will send a POST request to your webhook endpoint. The request will have a JSON payload as follows:
type - Notification type
data - An array containing the notification data
Webhook Server Example
We have created an example Node.js server for you to get started quickly.
​node-webhook-example by PayantNG​
1
{
2
  "name": "node-webhook-example",
3
  "version": "1.0.0",
4
  "description": "Webhook Example Node Server for Payant.ng",
5
  "main": "webhook.js",
6
  "scripts": {
7
    "start": "node webhook.js"
8
  },
9
  "author": "Payant Support <[email protected]>",
10
  "license": "ISC",
11
  "dependencies": {
12
    "body-parser": "^1.17.2",
13
    "express": "^4.15.3"
14
  }
15
}
Copied!
1
/**
2
 * Webhook Server
3
 *
4
 * @author Payant Support <[email protected]>
5
 * @version 1.0.0
6
 */
7
​
8
const express       =   require('express');
9
const bodyParser    =   require('body-parser');
10
let   app 	    = 	express();
11
​
12
app.use(bodyParser.json());
13
​
14
app.get('/webhook', (req, res) => {
15
	if(req.query.type === 'subscribe' && req.query.verify_token === 'VerifyToken') {
16
		console.log("Token validation successful.");
17
    	res.status(200).send(req.query.challenge);
18
	}else {
19
		console.error("Token validation failed. Make sure the validation tokens match.");
20
    	res.sendStatus(403);  
21
	}
22
});
23
​
24
app.post('/webhook', (req, res) => {
25
	var data = req.body;
26
​
27
	console.log("Data received: ", data);
28
​
29
	//Lastly send back a 200
30
	res.sendStatus(200);
31
})
32
​
33
app.listen(process.env.PORT || 8005);
Copied!

Fundamentals - Previous

Test Cards & Bank Accounts

Next - Accept Payment

Inline Payment

Last modified 2yr ago

Copy link

Contents

Webhook Server Example