Skip to main content
POST
https://checkout-api-service.epayclub.com
/
checkout
/
links
/
create
Create Payment Links
curl --request POST \
  --url https://checkout-api-service.epayclub.com/checkout/links/create \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "Name": "<string>",
  "Description": "<string>",
  "PaymentType": "<string>",
  "Currency": "<string>",
  "AuthOption": "<string>",
  "Amount": "<string>",
  "Mobile": "<string>",
  "BackgroundImage": "<string>",
  "Website": "<string>",
  "Limit": "<string>"
}
'
{
  "data": {
    "paymentLink": {
      "id": 133,
      "name": "Checkout TestAB",
      "paymentType": null,
      "logo": "https://merchant-api-service.devepayclub.com/subsidiary/dashboard/file/epayclub-compliance-images/download?fileId=",
      "amount": null,
      "dateCreated": "2025-04-15T00:16:33.984405",
      "reference": "vxwHip7xXm4xtPUtg0ZzDv$0noEby6MIPxG74O9nm4v3b1tby9mnErxfSOY_AZ0412",
      "createdBy": null,
      "creatorEmail": null,
      "isActive": true,
      "currency": "USD",
      "limit": 1,
      "paymentLinkUrl": "https://payment-link.devepayclub.com/vxwHip7xXm4xtPUtg0ZzDv$0noEby6MIPxG74O9nm4v3b1tby9mnErxfSOY_AZ0412",
      "appEnvironmentId": 1,
      "paymentLinkType": "Single Charge",
      "paymentLinkCode": "SC",
      "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"
}
This endpoint doesn’t require encryption.
​
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.
​
Currency
string
default:"NGN"
required
The transaction currency. This defaults to NGN.
​
AuthOption
string
required
Authentication method, specify AUTH for 3DS and NOAUTH for NoAuth payments.
​
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.
​
Limit
string
The number of subscribers that can use this payment link.
{
  "data": {
    "paymentLink": {
      "id": 133,
      "name": "Checkout TestAB",
      "paymentType": null,
      "logo": "https://merchant-api-service.devepayclub.com/subsidiary/dashboard/file/epayclub-compliance-images/download?fileId=",
      "amount": null,
      "dateCreated": "2025-04-15T00:16:33.984405",
      "reference": "vxwHip7xXm4xtPUtg0ZzDv$0noEby6MIPxG74O9nm4v3b1tby9mnErxfSOY_AZ0412",
      "createdBy": null,
      "creatorEmail": null,
      "isActive": true,
      "currency": "USD",
      "limit": 1,
      "paymentLinkUrl": "https://payment-link.devepayclub.com/vxwHip7xXm4xtPUtg0ZzDv$0noEby6MIPxG74O9nm4v3b1tby9mnErxfSOY_AZ0412",
      "appEnvironmentId": 1,
      "paymentLinkType": "Single Charge",
      "paymentLinkCode": "SC",
      "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"
}