Update Link

Update information for an existing payment link

/payLinks/api/

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

This enpoint allows you to update a created paymentlink

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 Sucessfull

{
    "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
        }
    }
}