# List payment links

> Query payment links by status, keyword, creation time, and pagination.

```yaml
openapi: 3.1.0
info:
  title: List payment links
  version: 1.0.0
  description: Query payment links by status, keyword, creation time, and pagination.
paths:
  /v1/txn/paymentLink/list:
    post:
      summary: List payment links
      description: Query payment links by status, keyword, creation time, and pagination.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                merchantNo:
                  type: string
                  description: Merchant number assigned by Onerway. See
                    [Setup](/payments/get-started/setup#retrieve-your-credentials)
                    for how to obtain it.
                linkStatus:
                  type: number
                  description: Payment link status filter. Omit this field to query all payment
                    links.
                  enum:
                    - "1"
                    - "0"
                  x-enum-descriptions:
                    "0": Disabled.
                    "1": Enabled.
                  x-onerway-constraints:
                    - kind: values
                      text: Submit numeric `1` or `0`; do not submit boolean `true` or `false` for
                        this list query.
                keywords:
                  type: string
                  description: Keyword filter. Supports fuzzy matching by Payment Link ID or goods
                    name.
                startTime:
                  type: string
                  description: Start of the payment link creation-time range in `yyyy-MM-dd
                    HH:mm:ss` format.
                endTime:
                  type: string
                  description: End of the payment link creation-time range in `yyyy-MM-dd
                    HH:mm:ss` format.
                current:
                  type: number
                  description: Page number for the list query. Both `0` and `1` mean the first
                    page; the response `current` value is returned as a 1-based
                    page number.
                size:
                  type: number
                  description: Page size for the list query.
                  x-onerway-constraints:
                    - kind: values
                      text: This endpoint currently uses a fixed page size of `10`.
                sign:
                  type: string
                  description: Request signature string. See [Request
                    signing](/payments/get-started/request-signing) for how to
                    generate it.
              required:
                - merchantNo
                - current
                - size
                - sign
            examples:
              list-payment-links:
                summary: List payment links
                value:
                  current: 1
                  endTime: 2026-05-25 23:59:59
                  keywords: payment_link_demo
                  linkStatus: 1
                  merchantNo: replace_with_merchant_no
                  sign: "{{SIGN}}"
                  size: 10
                  startTime: 2026-05-01 00:00:00
      responses:
        "200":
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  respCode:
                    type: string
                    description: "`20000` means the list query was processed successfully. Other
                      values are error codes. See [Response
                      codes](/payments/api-reference/response-codes)."
                  respMsg:
                    type: string
                    description: Human-readable message for the response code.
                  data:
                    type: object
                    properties:
                      content:
                        type: array
                        description: Payment link records that match the query conditions.
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Payment Link ID.
                            linkUrl:
                              type: string
                              description: URL for the customer to open the payment link checkout page.
                            merchantNo:
                              type: string
                              description: Merchant number assigned by Onerway, identifying the merchant
                                account.
                            linkName:
                              type: string
                              description: Display name for the payment link, used to identify the link in
                                list queries and merchant operations.
                            amount:
                              type: string
                              description: Payment link amount returned from the value used when the link was
                                created.
                            currency:
                              type: string
                              description: Payment link currency as a three-letter [ISO
                                4217](https://en.wikipedia.org/wiki/ISO_4217)
                                currency code.
                            defaultCountry:
                              type: string
                              description: Default country or region code configured for the payment link. The
                                recommended format is a two-letter [ISO 3166-1
                                alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
                                country code.
                            itemName:
                              type: string
                              description: Name of the goods or services shown to the customer.
                            description:
                              type: string
                              description: Description of the goods or services shown to the customer.
                            linkStatus:
                              type: number
                              description: Payment link status returned as numeric `1` or `0`.
                              enum:
                                - "1"
                                - "0"
                              x-enum-descriptions:
                                "0": Disabled.
                                "1": Enabled.
                              x-onerway-constraints:
                                - kind: values
                                  text: Submit numeric `1` or `0`; do not submit boolean `true` or `false` for
                                    this list query.
                            createTime:
                              type: string
                              description: Creation time in `yyyy-MM-dd HH:mm:ss` format.
                            visitCount:
                              type: string
                              description: Number of visits to the payment link.
                            payCount:
                              type: string
                              description: Number of successful payments completed through this payment link.
                            successAmount:
                              type: string
                              description: Total successful payment amount collected through this payment
                                link.
                      current:
                        type: string
                        description: Current page number in the response. The response is returned as a
                          1-based page number.
                      size:
                        type: number
                        description: Page size. The actual number of records on the current page is
                          `data.content.length`; use the response pagination
                          fields for the returned page size.
                      totalPages:
                        type: number
                        description: Total number of pages calculated from the current page size.
                      totalElements:
                        type: number
                        description: Total number of payment links that match the query conditions.
                    description: Business data object containing paginated payment link query
                      results.
```