# List Payment Links

List of payment links.

#### **Method**

```

GET https://api.ninjapay.me/webextension/api/v1/fiat/realtime-payment-link/link?page=1&search=&by_date=&filter=&sort=

```

#### **Parameters**

* **page** : `String` - Page number for pagination
* **search**; `String` - search from title
* **by\_date** : `String` - Pass date in YYYY-MM-DD format (example 2024-01-01)
* **filter**: `String` - Filter according to transaction status
* **type**: `String` - Type of payment link list needed()

| Parameters | Input options                                                                       |
| ---------- | ----------------------------------------------------------------------------------- |
| type       | <p>Type of the payment link- </p><p>1 -> payment link<br>2 -> Subscription link</p> |
|            |                                                                                     |

#### **Response**

```json
{
    "status": true,
    "page": 1,
    "total_page": 1,
    "next": true,
    "data": [
        {
            "title": "",
            "received_amount": "1",
            "total_amount": "1",
            "currency": "INR",
            "allow_partial": false,
            "single_use": true,
            "cus_phone": "",
            "cus_email": "",
            "cus_name": "",
            "ask_during_payment": null,
            "only_phone_number": null,
            "only_email": null,
            "link_expiry": null,
            "remainder_on_sms": null,
            "remainder_on_whatsapp": null,
            "invoice": null,
            "enable_qr_code": true,
            "customer_reference_id": null,
            "include_cust_ref_payment_link": true,
            "redirect_url": null,
            "include_order_id_redirection": false,
            "custom_thanks_msg": null,
            "custom_logo_url": "",
            "custom_button_text": null,
            "terms_conditions": null,
            "reference_note": null,
            "created_at": "2024-08-02T06:08:54.000Z",
            "updated_at": "2024-08-02T06:08:54.000Z",
            "status": "PAID",
            "extras": null,
            "type": "1",
            "super_order_id": "FT_RTPL_SOJi9xjlZULk3GZTdCJtbN",
            "link_id": "RTLC5YwJUrJlTGdQZXoFMdZ",
            "is_plugin_linked": true,
            "is_api_call": false,
            "renew_at": null,
            "expiry_days": null,
            "custom_webhook": "https://api.ninjapay.me/webextension/api/v1/fiat/paywall/webhook",
            "cus_phone_code": "",
            "allow_tip": false,
            "reference_order_id": null,
            "link": "https://ninjapay.me/fiat/pl/RTLC5YwJUrJlTGdQZXoFMdZ"
        }
    ],
    "message": "List of payment links"
}
```

#### **Code Example**

{% code overflow="wrap" %}

```javascript
const params = new URLSearchParams({ page: 1 });

const options = {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'API_KEY'
  }
};

fetch('https://api.ninjapay.me/webextension/api/v1/fiat/realtime-payment-link/link'+params , options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
  
```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ninjapay.gitbook.io/ninjapay-api-docs/how-to/api-reference-upi/plugins/realtime-payment-links/list-payment-links.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.