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



## OpenAPI

````yaml GET /payment-method
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:
  /payment-method:
    get:
      tags:
        - PaymentMethod
      summary: List payment methods
      operationId: listPaymentMethods
      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
              - ACTIVE
              - EXPIRED
              - REVOKED
          description: Filter by payment method status
      responses:
        '200':
          description: Paginated list of payment methods
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentMethodResponse'
        '400':
          description: Invalid request or missing organization context
        '401':
          description: Unauthorized – missing or invalid API key
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ListPaymentMethodResponse:
      type: object
      description: Paginated list of payment methods
      properties:
        count:
          type: integer
          description: Total number of payment methods matching the filter criteria
          example: 25
        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 payment method objects
          items:
            $ref: '#/components/schemas/PaymentMethodItem'
      required:
        - count
        - page
        - pageSize
        - items
    PaymentMethodItem:
      type: object
      description: A payment method item in list responses
      properties:
        id:
          type: string
          format: uuid
          example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - EXPIRED
            - REVOKED
        externalId:
          type: string
        card:
          type: object
          properties:
            lastFourDigits:
              type: string
              example: '4242'
            networkType:
              type: string
              example: VISA
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````