Payment Links

Get merchant link

1
http://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/publickey
Copied!

Response

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
}
Copied!

Create payment Link

1
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api
Copied!

Request

1
{
2
"status":"ACTIVE",
3
"paymentLinkName": "Donationas",
4
"description":"Aunty Best Donation",
5
"currency": "NGN",
6
"successMessage":"Payment made successfully!",
7
"publicKey":"PublicKey",
8
"customizationName":"utbesti22",
9
"paymentFrequency":"RECURRENT",
10
"email":"[email protected]",
11
"requiredFields": {
12
"address":true,
13
"amount":true,
14
"customerName":true,
15
"mobileNumber":true,
16
"invoiceNumber":false
17
},
18
"additionalData":"custom1:null||custom2:null||custom3:null", //optional
19
"linkExpirable":false,
20
"expiryDate":"",
21
"oneTime":false
22
23
}
Copied!

Response

1
{
2
"data": {
3
"paymentLinks": {
4
"publicKey": "SBPUBK_TCDUH6MNIDLHMJXJEJLBO6ZU2RNUUPHI",
5
"status": "ACTIVE",
6
"additionalData": "custom1:null||custom2:null||custom3:null",
7
"paymentLinkName": "Donationas",
8
"description": "Aunty Best Donation",
9
"successMessage": "Payment made successfully!",
10
"paymentLinkId": "000000000",
11
"currency": "USD",
12
"paymentFrequency": "RECURRENT",
13
"paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkId",
14
"customizationName": "utbesti22",
15
"environment": "LIVE",
16
"requiredFields": {
17
"address": true,
18
"amount": true,
19
"customerName": true,
20
"mobileNumber": true,
21
"invoiceNumber": false
22
},
23
"expiryDuration": 0,
24
"linkExpirable": false,
25
"createdAt": "2021-09-21T10:49:17.728",
26
"updatedAt": "2021-09-21T10:49:17.728",
27
"oneTime": false,
28
"splitPayment": false
29
}
30
}
31
}
Copied!
1
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api
Copied!

Request

1
{
2
"paymentLinkId":"0000000",
3
"status":"INACTIVE",
4
"description":"Test paymentLink",
5
"successMessage":"Payment made successfully!",
6
"businessName":"My Business",
7
"publicKey":"publickKey",
8
"customizationName":"my_link_3",
9
"paymentFrequency":"RECURRENT",
10
"email":"[email protected]",
11
"requiredFields": {
12
"address":true,
13
"amount":true,
14
"customerName":true,
15
"mobileNumber":true,
16
"invoiceNumber":false
17
},
18
"linkExpirable":false,
19
"expiryDate":"",
20
"oneTime":false
21
}
Copied!

Response

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
}
Copied!
1
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/deleteLink/paymentLinkId
Copied!

Response

1
{
2
"status": "Deleted"
3
}
Copied!
Last modified 28d ago