> ## 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



## OpenAPI

````yaml GET /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, and processing
      refunds
  - name: PaymentIntent
    description: >-
      Endpoints for creating and managing card-present payment intents for POS
      terminal integrations
paths:
  /one-time-payment:
    get:
      tags:
        - OneTimePayment
      summary: List one-time payments
      operationId: listOneTimePayments
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number for pagination
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
          description: Number of items per page (max 500)
        - name: status
          in: query
          schema:
            type: string
            enum:
              - PENDING
              - CONFIRMED
              - CANCELLED
          description: Filter by payment status
        - name: currency
          in: query
          schema:
            type: string
            enum:
              - MXN
          description: Filter by currency
      responses:
        '200':
          description: Paginated list of one-time payments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOneTimePaymentResponse'
        '400':
          description: Invalid request or missing organization context
        '401':
          description: Unauthorized – missing or invalid API key
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ListOneTimePaymentResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of one-time payments matching the filter criteria
          example: 245
        page:
          type: integer
          description: Current page number
          example: 1
        pageSize:
          type: integer
          description: Number of items per page
          example: 100
        items:
          type: array
          description: Array of one-time payment objects
          items:
            $ref: '#/components/schemas/OneTimePaymentItem'
      required:
        - count
        - page
        - pageSize
        - items
    OneTimePaymentItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        status:
          type: string
          enum:
            - PENDING
            - CONFIRMED
            - CANCELLED
        description:
          type: string
        amount:
          type: number
          format: decimal
        currency:
          type: string
          example: MXN
        externalId:
          type: string
        expiresAt:
          type: string
          format: date-time
        redirectUrl:
          type: string
          format: uri
        homepageUrl:
          type: string
          format: uri
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        billingInformation:
          type: object
          properties:
            email:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            phoneNumber:
              type: string
            address:
              $ref: '#/components/schemas/Address'
    Address:
      type: object
      description: Physical address for billing purposes
      properties:
        addressLine:
          type: string
          example: Av. Insurgentes Sur 1234
          description: Street address, including number and street name
        city:
          type: string
          example: Ciudad de México
          description: The city where the address is located
        state:
          type: string
          example: CDMX
          description: The state or province where the address is located
          enum:
            - AGU
            - BCN
            - BCS
            - CAM
            - CHP
            - CHH
            - CDMX
            - COA
            - COL
            - DUR
            - MEX
            - GUA
            - GRO
            - HID
            - JAL
            - MIC
            - MOR
            - NAY
            - NLE
            - OAX
            - PUE
            - QUE
            - ROO
            - SLP
            - SIN
            - SON
            - TAB
            - TAM
            - TLA
            - VER
            - YUC
            - ZAC
        zip:
          type: string
          example: '03100'
          description: Zip code or Postal code where the address is located
      required:
        - addressLine
        - city
        - state
        - zip
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````