> ## Documentation Index
> Fetch the complete documentation index at: https://epayclub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Payment Links

> Create a payment link for your customer.

<Tip>
  This endpoint **doesn't require** encryption.
</Tip>

<ParamField body="Name" type="string" required>
  The name displayed on the payment form.
</ParamField>

<ParamField body="Description" type="string" required>
  Additional information about the payment form.
</ParamField>

<ParamField body="PaymentType" type="string" required>
  Specify the payment type as either`SC`, `MC` and `SUB`. Learn more about supported payments for payment links [here](/api-reference/payment-link/fetch-link-type).
</ParamField>

<ParamField body="Currency" type="string" default="NGN" required>
  The transaction currency. This defaults to NGN.
</ParamField>

<ParamField body="AuthOption" type="string" required>
  Authentication method, specify `AUTH` for 3DS and `NOAUTH` for NoAuth payments.
</ParamField>

<ParamField body="Amount" type="string">
  The transaction amount. Leave empty to allow the customer enter the amount value on the payment form.
</ParamField>

<ParamField body="Mobile" type="string">
  The customer's mobile number.
</ParamField>

<ParamField body="BackgroundImage" type="string">
  Specify the URL for the background image.
</ParamField>

<ParamField body="Website" type="string">
  Specify the redirect URL for completed payments.
</ParamField>

<ParamField body="Limit" type="string">
  The number of subscribers that can use this payment link.
</ParamField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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"
  }
  ```

  ```json 400 theme={null}
  {
      "status": "failed",
      "statusCode": "VAL400",
      "message": "The Name field is required."
  }
  ```
</ResponseExample>