Back to home
INTEGRATION
PAYMENT FEATURES
AFTER PAYMENT
Payment Link
SeerBit payment link is a payment feature that allows merchant create a payment link and share to the customer, to make instant online payments.
Create Payment Link
POST
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api
Request Sample
The code snippet below shows an example response for creating a payment link
1curl --location 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '{
5 "status":"ACTIVE",
6 "paymentLinkName": "Donations",
7 "description":"Give out donations",
8 "currency": "NGN",
9 "successMessage":"Thank you for your payment",
10 "publicKey":"YOUR_PUBLIC_KEY",
11 "customizationName":"testing1",
12 "paymentFrequency":"ONE_TIME",
13 "paymentReference": "",
14 "email":"js@emaildomain.com",
15 "requiredFields": {
16 "address":true,
17 "amount":true,
18 "customerName":false,
19 "mobileNumber":true,
20 "invoiceNumber":false
21 },
22 "additionalData":"Customer Email: js@mailinator.com",
23 "linkExpirable":false,
24 "expiryDate":"",
25 "oneTime":false
26
27}'1var request = require('request');
2var options = {
3 'method': 'POST',
4 'url': 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api',
5 'headers': {
6 'Content-Type': 'application/json',
7 'Authorization': 'Bearer YOUR_ENCRYPTED_KEY'
8 },
9 body: JSON.stringify({
10 "status": "ACTIVE",
11 "paymentLinkName": "Donations",
12 "description": "Give out donations",
13 "currency": "NGN",
14 "successMessage": "Thank you for your payment",
15 "publicKey": "YOUR_PUBLIC_KEY",
16 "customizationName": "testing1",
17 "paymentFrequency": "ONE_TIME",
18 "paymentReference": "",
19 "email": "js@emaildomain.com",
20 "requiredFields": {
21 "address": true,
22 "amount": true,
23 "customerName": false,
24 "mobileNumber": true,
25 "invoiceNumber": false
26 },
27 "additionalData": "Customer Email: js@mailinator.com",
28 "linkExpirable": false,
29 "expiryDate": "",
30 "oneTime": false
31 })
32
33};
34request(options, function (error, response) {
35 if (error) throw new Error(error);
36 console.log(response.body);
37});1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'POST',
14 CURLOPT_POSTFIELDS =>'{
15 "status":"ACTIVE",
16 "paymentLinkName": "Donations",
17 "description":"Give out donations",
18 "currency": "NGN",
19 "successMessage":"Thank you for your payment",
20 "publicKey":"YOUR_PUBLIC_KEY",
21 "customizationName":"testing1",
22 "paymentFrequency":"ONE_TIME",
23 "paymentReference": "",
24 "email":"js@emaildomain.com",
25 "requiredFields": {
26 "address":true,
27 "amount":true,
28 "customerName":false,
29 "mobileNumber":true,
30 "invoiceNumber":false
31 },
32 "additionalData":"Customer Email: js@mailinator.com",
33 "linkExpirable":false,
34 "expiryDate":"",
35 "oneTime":false
36}',
37 CURLOPT_HTTPHEADER => array(
38 'Content-Type: application/json',
39 'Authorization: Bearer YOUR_ENCRYPTED_KEY'
40 ),
41));
42
43$response = curl_exec($curl);
44
45curl_close($curl);
46echo $response;Response Sample
The code snippet below shows an example response for creating a payment link
1{
2
3 "data": {
4 "paymentLinks": {
5 "publicKey": "SBPUBK_******************PHI",
6 "status": "ACTIVE",
7 "additionalData": "custom1:null||custom2:null||custom3:null",
8 "paymentLinkName": "Donationas",
9 "description": "Donation",
10 "successMessage": "Payment made successfully!",
11 "paymentLinkId": "000000000",
12 "currency": "NGN",
13 "paymentReference": "" // optional,
14 "paymentFrequency": "RECURRENT",
15 "paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkId",
16 "customizationName": "utbesti22",
17 "environment": "LIVE",
18 "requiredFields": {
19 "address": true,
20 "amount": true,
21 "customerName": true,
22 "mobileNumber": true,
23 "invoiceNumber": false
24 },
25 "expiryDuration": 0,
26 "linkExpirable": false,
27 "createdAt": "2021-09-21T10:49:17.728",
28 "updatedAt": "2021-09-21T10:49:17.728",
29 "oneTime": false,
30 "splitPayment": false
31 }
32 }
33
34}Get Merchant Payment Link
GET
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/{publickKey}
Response Sample
The code snippet below shows an example response to get all created links
1{
2 "currentPage": 0,
3 "responseCode": "00",
4 "payload": [
5 {
6 "businessId": "00000051",
7 "publicKey": "publickey",
8 "status": "ACTIVE",
9 "amount": 10000.00,
10 "customisationName": "SeerBitPay",
11 "additionalData": "",
12 "paymentLinkName": "SeerBit Payment Link",
13 "description": "Buy Items",
14 "paymentLinkId": "00000000",
15 "paymentFrequency": "ONE_TIME",
16 "paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkID",
17 "pocketReference": "",
18 "environment": "LIVE",
19 "requiredFields": {
20 "address": true,
21 "amount": false,
22 "customerName": true,
23 "mobileNumber": false,
24 "invoiceNumber": false
25 },
26 "expiryDuration": 0,
27 "linkExpirable": false,
28 "customTime": "",
29 "createdAt": "2021-07-17T12:05:55",
30 "updatedAt": "2021-07-17T12:05:55",
31 "oneTime": false,
32 "splitPayment": false
33 }
34 ],
35 "responseMessage": "successful"
36}Update Payment Link
PUT
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api
Request Sample
The code snippet below shows an example request for updating a payment link
1curl --location --request PUT 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer YOUR_ENCRYPTED_KEY' \
4--data-raw '{
5 "paymentLinkId":"0000000",
6 "status":"INACTIVE",
7 "description":"Test paymentLink",
8 "successMessage":"Payment made successfully!",
9 "businessName":"My Business",
10 "publicKey":"publickKey",
11 "customizationName":"my_link_3",
12 "paymentFrequency":"RECURRENT",
13 "email":"customer@seerbit.com",
14 "requiredFields": {
15 "address":true,
16 "amount":true,
17 "customerName":true,
18 "mobileNumber":true,
19 "invoiceNumber":false
20 },
21 "linkExpirable":false,
22 "expiryDate":"",
23 "oneTime":false
24
25}'1var request = require('request');
2var options = {
3 'method': 'PUT',
4 'url': 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api',
5 'headers': {
6 'Content-Type': 'application/json',
7 'Authorization': 'Bearer YOUR_ENCRYPTED_KEY'
8 },
9 body: JSON.stringify({
10 "paymentLinkId": "0000000",
11 "status": "INACTIVE",
12 "description": "Test paymentLink",
13 "successMessage": "Payment made successfully!",
14 "businessName": "My Business",
15 "publicKey": "publickKey",
16 "customizationName": "my_link_3",
17 "paymentFrequency": "RECURRENT",
18 "email": "customer@seerbit.com",
19 "requiredFields": {
20 "address": true,
21 "amount": true,
22 "customerName": true,
23 "mobileNumber": true,
24 "invoiceNumber": false
25 },
26 "linkExpirable": false,
27 "expiryDate": "",
28 "oneTime": false
29 })
30
31};
32request(options, function (error, response) {
33 if (error) throw new Error(error);
34 console.log(response.body);
35});1<?php
2
3$curl = curl_init();
4
5curl_setopt_array($curl, array(
6 CURLOPT_URL => 'https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api',
7 CURLOPT_RETURNTRANSFER => true,
8 CURLOPT_ENCODING => '',
9 CURLOPT_MAXREDIRS => 10,
10 CURLOPT_TIMEOUT => 0,
11 CURLOPT_FOLLOWLOCATION => true,
12 CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13 CURLOPT_CUSTOMREQUEST => 'PUT',
14 CURLOPT_POSTFIELDS =>'{
15 "paymentLinkId":"0000000",
16 "status":"INACTIVE",
17 "description":"Test paymentLink",
18 "successMessage":"Payment made successfully!",
19 "businessName":"My Business",
20 "publicKey":"publickKey",
21 "customizationName":"my_link_3",
22 "paymentFrequency":"RECURRENT",
23 "email":"customer@seerbit.com",
24 "requiredFields": {
25 "address":true,
26 "amount":true,
27 "customerName":true,
28 "mobileNumber":true,
29 "invoiceNumber":false
30 },
31 "linkExpirable":false,
32 "expiryDate":"",
33 "oneTime":false
34
35}',
36 CURLOPT_HTTPHEADER => array(
37 'Content-Type: application/json',
38 'Authorization: Bearer YOUR_ENCRYPTED_KEY'
39 ),
40));
41
42$response = curl_exec($curl);
43
44curl_close($curl);
45echo $response;Response Sample
The code snippet below shows an example response for updating a payment link
1{
2 "data": {
3 "paymentLinks": {
4 "publicKey": "PublicKey",
5 "status": "INACTIVE",
6 "description": "Test paymentLink",
7 "successMessage": "Payment made successfully!",
8 "paymentLinkId": "0000000",
9 "paymentFrequency": "RECURRENT",
10 "paymentLinkUrl": "null/my_link_3",
11 "customizationName": "my_link_3",
12 "environment": "LIVE",
13 "requiredFields": {
14 "address": true,
15 "amount": true,
16 "customerName": true,
17 "mobileNumber": true,
18 "invoiceNumber": false
19 },
20 "expiryDuration": 0,
21 "linkExpirable": false,
22 "updatedAt": "2021-09-21T11:12:57.404",
23 "oneTime": false,
24 "splitPayment": false
25 }
26 }
27}Delete a Payment Link
DEL
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/deleteLink/paymentLinkId
Response Sample
The code snippet below shows an example response for deleting a payment link
1{
2 "status": "Deleted"
3}Need something else?
If you have any questions or need general help, visit our support page
Signup for developer update
You can unsubscribe at any time. Read our privacy policy.