---
title: "List payment links by widget ID"
method: POST
path: "/api/v1/payment-link/list"
tags: ["Payment Link"]
---

# List payment links by widget ID

`POST /api/v1/payment-link/list`

List payment links by widget ID

## Query parameters

- `amount` string, decimal
- `amount__gt` string, decimal
- `amount__gte` string, decimal
- `amount__lt` string, decimal
- `amount__lte` string, decimal
- `amount__range` Amount[]
- `created_at` string, date-time
- `created_at__gt` string, date-time
- `created_at__gte` string, date-time
- `created_at__lt` string, date-time
- `created_at__lte` string, date-time
- `created_at__range` string[]
- `ordering` string
- `page` integer
- `paid` boolean
- `search` string
- `status` 'active' | 'expired' | 'cancelled'
- `status__in` Status543Enum[]

## Request body

- PaymentLinkList
  - `widget_ids` string[], required

## Response `200`

- PaymentLinkListResponse
  - `id` string, required
  - `product_id` string, uuid, required
  - `url` string, required
  - `status` 'active' | 'expired' | 'cancelled'
  - `expires_at` string, date-time, nullable — Date the payment link will expire
  - `qr_code` string, nullable — Payment link qr code
  - `payment_data` PaymentData, required
    - `amount` string, decimal, nullable — Amount to be charged to a payment intent
    - `currency` string, nullable, required
    - `concept` string, nullable — Concept associated with the payment intent. This text will be reflected as a concept in the bank issuing the payment
    - `external_id` string, nullable — An external ID to identify a user. It can be the merchant's user ID or other tracking ID
  - `created_at` string, date-time, required — Date the payment link was created
  - `email` string, email, nullable — Email of the user that created the payment link
  - `reusable` boolean — If the payment link can be used multiple times
  - `intents` string[], required
  - `paid` boolean — If the payment link has been paid
  - `callback_url` string, url, nullable — URL to be called when the payment link status changes - **(SOON)**
  - `redirect_url` string, url, nullable — URL to redirect the user after the payment link is paid - **(SOON)**

## Other responses

- `400` — The client can't list payment links for another widget, wrong widget_ids format or missing widget_ids value

---

[API](https://skmtc.net/prometeoapi/apis/account-validation-v2.md) · [All operations](https://skmtc.net/prometeoapi/apis/account-validation-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prometeoapi/account-validation-v2/versions/9c278fe91cbd/schema)