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
    "paymentReference": ""  // optional
11
    "email":"[email protected]",
12
    "requiredFields": {
13
        "address":true,
14
        "amount":true,
15
        "customerName":true,
16
        "mobileNumber":true,
17
        "invoiceNumber":false
18
    },
19
    "additionalData":"custom1:null||custom2:null||custom3:null", //optional
20
    "linkExpirable":false,
21
    "expiryDate":"",
22
    "oneTime":false
23
​
24
}
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
            "paymentReference": ""  // optional,
13
            "paymentFrequency": "RECURRENT",
14
            "paymentLinkUrl": "https://pay.seerbitapi.com/paymentLinkId",
15
            "customizationName": "utbesti22",
16
            "environment": "LIVE",
17
            "requiredFields": {
18
                "address": true,
19
                "amount": true,
20
                "customerName": true,
21
                "mobileNumber": true,
22
                "invoiceNumber": false
23
            },
24
            "expiryDuration": 0,
25
            "linkExpirable": false,
26
            "createdAt": "2021-09-21T10:49:17.728",
27
            "updatedAt": "2021-09-21T10:49:17.728",
28
            "oneTime": false,
29
            "splitPayment": false
30
        }
31
    }
32
}
Copied!
Update Payment Link
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!
Delete Payment Link
1
https://paymentlink.seerbitapi.com/paymentlink/v2/payLinks/api/deleteLink/paymentLinkId
Copied!
Response
1
{
2
    "status": "Deleted"
3
}
Copied!
Get Merchant Subscription
Payout
Last modified 2mo ago
Copy link
Contents