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

# Create Payment Link (Acquiring)

> The Payment > Payment Links > Create flow in the merchant dashboard — a three-step wizard (Basic / Settings / Review) to create a fixed-amount or custom-amount payment link; once created you can copy the link or scan the QR code to share it with customers.

## What this is

This is the **Create Payment Link** flow under the **Payments** module in the merchant dashboard (page title "Create Payment Link"). Reached by clicking **Create link** from the **Payment Links** list page, it's a full-screen, three-step form: **Basic → Settings → Review**. Once created, you get a shareable receiving link and QR code — send it to a customer (email, messaging, social media, or embed it on your site) and they complete payment at checkout. Use this flow whenever you want a link you can send out and start collecting payment on without integrating anything. A live preview (customer checkout / QR code / link appearance) on the right updates as you fill in the form.

> Clicking the **X** in the top right or **Cancel** at the bottom closes the flow and returns to the Payment Links list; unsubmitted content is not saved. Creating a payment link requires the relevant permission — without it, you cannot open this page to create one.

## Steps

**Step 1 · Basic**

1. On the **Payment Links** list page, click **Create link** to open the flow, starting on the **Basic** step.
2. Choose the **Payment type**:
   * **Fixed Amount** — you set the exact amount the customer pays;
   * **Custom Amount** — the customer enters the payment amount themselves.
3. Choose the **Currency** under **Currency & Amount**: pick a settlement currency from the dropdown, defaulting to SGD.
4. Enter the **Amount**:
   * For **Fixed Amount**, enter the amount to collect in the amount field under Currency & Amount (up to two decimal places, must be greater than 0).
   * For **Custom Amount**, you don't set a fixed amount, but you can optionally set **Amount limits** — a **Minimum amount** and **Maximum amount** to constrain what the customer can enter (leave blank for no limit; if both are set, the maximum must not be less than the minimum).
5. Fill in **Link details**:
   * **Name** (required, up to 250 characters) — shown to the customer at checkout, e.g. "Premium T-shirt" or "Monthly subscription".
   * **Description** (optional, up to 300 characters) — a short description visible to the customer.
6. (Fixed Amount only) to cap how many times this link can be used, turn on **Limit payments** and enter the maximum number of payments allowed (at least 1).
7. Click **Continue** in the bottom right to move to the next step.

**Step 2 · Settings** — everything in this step is optional:

1. **Image** (optional): upload a display image (JPEG, JPG, or PNG, up to 2 MB).
2. **Internal Reference** (optional): enter a note or code visible only to your own account (e.g. `REF-123`, up to 100 characters) for your own reconciliation — customers never see it.
3. **Active Until** (optional): pick an expiry date; the link stops working after that date. Leave it unset for the link to stay active indefinitely. You cannot pick a past date.
4. Click **Continue** to move to Review.

**Step 3 · Review**

1. On the **Review Payment Link** page, check all three sections: **Payment Details** (type / currency / amount / payment limit), **Link Information** (name / description), and **Settings** (image / internal reference / expiry).
2. To change anything, click the edit icon in that section's top right to jump back to the relevant step.
3. Once everything checks out, click **Create Payment Link** in the bottom right.

**After a successful creation**

* The page shows "Payment link created!" along with a shareable **link URL** (with a copy button) and a **QR code**.
* Copy the link or the QR code to send to a customer for payment; you can also click **Create another** to start another link, or **Back to payment links** to return to the list.

## Fields and statuses

**Payment type:**

| Type          | Meaning                                                                                               |
| ------------- | ----------------------------------------------------------------------------------------------------- |
| Fixed Amount  | You set the exact amount the customer pays                                                            |
| Custom Amount | The customer enters the amount themselves at checkout (you can optionally set minimum/maximum limits) |

**Basic step fields:**

| Field                           | Meaning                                                               | Notes                                                                        |
| ------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| Currency                        | The settlement currency for this link                                 | Defaults to SGD                                                              |
| Amount                          | The amount to collect for a fixed-amount link                         | Only for Fixed Amount; must be greater than 0, up to two decimal places      |
| Minimum amount / Maximum amount | The lower/upper bound the customer can enter for a custom-amount link | Only for Custom Amount, both optional; maximum must not be less than minimum |
| Name                            | The payment link's name, visible to the customer                      | Required, up to 250 characters                                               |
| Description                     | A short description visible to the customer                           | Optional, up to 300 characters                                               |
| Limit payments                  | When enabled, caps the maximum number of times this link can be paid  | Only available for Fixed Amount; at least 1 payment                          |

**Settings step fields (all optional):**

| Field              | Meaning                                                             | Notes                                                                 |
| ------------------ | ------------------------------------------------------------------- | --------------------------------------------------------------------- |
| Image              | A display image for the link                                        | JPEG / JPG / PNG, up to 2 MB                                          |
| Internal Reference | A note or code visible only to your own account, for reconciliation | Not visible to customers, up to 100 characters                        |
| Active Until       | The link's expiry date, after which it stops working                | Leave unset for it to stay active indefinitely; cannot be a past date |

**The three steps:** Basic, Settings, Review — a step indicator at the top shows current progress (step X of 3); completed steps can be clicked to go back and edit.

## Edge cases and troubleshooting

* **Can't get into this page / can't create a payment link**: this usually means you lack the permission to create payment links — ask an admin to grant it.
* **The "Continue" button is greyed out**: **Name** is required in the Basic step; if you chose **Fixed Amount**, the amount must also be filled in and greater than 0 — the button stays disabled until both are met.
* **Amount shows "must be greater than 0"**: a fixed amount must be a positive number, up to two decimal places.
* **Custom amount shows "must be greater than minimum"**: the maximum amount can't be less than the minimum — adjust and continue.
* **Can't enter 0 for "Limit payments"**: the maximum number of payments must be at least 1.
* **Image won't upload / says it's too large**: images only support JPEG, JPG, or PNG, and must be no more than 2 MB — try a smaller image or a different format.
* **Some dates aren't selectable for "Active Until"**: you can't pick a past date; the link is still active on its expiry date and stops working the day after.
* **Don't want an expiry**: leave **Active Until** blank and the link stays active indefinitely (the Review step shows "No expiry").
* **Does the customer see "Internal Reference"?** No — it's visible only to your own account and is used only for your own reconciliation records.
* **Where's the link and QR code after a successful creation?** They're on the "Payment link created" page — copy the link or save a screenshot of the QR code; you can also find the link again from the Payment Links list.

## Common questions (Q\&A)

* **Q: How do I create a payment link / receiving link?** A: On **Payment Links**, click **Create link**, then go through Basic (choose type/currency/amount, fill in the name) → Settings (image/internal reference/expiry, all optional) → Review → click **Create Payment Link**; once created, copy the link or QR code to send to your customer.
* **Q: What's the difference between Fixed Amount and Custom Amount?** A: Fixed Amount means you set the exact amount the customer pays; Custom Amount lets the customer enter their own amount, optionally within a minimum/maximum you set.
* **Q: How do I let the customer type in their own payment amount?** A: Choose **Custom Amount** as the payment type; you can optionally set a minimum/maximum under **Amount limits** (or leave it unrestricted).
* **Q: What's the payment link name for — do I have to fill it in?** A: The name is required, up to 250 characters, and is shown to the customer at checkout; use something descriptive like "Monthly subscription".
* **Q: Can I limit a link to a certain number of payments?** A: Yes — for Fixed Amount links only, turn on **Limit payments** and enter the maximum number (at least 1).
* **Q: What's "Internal Reference"? Can customers see it?** A: It's a note or code visible only to your own account (up to 100 characters), used for your own reconciliation — customers never see it.
* **Q: Can I set an expiry date on a payment link?** A: Yes — in the Settings step, pick a date under **Active Until**; the link stops working after that date. Leave it unset to keep the link active indefinitely.
* **Q: Can I upload an image? What are the requirements?** A: Yes, one display image, in JPEG / JPG / PNG format, up to 2 MB.
* **Q: How do I send the link to a customer after creating it?** A: The success page has a copyable link URL and a QR code, which you can send by email, messaging, social media, or embed on your website.
* **Q: What payment methods can the customer use?** A: Customers can pay with credit card, debit card, or other supported payment methods through the checkout page.
* **Q: I filled things in but don't want to create it — how do I exit?** A: Click the **X** in the top right or **Cancel** at the bottom to return to Payment Links; unsubmitted content is not saved.
* **Q: How many decimal places can the amount have?** A: Up to two decimal places, and a fixed amount must be greater than 0.
