> ## Documentation Index
> Fetch the complete documentation index at: https://docs.simplepay.mx/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment links



## OpenAPI

````yaml /openapi.json get /v1/payment-links
openapi: 3.1.0
info:
  title: SimplePay API
  version: '2026-06-13'
  description: >-
    Contrato público para integrar SimplePay desde un backend. Incluye
    únicamente operaciones para comercios y administración protegida de
    credenciales.
servers:
  - description: Live
    url: https://api.simplepay.mx
  - description: Sandbox
    url: https://api.test.simplepay.mx
security:
  - SimplePayApiKey: []
tags:
  - name: API keys
  - name: Hosted Checkout
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Webhooks
  - name: Digital Catalog
  - name: Payment Policy
  - name: Reporting
  - name: Workspace
  - name: Customer Hub
  - name: Bookable Payments
  - name: Table Pay
  - name: Physical Checkout
  - name: In-person Payments
  - name: Terminal
  - name: Tap to Pay
  - name: Ticketing
  - name: Admission Control
  - name: Intelligence
externalDocs:
  description: SimplePay developer documentation
  url: https://docs.simplepay.mx
paths:
  /v1/payment-links:
    get:
      tags:
        - Payment Links
      summary: List payment links
      operationId: listPaymentLinks
      responses:
        2XX:
          description: The merchant's payment links.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentLinkList'
components:
  schemas:
    PaymentLinkList:
      type: object
      additionalProperties: false
      required:
        - object
        - data
        - has_more
        - next_cursor
      properties:
        object:
          const: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/PaymentLink'
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
    PaymentLink:
      type: object
      additionalProperties: false
      required:
        - id
        - object
        - public_id
        - url
        - status
        - amount_source
        - manual_amount
        - currency
        - catalog_line_item_snapshot
        - payment_method_types
        - installment_options
        - installment_plan
        - checkout_session_ref
        - expires_at
        - revoked_at
        - metadata
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        object:
          const: payment_link
        public_id:
          type: string
          pattern: ^splink_[a-z0-9]{32}$
        url:
          type: string
          format: uri
          pattern: ^https://link\.simplepay\.mx/splink_[a-z0-9]{32}$
        status:
          enum:
            - active
            - inactive
            - archived
            - paid
        amount_source:
          enum:
            - manual_amount
            - catalog_line_item
        manual_amount:
          type:
            - integer
            - 'null'
        currency:
          type: string
          pattern: ^[a-z]{3}$
        catalog_line_item_snapshot:
          type:
            - object
            - 'null'
          additionalProperties: true
        payment_method_types:
          $ref: '#/components/schemas/PaymentMethodTypes'
        installment_options:
          $ref: '#/components/schemas/InstallmentOptionsRead'
        installment_plan:
          oneOf:
            - $ref: '#/components/schemas/InstallmentPlan'
            - type: 'null'
        installment_pricing:
          $ref: '#/components/schemas/InstallmentPricing'
        checkout_session_ref:
          type:
            - string
            - 'null'
          pattern: ^spcs_[a-z0-9]{32}$
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            UTC expiry timestamp, or null when the link does not expire
            automatically.
        revoked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            UTC merchant-revocation timestamp, or null while the link has not
            been revoked.
        metadata:
          type: object
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaymentMethodTypes:
      type: array
      minItems: 1
      items:
        enum:
          - card
          - oxxo
          - spei
      default:
        - card
    InstallmentOptionsRead:
      type: array
      description: >-
        Canonical installment terms offered by the resource; empty when
        installments are not offered.
      minItems: 0
      maxItems: 6
      uniqueItems: true
      items:
        $ref: '#/components/schemas/InstallmentPlan'
    InstallmentPlan:
      type: object
      additionalProperties: false
      description: >-
        One SimplePay card-installment term. The merchant offers terms at
        resource creation; the buyer may only select one offered term at
        quote/pay.
      required:
        - months
      properties:
        months:
          enum:
            - 3
            - 6
            - 9
            - 12
            - 18
            - 24
    InstallmentPricing:
      type: object
      additionalProperties: false
      description: >-
        Merchant-owned financing choice applied consistently to every offered
        term. absorb forbids buyer markup; pass_to_buyer may include a governed
        markup in basis points.
      required:
        - fee_allocation
      properties:
        fee_allocation:
          type: string
          enum:
            - absorb
            - pass_to_buyer
        merchant_markup_bps:
          type: integer
          minimum: 0
          maximum: 10000
      oneOf:
        - properties:
            fee_allocation:
              const: absorb
          not:
            required:
              - merchant_markup_bps
        - properties:
            fee_allocation:
              const: pass_to_buyer
  securitySchemes:
    SimplePayApiKey:
      type: http
      scheme: bearer

````