> For the complete documentation index, see [llms.txt](https://docs.foloosi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.foloosi.com/payment-links/create-payment-links.md).

# Create payment links

This documentation will guide you to create payment link via API.

**NOTE**

* **A payment link can only be created when the API is set to live mode.**
* **For multi currency payment , "**allow\_multi\_currency" must be enabled for the merchant. If not , please contact Foloosi's support team.

### Basic Requirements

* Foloosi merchant account - [click here to sign up ](https://foloosi.com/business-signup).
* Create api credentials - [click here to create](/get-started/create-api-credentials.md).

### Steps to create Payment Link

```
// Create Payment Link
POST API LINK: https://api.foloosi.com/merchant/v1/payment-links/create

// Header
secret_key : YOUR_SECRET_KEY

// Post Body Fields
{
    "amount": "0.1",
    "currency": "AED",
    "link_type": "single",
    "notify_sms": "No",   // "Yes" || "No"
    "notify_email": "No",  // "Yes" || "No"
    "customer_email": "sample@gmail.com",
    "phone_code": "",
    "customer_mobile": "",
    "receipt_no": "",
    "description": ""
}

//Sample response
{
     "message":  "Payment link created successfully",
     "data" : {
        "payment_link_reference" : "FLSPL0068417d39ab70c" //Newly created reference number
      }
}

```

**TO GET THE PAYMENT LINK LIST**

<pre><code>// Get Payment Link List
<strong>GET API LINK: https://api.foloosi.com/merchant/v1/payment-links/list
</strong>
HEADERS:
secret_key : YOUR_SECRET_KEY

// PARAMS
q : {  
        "page":"1",
        "limit":"10",
        "link_type":"",   // "single" || "multiple"
        "payment_status":"",   // "success" || "pending"
        "from_date":"",    //dd-mm-yyyy
        "to_date":""    //dd-mm-yyyy
    }

SAMPLE RESPONSE:
{
    "message": "Payment links are",
    "data": {
        "payment_links": [
            {
                "reference_id": "FLSPL006819ba189c578",
                "transaction_amount": 0.1,
                "currency_code": "AED",
                "payment_description": "test",
                "customer_email": "",
                "customer_mobile": "",
                "receipt_no": "",
                "link_type": "single",
                "payment_status": "expired",
                "status": 1,
                "created": "2025-05-06T07:28:24+00:00"
            },
        ],
        "total_count": 2385  //total number of links created
    }
}
</code></pre>

**TO GET THE  PAYMENT LINK DETAILS**

```
// Get Payment Link Details
GET API LINK: https://api.foloosi.com/merchant/v1/payment-links/details/Your reference_id

HEADERS:
secret_key : YOUR_SECRET_KEY

SAMPLE RESPONSE:
{
    "message": "Payment Link details",
    "data": {
        "reference_id": "FLSPL0068417d39ab70c",
        "transaction_amount": 0.1,
        "currency_code": "AED",
        "payment_description": "",
        "customer_email": "",
        "customer_mobile": "+916379335488",
        "receipt_no": "",
        "notify_type": "sms",
        "link_type": "single",
        "payment_status": "expired",
        "status": 1,
        "created": "2025-06-05T11:19:21+00:00"
    }
}
```

&#x20;**FOR PAYMENT LINK STATUS CHANGE**

```
// Payment Link Status Change, Use PUT Method
PUT API LINK: https: https://api.foloosi.com/merchant/v1/payment-links/change-status

HEADERS:
secret_key : YOUR_SECRET_KEY

// POST Body Feilds
{
    "payment_link_reference": "FLSPL0068417d39ab70c"
}

SAMPLE RESPONSE:
{
    "message": "Link status changed successfully",
    "data": {
        "status": "active" || "inactive"
    }
}
```

**NOTE**

Supports 170 World Currencies

## Properties

List of properties available:

| Name             | Type   | Required                                                                | Description                                                                                              |
| ---------------- | ------ | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| amount           | string | true                                                                    | Amount for transaction                                                                                   |
| currency         | string | true                                                                    | Valid 3-letter currency code (e.g., AED, INR, USD).                                                      |
| description      | string | true                                                                    | Reason/note for creating payment link                                                                    |
| link\_type       | string | true                                                                    | single/multiple usage payment link                                                                       |
| notify\_sms      | string | true                                                                    | If "Yes", sms notification will be sent to the number provided under customer\_mobile.                   |
| notify\_email    | string | true                                                                    | if "Yes",  email will be sent to the emaiId provided under customer\_email                               |
| customer\_email  | string | <p>false <br>\[Required when notify\_email is "Yes"]</p>                | email notification will be sent to the given email id                                                    |
| phone\_code      | string | <p>false</p><p>\[Required when customer\_mobile field is not empty]</p> | <p>The country phone code in international format.<br><strong>Examples:</strong> <br>+971,971,91,+91</p> |
| customer\_mobile | string | <p>false</p><p>\[Required when notify\_sms is "Yes"]</p>                | Sms notification will be sent to the given mobile number                                                 |
| receipt\_no      | string | false                                                                   | Any (self reference for each payment link)                                                               |

#### Support

Visit  <https://www.foloosi.com> for support requests or email to <tech@foloosi.com>.

## Developed by

Foloosi Technologies Pvt Ltd.

## License

Copyrights (c) 2025 Foloosi