> ## Documentation Index
> Fetch the complete documentation index at: https://www.cashfree.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Payment Links
> Create and share Cashfree Payment Links via SMS, email, or WhatsApp to collect payments instantly with auto reminders and no-code product setup.
To create a payment link, first add your product and customer details. You can then share the payment link via SMS, email, WhatsApp, or any other platform. You can also set auto reminders to receive the payment.
## Create a payment link
You can create an unlimited number of payment links to collect payments from customers and track their payment status easily.
Follow these steps to create a payment link through the Merchant Dashboard:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to the **Payment Links Dashboard > All**.
3. Click the **Create Payment Link** button.
4. Select the payment link type:
* **All payment methods**: Allows customers to pay using any available payment method.
* **Only UPI**: Restricts payment to UPI methods only.
5. Fill in the **Payment reason** field with a description of the payment. For example, enter shoes if you are selling footwear.
6. Fill in the amount details:
* Select the currency type.
* Enter the exact amount to be paid.
* Optionally, enable **Allow partial payment** and set a minimum amount if you want to accept partial payments.
7. Complete the customer details section:
* **Phone number** (required): Enter the customer's mobile number. This will be used to send SMS notifications and payment confirmations.
* Select the notification preferences:
* Check the **Send SMS** checkbox to send the payment link via SMS.
* Check the **Send WhatsApp** checkbox to send the payment link via WhatsApp. For more information, refer to [WhatsApp Payment Links](/payments/no-code/whatsapp-payment-links).
* **Email ID** (optional): Enter the customer's email address to send payment link and receipt via email.
* **Name** (optional): Enter the customer's full name for personalised communication and record keeping.
8. Click the **Create & Send** button to create the payment link and share it with your customer.
You can create payment links programmatically using the Cashfree Payments API. This allows you to automate payment collection and integrate payment links into your business workflows.
### Prerequisites
* A valid Cashfree Merchant account.
* API keys generated from the [Merchant Dashboard](https://merchant.cashfree.com/dashboard/developers/api-keys).
### API endpoints
The following table lists the available API endpoints for payment links:
| API endpoint | Method | Description | Docs link |
| ---------------------------- | ------ | ----------------------------- | ---------------------------------------------------------------------------------------- |
| `/pg/links` | POST | Create a payment link | [Create Payment Link API](/api-reference/payments/latest/payment-links/create) |
| `/pg/links/{link_id}` | GET | Fetch payment link details | [Fetch Payment Link Details API](/api-reference/payments/latest/payment-links/get) |
| `/pg/links/{link_id}/cancel` | POST | Cancel a payment link | [Cancel Payment Link API](/api-reference/payments/latest/payment-links/cancel) |
| `/pg/links/{link_id}/orders` | GET | Get orders for a payment link | [Get Orders for a Payment Link API](/api-reference/payments/latest/payment-links/orders) |
#### Create payment link API flow
Use this endpoint to generate a payment link instantly for a customer.
```json theme={"dark"}
{
"customer_details": {
"customer_phone": "9876543210",
"customer_email": "johndoe@example.com",
"customer_name": "John Doe"
},
"link_amount": 100.00,
"link_currency": "INR",
"link_purpose": "Payment for order #123",
"link_partial_payments": false
}
```
```json theme={"dark"}
{
"cf_link_id": 123456789,
"link_id": "link_123",
"link_status": "ACTIVE",
"link_currency": "INR",
"link_amount": 100.00,
"link_url": "https://payments.cashfree.com/links/link_123",
"link_expiry_time": "2023-10-01T12:00:00+05:30",
"customer_details": {
"customer_phone": "9876543210",
"customer_email": "johndoe@example.com",
"customer_name": "John Doe"
}
}
```
#### Fetch payment link details API flow
Use this endpoint to retrieve details of a specific payment link using its `link_id`.
```http theme={"dark"}
GET /pg/links/link_123
```
```json theme={"dark"}
{
"cf_link_id": 123456789,
"link_id": "link_123",
"link_status": "ACTIVE",
"link_currency": "INR",
"link_amount": 100.00,
"link_url": "https://payments.cashfree.com/links/link_123",
"link_expiry_time": "2023-10-01T12:00:00+05:30",
"customer_details": {
"customer_phone": "9876543210",
"customer_email": "johndoe@example.com",
"customer_name": "John Doe"
}
}
```
#### Cancel payment link API flow
Use this endpoint to cancel an active payment link.
```http theme={"dark"}
POST /pg/links/link_123/cancel
```
```json theme={"dark"}
{
"link_id": "link_123",
"link_status": "CANCELLED",
"message": "Payment link cancelled successfully."
}
```
#### Get orders for a payment link API flow
Use this endpoint to fetch all orders created for a specific payment link.
```http theme={"dark"}
GET /pg/links/link_123/orders
```
```json theme={"dark"}
{
"link_id": "link_123",
"orders": [
{
"order_id": "order_001",
"order_status": "PAID",
"order_amount": 100.00,
"order_currency": "INR",
"order_time": "2023-10-01T12:10:00+05:30"
},
{
"order_id": "order_002",
"order_status": "FAILED",
"order_amount": 100.00,
"order_currency": "INR",
"order_time": "2023-10-01T12:15:00+05:30"
}
]
}
```
### Payment link webhook
Configure payment link webhooks to receive real-time notifications for payment link status updates. This enables you to build systems to update payment statuses and send customer communications.
To set up payment link webhooks:
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Go to **Payment Gateway > Developers > Webhooks**.
3. Add the webhook address and select payment link-related events.
4. Save the webhook configuration.
For more information, see [Payment Link Webhooks](/api-reference/payments/latest/payment-links/webhooks).
```json theme={"dark"}
{
"event": "PAYMENT_LINK_PAID",
"link_id": "link_123",
"order_id": "order_001",
"order_status": "PAID",
"order_amount": 100.00,
"order_currency": "INR",
"payment_time": "2023-10-01T12:10:00+05:30"
}
```
## UPI payment link
UPI payment links are unique URLs that let customers instantly pay using any UPI app (like Google Pay, PhonePe, or BHIM). When clicked, these links automatically open the customer's preferred UPI app with all payment details pre-filled.
To create a UPI payment link, follow these steps:
1. Navigate to **Payment Gateway > Payment Links > Create Payment Link**.
2. Under **Payment link type** select **One-time (UPI only)**.
## Payment link options
To send payment reminders automatically to your customers. Contact your Account Manager to activate auto reminders.
When you create payment links with **Send Auto Reminders** enabled, Cashfree sends reminders 1 day after you create the payment link, on the subsequent day, and 1 day before the payment link expires. Cashfree sends all reminders between 12 PM and 6 PM.
You can send any 3 payment reminders from the following available options:
* Based on payment link **creation date** - 1, 2, 3, 7, 14 days after creating the link
* Based on payment link **expiry date** - 1, 2, 3, 7, 14 days before the payment link expires
Example: A payment link is created on the 1st of September, and the expiry date is the 30th of September. You can send a maximum of three reminders to customers. You can select to send the reminders from the dates specified here - 1st, 2nd, 3rd, 7th, 14th day of creating the payment link/before the payment link expires.
You can either choose from the available messages or create a custom message.
## Create via batch upload
To use the batch feature, fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) with your business requirements. Cashfree Payments verifies the details and activates the feature for your account. While the feature is being activated, you can test the flow in the test environment.
Use the batch feature to create multiple payment links at once. Add all required details in a single file following the specified format, and upload it in the batch section. Download the sample file to check the required fields for the batch upload.
Cashfree Payments doesn't send SMS and email notifications instantly for batch uploads. Instead, notifications are scheduled randomly between 5 and 50 minutes after your upload. This prevents potential issues when you upload large batches, such as 50,000 entries at once.
## Track orders and payments
Each time a customer opens a payment link and attempts a payment, a new order is created for that link. This lets you track how many times the customer clicked the link before completing the full payment.
You can use this information to follow up with customers and improve your conversion rate.
To view order details for a payment link:
* Navigate to **Payment Gateway Dashboard > Payment Links > Orders**.
You can filter the list by date range. You can also filter by status: **Success**, **Pending**, **Failed**, **User Dropped**, or **Incomplete**.
## Payment link lifecycle
A payment link moves through different states from creation to completion. Here's what each status means:
| State | Description |
| ---------------- | --------------------------------------------------------------------------------------------------- |
| `ACTIVE` | Default state upon creation. Link is valid and ready to accept payments until cancelled or expired. |
| `PAID` | Payment completed in full. Link becomes inactive. |
| `PARTIALLY_PAID` | Partial payment received. Additional payments allowed. Customer reminders available. |
| `EXPIRED` | Link has exceeded its validity period. No longer accepts payments. |
| `CANCELLED` | Link manually cancelled by merchant. No longer accepts payments. |
The link starts as `ACTIVE` and transitions to other states based on payment activity or administrative actions.
## FAQs
posthog.capture('Accordion Clicked', { title: "How do I start using Payment Links with Cashfree?" })}>
Simply sign up for a Payment Links account, and Cashfree Payment Gateway will be automatically activated for your account. The Payment Links feature will be available inside the **Payment Gateway** product.\
All payments collected via the payment links are automatically updated in the **Reports** and **Transactions** module in Cashfree Payment Gateway.
Know more in the [Payment Links documentation](/payments/no-code/payment-link).
{" "}
posthog.capture('Accordion Clicked', { title: " Can I create a payment link for a restricted time period?" })}>
Yes, you can create a payment link in the Cashfree Payment Gateway Dashboard with an expiry limit to ensure you get paid within a specific timeframe.
posthog.capture('Accordion Clicked', { title: "What information do I need to provide to create Payment Links?" })}>
Enter the customer’s phone or email, amount, and purpose, then share the link. You can also enable SMS & Email notifications, set an expiry date, and allow partial payments for added flexibility.
See [Payment Links](/payments/no-code/payment-link#payment-link) to know more
posthog.capture('Accordion Clicked', { title: "How do I increase my payment link amount?" })}>
To update the amount on an existing payment link, follow these steps.
1. Sign in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Go to **Payment Gateway** > **Payment Links** > **All**.
3. Find the payment link in the table and click the **more options** icon (⋮) on that row.
4. Click **Edit**.
5. In the **Edit Payment Link** dialog, enter the new value in the **Amount** field.
6. Click **Update**.
**Result:** A confirmation message appears and the Amount column updates to reflect the new value.
For a complete list of fields you can edit, including payment reason and customer details, see [Edit Payment Link](/payments/no-code/customize/edit-payment-link).
Each Unified Payments Interface (UPI) payment link supports a maximum collection of ₹1 lakh. To collect a higher amount, select **All payment methods** instead of **Only UPI**, or distribute the total across multiple links or payments.
If an account or transaction limit prevents the update, raise a request using the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1).
posthog.capture('Accordion Clicked', { title: "Can I create Payment Links in bulk?" })}>
Yes, you can create Payment Links in bulk using the Batch feature. Simply fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1) with your business requirements, and we’ll verify and activate it for your account. Meanwhile, you can test the flow in the sandbox.
Once activated, upload a file with the required details in the Batch section. Download the sample file to check the format.
posthog.capture('Accordion Clicked', { title: "Can my customers make multiple partial payments on Payment Links?" })}>
Yes, you can enable **Partial Payments** and provide the minimum amount you
wish to collect for a Payment Link. The customer can choose to make multiple
payments, between the minimum amount and the link amount. Cashfree will notify
you of all partial payments done.
posthog.capture('Accordion Clicked', { title: "Are international payments supported on Payment Link?" })}>
Yes, it is possible to enable international payments on Cashfree Payment
Links. Talk to us and help us understand your business for quick activation.
If you have a **Paypal** account, connect **Paypal** to Cashfree and start
offering Paypal as a checkout option on the payment page instantly.
posthog.capture('Accordion Clicked', { title: "What are Orders?" })}>
Each time your customer opens a payment Link and attempts payment, a new
Order is created against that link. This gives you the information on how
many times the customer has visited the link before completely paying the full
amount. You can follow up with such customers and try to improve your
conversion rate.
posthog.capture('Accordion Clicked', { title: "What are Cashfree Payment Links and why should I use them?" })}>
Payment Links by Cashfree is the easiest way to receive payments from your customers for any goods or services, without taking them to any app or website.
Payment Link can be shared with the customer via different channels like WhatsApp, SMS, email, etc., and upon clicking the link, your customers can pay using all available payment methods. Cashfree Payments will notify you when payment(s) are made using the link.
Payment Links are a **no-code solution** that are used to accept online payments without any payment gateway integration required. Any business can create a payment link and collect online payments. No website required.
posthog.capture('Accordion Clicked', { title: "How can I create payment links for my business?" })}>
1. Go to **Payment Gateway Dashboard** > **Payment links** > **Create Payment Link**
2. List the reason, the amount and the customer details.
3. You can also select an expiry time for the link, a custom thank you message, add a note in the more section.
4. Click create and all set!
posthog.capture('Accordion Clicked', { title: "How can I create UPI payment links for my business?" })}>
Create and share UPI payment links with your customers to accept payments via UPI applications. To create a UPI payment link, you first need to add your product and customer details. You can share the payment link via SMS, email, WhatsApp, or any other platform. To make payments, customers must click the URL that you have sent, and a list of UPI apps installed on their mobile will be displayed. Customers can select any UPI app and complete the payment. A maximum amount of rupees 1 Lakh can be collected using the UPI payment link.
To create a UPI payment link:
1. Go to **Payment Gateway Dashboard** > **Payment Links** > click **Create Payment Link**.
2. Select the option **Create UPI Link**.
3. In the **Payment For** field, explain what the customer is making the payment for. Keep this text short and clear. This information is important for customers to understand the purpose of payment. Partial payments are not allowed for the UPI payment method.
4. Set the **Link Expiry** limit.
5. Enter the customer details (phone number and email ID) to send the payment link.
6. Select the option **Send Auto Reminders** to send payment reminders automatically to your customers.
7. Enable **Send Auto Reminders** option to notify your customers about the payment. See [Payment Links](/payments/no-code/payment-link) to know more.
8. You can add the **Link ID** and additional description for your reference. This will not be visible to your customers.
posthog.capture('Accordion Clicked', { title: "What information is required to create a Payment Link?" })}>
To quickly request payment from your customer via Payment Link, you simply need to provide the customer’s phone or email information, and the amount and purpose for the link. Once the details are entered, the link can be shared with the customer.
While creating a Payment Link, you can:
* Enable the **Send SMS** and **Email** checkboxes, and Cashfree will send the link to the customer on the provided contact information.
* Set the **expiry** for the link.
* Enable **partial payments** if you want the customer to make payments in parts.
posthog.capture('Accordion Clicked', { title: "Can I generate a report of all payment link transactions?" })}>
Yes, you can generate a report of all payment link transactions.\
The payment link orders report provides the list and details of orders and payments made against all payment links within the selected period. This includes order details, customer details, transaction amount, payment method, transaction status, settlement UTR (if the settlement is complete), and more.
To generate the payment link orders report:
1. Go to **Payment Gateway Dashboard** > **Reports**.
2. In the **Report Type** field, select **Payment Link Transactions**, and click **Generate**.
3. Select the date range for which you want to view the report, and click **Generate**.
The report will be generated based on your selected criteria. You can download the report after it has been generated.
posthog.capture('Accordion Clicked', { title: "Do I get notified when a payment is made on a payment link?" })}>
Yes, you can use webhooks to get notified about different events such as orders, payments, and settlements.
The **Payment Link webhook** will be triggered when your customer makes a complete or partial payment using the payment link you shared. You will also be notified via the same webhook when the payment link gets cancelled or expired.
posthog.capture('Accordion Clicked', { title: "How to cancel or delete a payment link?" })}>
You can’t permanently delete a payment link, but you can cancel it to stop receiving payments.
From the [Merchant Dashboard](https://merchant.cashfree.com/auth/login), click the **ellipsis (⋮)** icon next to the link and select **Cancel**.
From API: Use POST /links/{link_id_0}/cancel (works only for ACTIVE links).
Once cancelled, no further payments can be made.
See [Cancel a payment link](/payments/no-code/customize/cancel-payment-link) to know more.
posthog.capture('Accordion Clicked', { title: "Can I create a payment link for a restricted time period?" })}>
Yes, you can create a payment link in the Cashfree payment gateway dashboard, with an expiry limit to make sure you get paid within a specific timeframe.
posthog.capture('Accordion Clicked', { title: "How to share a Payment Link?" })}>
The payment link can be shared via SMS, email, Whatsapp or any other platform.
To create a TPV (Third-Party Validation) payment link from the Merchant Dashboard,
the TPV feature must be enabled on your MID (Merchant ID). If it isn't enabled yet,
see the Note below before proceeding.
1. Log in to the [Merchant Dashboard](https://merchant.cashfree.com/auth/login).
2. Navigate to **Payment Gateway** > **Payment Links** > **Create Payment Link**.
3. Fill in the payment link details, such as amount, purpose, and customer details.
4. In the **Add Notes** section, enter the following TPV parameters:
* `customer_bank_account_number`: The customer's bank account number.
* `customer_bank_ifsc`: The customer's bank IFSC code.
* `customer_bank_code` (optional): The customer's bank code.
5. Click **Create & Send** to generate and share the payment link.
When the customer pays using this link, the payment is validated against
the bank account details you provided.
The TPV feature must be activated on your MID before you can use this flow.
Contact your Account Manager or submit a request through the
[Support Form](https://merchant.cashfree.com/merchants/landing?env=prod\&raise_issue=1)
to enable it.
## Payment link lifecycle
A payment link moves through different states from creation to completion. Here's what each status means:
| State | Description |
| ---------------- | --------------------------------------------------------------------------------------------------- |
| `ACTIVE` | Default state upon creation. Link is valid and ready to accept payments until cancelled or expired. |
| `PAID` | Payment completed in full. Link becomes inactive. |
| `PARTIALLY_PAID` | Partial payment received. Additional payments allowed. Customer reminders available. |
| `EXPIRED` | Link has exceeded its validity period. No longer accepts payments. |
| `CANCELLED` | Link manually cancelled by merchant. No longer accepts payments. |
The link starts as `ACTIVE` and transitions to other states based on payment activity or administrative actions.
