Payment Links

Get merchant link

http://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/publickey

Response

{
"currentPage": 0,
"responseCode": "00",
"payload": [
{
"businessId": "00000051",
"publicKey": "publickey",
"status": "ACTIVE",
"amount": 10000.00,
"customisationName": "SeerBitPay",
"additionalData": "",
"paymentLinkName": "SeerBit Payment Link",
"description": "Buy Items",
"paymentLinkId": "00000000",
"paymentFrequency": "ONE_TIME",
"paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkID",
"pocketReference": "",
"environment": "LIVE",
"requiredFields": {
"address": true,
"amount": false,
"customerName": true,
"mobileNumber": false,
"invoiceNumber": false
},
"expiryDuration": 0,
"linkExpirable": false,
"customTime": "",
"createdAt": "2021-07-17T12:05:55",
"updatedAt": "2021-07-17T12:05:55",
"oneTime": false,
"splitPayment": false
}
],
"responseMessage": "successful"
}

Create payment Link

https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api

Request

{
"status":"ACTIVE",
"paymentLinkName": "Donationas",
"description":"Aunty Best Donation",
"currency": "NGN",
"successMessage":"Payment made successfully!",
"publicKey":"PublicKey",
"customizationName":"utbesti22",
"paymentFrequency":"RECURRENT",
"paymentReference": "" // optional
"email":"[email protected]",
"requiredFields": {
"address":true,
"amount":true,
"customerName":true,
"mobileNumber":true,
"invoiceNumber":false
},
"additionalData":"custom1:null||custom2:null||custom3:null", //optional
"linkExpirable":false,
"expiryDate":"",
"oneTime":false
}

Response

{
"data": {
"paymentLinks": {
"publicKey": "SBPUBK_TCDUH6MNIDLHMJXJEJLBO6ZU2RNUUPHI",
"status": "ACTIVE",
"additionalData": "custom1:null||custom2:null||custom3:null",
"paymentLinkName": "Donationas",
"description": "Aunty Best Donation",
"successMessage": "Payment made successfully!",
"paymentLinkId": "000000000",
"currency": "USD",
"paymentReference": "" // optional,
"paymentFrequency": "RECURRENT",
"paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkId",
"customizationName": "utbesti22",
"environment": "LIVE",
"requiredFields": {
"address": true,
"amount": true,
"customerName": true,
"mobileNumber": true,
"invoiceNumber": false
},
"expiryDuration": 0,
"linkExpirable": false,
"createdAt": "2021-09-21T10:49:17.728",
"updatedAt": "2021-09-21T10:49:17.728",
"oneTime": false,
"splitPayment": false
}
}
}
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api

Request

{
"paymentLinkId":"0000000",
"status":"INACTIVE",
"description":"Test paymentLink",
"successMessage":"Payment made successfully!",
"businessName":"My Business",
"publicKey":"publickKey",
"customizationName":"my_link_3",
"paymentFrequency":"RECURRENT",
"email":"[email protected]",
"requiredFields": {
"address":true,
"amount":true,
"customerName":true,
"mobileNumber":true,
"invoiceNumber":false
},
"linkExpirable":false,
"expiryDate":"",
"oneTime":false
}

Response

{
"data": {
"paymentLinks": {
"publicKey": "PublicKey",
"status": "INACTIVE",
"description": "Test paymentLink",
"successMessage": "Payment made successfully!",
"paymentLinkId": "0000000",
"paymentFrequency": "RECURRENT",
"paymentLinkUrl": "null/my_link_3",
"customizationName": "my_link_3",
"environment": "LIVE",
"requiredFields": {
"address": true,
"amount": true,
"customerName": true,
"mobileNumber": true,
"invoiceNumber": false
},
"expiryDuration": 0,
"linkExpirable": false,
"updatedAt": "2021-09-21T11:12:57.404",
"oneTime": false,
"splitPayment": false
}
}
}
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/deleteLink/paymentLinkId

Response

{
"status": "Deleted"
}
Copy link
On this page
Get merchant link
Response
Create payment Link
Request
Response
Update Payment Link
Request
Response
Delete Payment Link
Response