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

# List one-time payments

> Your one-time payment links. Create and cancel them through the unversioned `/one-time-payment` endpoints.



## OpenAPI

````yaml GET /developer/v1/one-time-payment
openapi: 3.1.0
info:
  title: Compago API
  version: 1.0.0
  description: >-
    Public and private API endpoints for Compago's payment infrastructure. This
    specification currently includes endpoints for one-time payments. More
    endpoints will be added as the platform evolves.
servers:
  - url: https://demo-api-harmony.compago.com/api
  - url: https://api-harmony.compago.com/api
security: []
tags:
  - name: OneTimePayment
    description: Endpoints for creating and processing one-time payment links
  - name: PaymentMethod
    description: >-
      Endpoints for saving cards, charging saved payment methods, holding and
      capturing funds, and processing refunds
  - name: PaymentIntent
    description: >-
      Endpoints for creating and managing card-present payment intents for POS
      terminal integrations
  - name: Payments
    description: Read the payments your organization has taken
  - name: Subscriptions
    description: Read and manage recurring billing agreements
  - name: PaymentLinks
    description: Create, edit and retire hosted checkout links
  - name: Products
    description: Manage the catalogue behind product-based payment links
  - name: Promotions
    description: Read the promotions your organization funds or benefits from
  - name: Salespeople
    description: Read the point-of-sale operators in your organization
  - name: Organization
    description: Read your organization profile and its members
  - name: SavedCards
    description: Read saved payment methods and their payments
paths:
  /developer/v1/one-time-payment:
    get:
      tags:
        - OneTimePayments
      summary: List one-time payments
      description: >-
        Your one-time payment links. Create and cancel them through the
        unversioned `/one-time-payment` endpoints.
      operationId: listPublicOneTimePayments
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Rows per page. Values above 100 are rejected.
        - name: cursor
          in: query
          schema:
            type: string
          description: >-
            Opaque cursor from a previous response's `pagination.nextCursor`.
            Omit for the first page.
        - name: status
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - PENDING
                  - CONFIRMED
                  - CANCELLED
              - type: array
                items:
                  type: string
                  enum:
                    - PENDING
                    - CONFIRMED
                    - CANCELLED
          description: Filter by status.
        - name: expired
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: Filter by whether the link has expired.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicOneTimePayment'
                  pagination:
                    $ref: '#/components/schemas/PublicPagination'
                required:
                  - data
                  - pagination
        '400':
          description: Invalid request. A query parameter failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '401':
          description: Unauthorized. The `x-api-key` header is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '403':
          description: >-
            Forbidden. The key is not bound to an organization, or the
            organization is not a merchant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '429':
          description: >-
            Rate limit exceeded. See the `Retry-After` and `X-RateLimit-*`
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PublicOneTimePayment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
          format: uri
          description: The checkout URL.
        status:
          type: string
          enum:
            - PENDING
            - CONFIRMED
            - CANCELLED
        description:
          type: string
        amount:
          type: number
        currency:
          type: string
        externalId:
          type: string
          description: Your own identifier, unique within your organization.
        expiresAt:
          type: string
          format: date-time
        expired:
          type: boolean
          description: Derived at read time, so it is never stale.
        redirectUrl:
          type:
            - string
            - 'null'
        homepageUrl:
          type:
            - string
            - 'null'
        allowedTerms:
          type:
            - array
            - 'null'
          items:
            type: integer
          example:
            - 3
            - 6
            - 12
          description: >-
            The installment plans the checkout offers, as numbers of monthly
            installments (`1` is a single payment). `null` offers every plan
            active on your account.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        customer:
          oneOf:
            - $ref: '#/components/schemas/PublicCustomer'
            - type: 'null'
      required:
        - id
        - status
        - amount
        - currency
        - externalId
    PublicPagination:
      type: object
      properties:
        limit:
          type: integer
          description: Rows requested for this page.
        hasMore:
          type: boolean
          description: Whether another page exists.
        nextCursor:
          type:
            - string
            - 'null'
          description: Pass as `?cursor=` to fetch the next page. Null on the last page.
      required:
        - limit
        - hasMore
        - nextCursor
    PublicError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description.
        code:
          type: string
          description: Stable machine-readable code. Branch on this, not on `message`.
      required:
        - message
    PublicCustomer:
      type: object
      properties:
        firstName:
          type:
            - string
            - 'null'
        lastName:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phoneNumber:
          type:
            - string
            - 'null'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````