Get Link
Fetch a list of created payment links
/payLinks/api/publicKey
GET
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/publicKey
This enpoint allows you to fetch a paymentlink created using merchant publickey
Headers
Authorization*
String
Bearer Token
Request Body
Status*
String
link status - (ACTIVE, INACTIVE)
paymentLinkName*
String
name of the link
description*
String
decription of this page
currency*
String
The transaction currency (NGN, GHS, KES,XOF or USD). Country Default currency must be passed
successMessage
String
Custom message to show customers after a successful payment
publicKey*
String
merchant publickey
customisationName
String
unique url extension for payment link
paymentFrequency*
String
ONE-TIME or RECURRENT
paymentReference
String
String
additionalData
String
additional data for payments
linkExpirable*
String
set true or false
expiryDate
String
set date
oneTime*
String
set true if you want the link to be used once or set false if you want the link to be used multiple times
amount*
String
true or false
customerName*
String
true
mobileNumber*
String
true or false if you need to collect customer number
{
"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"
}
Last updated