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

# List payment links



## OpenAPI

````yaml /checkout/openapi.yaml get /v1/payment-links
openapi: 3.1.0
info:
  title: Kalixo Checkout API
  version: '2026-10-01'
  summary: Payment orchestration API for Kalixo partners.
  description: >
    Kalixo Checkout lets partners collect payments from their shoppers through
    one

    provider-neutral API. Kalixo is merchant of record and handles payment

    processing, so partners never integrate a payment provider directly.


    - Amounts are integers in the currency's minor unit (EUR 49.99 = `4999`).

    - Server endpoints use a secret key (`kc_sk_test_...` or `kc_sk_live_...`).

    - Client endpoints are called by `Kalixo.js` with a publishable key and the
      checkout session's `client_secret`.
    - Every `POST` with a secret key requires an `Idempotency-Key` header.
  contact:
    name: Kalixo Checkout integrations
    email: integrations@kalixo.io
  license:
    name: Proprietary
    url: https://kalixo.io/legal
servers:
  - url: https://checkout.kalixo.io
    description: Live
  - url: https://sandbox.checkout.kalixo.io
    description: Sandbox (test keys only, connected to the provider test environment)
security:
  - secretKey: []
tags:
  - name: Checkout sessions
    description: >-
      Create a session with the amount to charge, then show it with Kalixo.js or
      the hosted checkout.
  - name: Payments
    description: Read payments and capture or cancel authorized payments.
  - name: Refunds
    description: Full and partial refunds of captured payments.
  - name: Payment links
    description: Kalixo-hosted payment links that survive provider switches.
  - name: Customers
    description: Customers and their stored payment methods for one-click checkout.
  - name: Disputes
    description: Chargebacks and information requests, plus evidence upload.
  - name: Events
    description: The event log behind webhooks.
  - name: Webhook endpoints
    description: Where Kalixo delivers signed events.
  - name: Reports
    description: CSV exports of transactions for reconciliation and partner invoicing.
  - name: Client
    description: Called by Kalixo.js and the hosted checkout. Not for partner servers.
paths:
  /v1/payment-links:
    get:
      tags:
        - Payment links
      summary: List payment links
      operationId: listPaymentLinks
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/StartingAfter'
      responses:
        '200':
          description: A page of payment links.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ListEnvelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/PaymentLink'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    StartingAfter:
      name: starting_after
      in: query
      description: Cursor from a previous page's `next_cursor`.
      schema:
        type: string
  schemas:
    ListEnvelope:
      type: object
      required:
        - object
        - data
        - has_more
      properties:
        object:
          type: string
          const: list
        data:
          type: array
          items: {}
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
    PaymentLink:
      type: object
      required:
        - id
        - object
        - url
        - status
        - amount
        - currency
        - country
        - reference
        - reusable
        - capture_method
        - created_at
        - metadata
      properties:
        id:
          type: string
          examples:
            - plink_01JABCDEF
        object:
          type: string
          const: payment_link
        url:
          type: string
          format: uri
        status:
          type: string
          enum:
            - active
            - inactive
            - completed
            - expired
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        country:
          $ref: '#/components/schemas/Country'
        reference:
          type: string
        description:
          type:
            - string
            - 'null'
        reusable:
          type: boolean
          description: If true the link can be paid more than once.
        capture_method:
          $ref: '#/components/schemas/CaptureMethod'
        return_url:
          type:
            - string
            - 'null'
          format: uri
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        payments_count:
          type: integer
        metadata:
          $ref: '#/components/schemas/Metadata'
        created_at:
          type: string
          format: date-time
    Amount:
      type: integer
      format: int64
      minimum: 0
      description: Amount in the currency's minor unit.
    Currency:
      type: string
      pattern: ^[A-Z]{3}$
      description: ISO 4217 currency code, uppercase.
      examples:
        - EUR
    Country:
      type: string
      pattern: ^[A-Z]{2}$
      description: ISO 3166-1 alpha-2 country code of the shopper.
      examples:
        - NL
    CaptureMethod:
      type: string
      enum:
        - automatic
        - manual
    Metadata:
      type: object
      description: >-
        Up to 50 keys. Keys up to 40 characters, values up to 500 characters.
        Echoed back unchanged.
      additionalProperties:
        type: string
        maxLength: 500
      maxProperties: 50
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - not_found_error
                - idempotency_error
                - payment_error
                - rate_limit_error
                - api_error
            code:
              type: string
              examples:
                - amount_locked
            decline_code:
              type:
                - string
                - 'null'
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            request_id:
              type: string
  responses:
    Error:
      description: Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Secret key, `kc_sk_test_...` or `kc_sk_live_...`. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.