Create Link

Create new payment link to receive payments

/payLinks/api

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

This enpoint allows you create payment links

Headers

Name	Type	Description
Authorization*	String	Bearer Token

Request Body

Name	Type	Description
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
email	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

200: OK Link Successfully Created

{
    "data": {
        "paymentLinks": {
            "publicKey": "publickey",
            "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
        }
    }
}