Skip to main content
PATCH
https://checkout-api-service.epayclub.com
/
checkout
/
links
/
{id}
/
edit
Edit Payment Link
curl --request PATCH \
  --url https://checkout-api-service.epayclub.com/checkout/links/{id}/edit \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "Name": "<string>",
  "Description": "<string>",
  "PaymentType": "<string>",
  "Amount": "<string>",
  "Mobile": "<string>",
  "BackgroundImage": "<string>",
  "Website": "<string>",
  "AuthOption": "<string>",
  "Limit": "<string>"
}
'
{
    "data": {
        "paymentLink": {
            "id": 125,
            "name": "Checkout TestA",
            "paymentType": null,
            "logo": "",
            "amount": null,
            "dateCreated": "2025-04-14T01:03:38.532696",
            "reference": "cONEmanSJGVvUaGI5Vq31qtaLDt1RR7OGMMgNNcZxZgEWBZLAiW3u12",
            "createdBy": null,
            "creatorEmail": null,
            "isActive": true,
            "currency": "NGN",
            "limit": null,
            "paymentLinkUrl": "cONEmanSJGVvUaGI5Vq31qtaLDt1RR7OGMMgNNcZxZgEWBZLAiW3u12",
            "appEnvironmentId": 1,
            "paymentLinkType": "Subscription Payments",
            "paymentLinkCode": "SUB",
            "description": "A Demo to understand how payment links work."
        },
        "subsidiary": {
            "id": 1,
            "name": "Merchant Epayclub",
            "country": "NG",
            "supportEmail": "merchant@epayclub.com",
            "customization": null
        }
    },
    "status": "success",
    "statusCode": "00",
    "message": "Payment details fetched successfully"
}
​
id
string
required
The Payment link’s ID.
​
Name
string
required
The name displayed on the payment form.
​
Description
string
required
Additional information about the payment form.
​
PaymentType
string
required
Specify the payment type as eitherSC, MC and SUB. Learn more about supported payments for payment links here.
​
Amount
string
The transaction amount. Leave empty to allow the customer enter the amount value on the payment form.
​
Mobile
string
The customer’s mobile number.
​
BackgroundImage
string
Specify the URL for the background image.
​
Website
string
Specify the redirect URL for completed payments.
​
AuthOption
string
Authentication method, specify AUTH for 3DS and NOAUTH for NoAuth payments.
​
Limit
string
The number of subscribers that can use this payment link.
{
    "data": {
        "paymentLink": {
            "id": 125,
            "name": "Checkout TestA",
            "paymentType": null,
            "logo": "",
            "amount": null,
            "dateCreated": "2025-04-14T01:03:38.532696",
            "reference": "cONEmanSJGVvUaGI5Vq31qtaLDt1RR7OGMMgNNcZxZgEWBZLAiW3u12",
            "createdBy": null,
            "creatorEmail": null,
            "isActive": true,
            "currency": "NGN",
            "limit": null,
            "paymentLinkUrl": "cONEmanSJGVvUaGI5Vq31qtaLDt1RR7OGMMgNNcZxZgEWBZLAiW3u12",
            "appEnvironmentId": 1,
            "paymentLinkType": "Subscription Payments",
            "paymentLinkCode": "SUB",
            "description": "A Demo to understand how payment links work."
        },
        "subsidiary": {
            "id": 1,
            "name": "Merchant Epayclub",
            "country": "NG",
            "supportEmail": "merchant@epayclub.com",
            "customization": null
        }
    },
    "status": "success",
    "statusCode": "00",
    "message": "Payment details fetched successfully"
}