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

> Retrieve a paginated list of payments across all organizations managed by your sales partner account. Supports filtering by status, type, financing method, terms, issuing bank, organization, date range, and free text search.



## OpenAPI

````yaml sales-partner/api-reference/openapi.json GET /payment
openapi: 3.1.0
info:
  title: Compago Sales Partner API
  version: 1.0.0
  description: >-
    API endpoints for Compago sales partners. Allows querying payment data
    across organizations managed by the sales partner.
servers:
  - url: https://demo.api.honor.compago.com/api/developer
    description: Demo
  - url: https://api.honor.compago.com/api/developer
    description: Production
security: []
tags:
  - name: Payment
    description: Endpoints for querying payment data across your organizations
paths:
  /payment:
    get:
      tags:
        - Payment
      summary: List payments
      description: >-
        Retrieve a paginated list of payments across all organizations managed
        by your sales partner account. Supports filtering by status, type,
        financing method, terms, issuing bank, organization, date range, and
        free text search.
      operationId: listPayments
      parameters:
        - name: id
          in: query
          schema:
            type: string
            format: uuid
          description: Filter by a specific payment ID
        - name: status
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - PENDING
                  - CANCELLED
                  - CONFIRMED
                  - REFUNDED
              - type: array
                items:
                  type: string
                  enum:
                    - PENDING
                    - CANCELLED
                    - CONFIRMED
                    - REFUNDED
          description: >-
            Filter by payment status. Supports multiple values by repeating the
            parameter (e.g. `?status=PENDING&status=CONFIRMED`).
        - name: type
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - CARD_NOT_PRESENT
                  - CARD_PRESENT
              - type: array
                items:
                  type: string
                  enum:
                    - CARD_NOT_PRESENT
                    - CARD_PRESENT
          description: Filter by payment type. Supports multiple values.
        - name: financingMethod
          in: query
          schema:
            oneOf:
              - type: string
                enum:
                  - INSTALLMENTS
                  - PAY_NOW
              - type: array
                items:
                  type: string
                  enum:
                    - INSTALLMENTS
                    - PAY_NOW
          description: Filter by financing method. Supports multiple values.
        - name: terms
          in: query
          schema:
            oneOf:
              - type: integer
                minimum: 1
              - type: array
                items:
                  type: integer
                  minimum: 1
          description: >-
            Filter by number of installment terms (e.g. 3, 6, 12). Supports
            multiple values.
        - name: issuingBank
          in: query
          schema:
            oneOf:
              - type: string
              - type: array
                items:
                  type: string
          description: Filter by the card's issuing bank name. Supports multiple values.
        - name: organizationId
          in: query
          schema:
            oneOf:
              - type: string
                format: uuid
              - type: array
                items:
                  type: string
                  format: uuid
          description: >-
            Filter by organization ID. Only organizations under your sales
            partner account are accessible. Supports multiple values.
        - name: createdAtFrom
          in: query
          schema:
            type: string
            format: date
          description: >-
            Filter payments created on or after this date (inclusive). Uses
            Mexico City timezone (CST/CDT).
          example: '2026-01-01'
        - name: createdAtTo
          in: query
          schema:
            type: string
            format: date
          description: >-
            Filter payments created on or before this date (inclusive). Uses
            Mexico City timezone (CST/CDT).
          example: '2026-03-31'
        - name: operationCodeSearch
          in: query
          schema:
            type: string
          description: Search by operation code (partial match)
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Free text search. Matches against payment amount and organization
            name.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: 'Number of results per page (default: 20, max: 100)'
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: 'Number of results to skip for pagination (default: 0)'
      responses:
        '200':
          description: Paginated list of payments
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponse'
        '400':
          description: Invalid request parameters (e.g. invalid enum value, malformed UUID)
        '401':
          description: Unauthorized - missing or invalid API key
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ListPaymentsResponse:
      type: object
      description: Paginated list of payments
      properties:
        data:
          type: array
          description: Array of payment objects
          items:
            $ref: '#/components/schemas/PaymentItem'
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    PaymentItem:
      type: object
      description: A payment record with its related information
      properties:
        id:
          type: string
          format: uuid
          example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
          description: Unique identifier of the payment
        status:
          type: string
          enum:
            - PENDING
            - CANCELLED
            - CONFIRMED
            - REFUNDED
          description: Current status of the payment
        type:
          type: string
          enum:
            - CARD_NOT_PRESENT
            - CARD_PRESENT
          description: Whether the card was present or not during the transaction
        financingMethod:
          type: string
          enum:
            - INSTALLMENTS
            - PAY_NOW
          description: How the payment is financed
        operationCode:
          type: integer
          description: Unique operation code for the payment
          example: 10000000001
        amount:
          type: number
          format: decimal
          description: Payment amount
          example: 1500
        currency:
          type: string
          description: Currency code
          example: MXN
        terms:
          type: integer
          description: Number of installment terms
          example: 6
        periodicity:
          type: string
          enum:
            - MONTHLY
          description: Installment periodicity
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the payment was created
        organization:
          $ref: '#/components/schemas/Organization'
        cardInformation:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CardInformation'
        paymentDisbursement:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/PaymentDisbursement'
        transaction:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Transaction'
        terminal:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Terminal'
        billingInformation:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/BillingInformation'
        salesperson:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/Salesperson'
        businessStoreBranch:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/BusinessStoreBranch'
      required:
        - id
        - status
        - type
        - financingMethod
        - operationCode
        - amount
        - currency
        - terms
        - periodicity
        - createdAt
    Pagination:
      type: object
      description: Pagination metadata
      properties:
        limit:
          type: integer
          description: Number of results per page
          example: 20
        offset:
          type: integer
          description: Number of results skipped
          example: 0
        count:
          type: integer
          description: Number of results returned in this page
          example: 10
      required:
        - limit
        - offset
        - count
    Organization:
      type: object
      description: The organization (merchant) associated with the payment
      properties:
        id:
          type: string
          format: uuid
          example: 11111111-2222-3333-4444-555555555555
          description: Unique identifier of the organization
        name:
          type: string
          description: Name of the organization
          example: Acme Store
      required:
        - id
        - name
    CardInformation:
      type: object
      description: Card details used for the payment
      properties:
        lastFourDigits:
          type: string
          description: Masked last four digits of the card number
          example: '**89'
        networkType:
          type: string
          description: Card network brand
          example: VISA
          enum:
            - VISA
            - MASTERCARD
            - AMEX
            - DISCOVER
            - UNKNOWN
        issuingBank:
          type: string
          nullable: true
          description: Name of the bank that issued the card
          example: Bank of Example
        fundingSource:
          type: string
          nullable: true
          description: Funding source of the card
          enum:
            - DEBIT
            - CREDIT
          example: CREDIT
        entryMode:
          type: string
          nullable: true
          description: How the card was captured during the transaction
          enum:
            - MAGNETIC
            - CHIP
            - CONTACTLESS
          example: CHIP
    PaymentDisbursement:
      type: object
      description: Fee breakdown and disbursement details for the payment
      properties:
        feePercentage:
          type: number
          description: Total fee percentage applied to the payment
          example: 3.5
        promotionFeeDiscount:
          type: number
          description: Fee discount percentage from active promotions
          example: 0
        finalFeePercentageForMerchant:
          type: number
          description: Effective fee percentage charged to the merchant
          example: 3.5
        finalFeePercentageForManufacturer:
          type: number
          description: Effective fee percentage charged to the manufacturer
          example: 0
        promotionBusinessTake:
          type: number
          description: >-
            Percentage of the payment amount allocated to the manufacturer via
            promotion
          example: 0
        feeAmount:
          type: string
          description: Total fee amount in the payment currency
          example: '52.50'
        merchantFeeAmount:
          type: string
          description: Fee amount charged to the merchant
          example: '52.50'
        manufacturerFeeAmount:
          type: string
          description: Fee amount charged to the manufacturer
          example: '0.00'
        merchantIvaFeeAmount:
          type: string
          description: IVA (tax) on the merchant's fee
          example: '8.40'
        manufacturerIvaFeeAmount:
          type: string
          description: IVA (tax) on the manufacturer's fee
          example: '0.00'
        totalFeeIva:
          type: string
          description: Total IVA (16%) on the total fee amount
          example: '8.40'
        promotionTakeAmount:
          type: string
          description: Amount allocated to the manufacturer from the promotion
          example: '0.00'
        merchantTakeAmount:
          type: string
          description: Net amount the merchant receives after fees and IVA
          example: '1439.10'
        manufacturerTakeAmount:
          type: string
          description: Net amount the manufacturer receives after fees and IVA
          example: '0.00'
    Transaction:
      type: object
      description: Details of the relevant payment transaction
      properties:
        bankReference:
          type: string
          nullable: true
          description: Bank reference number for the transaction
          example: '123456789012'
        rawResponseText:
          type: string
          nullable: true
          description: Response text from the payment processor
          example: Approved
        authResult:
          type: string
          nullable: true
          description: Authorization result code from the payment processor
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the transaction was created
        authCode:
          type: string
          nullable: true
          description: Authorization code returned by the card network
          example: '123456'
        resultCode:
          type: string
          nullable: true
          description: Processor result code for the transaction
          example: '00'
    Terminal:
      type: object
      description: >-
        POS terminal used to capture the payment (only present for card-present
        transactions)
      properties:
        serialNumber:
          type: string
          description: Serial number of the POS terminal
          example: TERM-00000001
      required:
        - serialNumber
    BillingInformation:
      type: object
      description: Billing information provided by the customer for the payment
      properties:
        email:
          type: string
          format: email
          description: Customer email address
          example: customer@example.com
        firstName:
          type: string
          description: Customer first name
          example: Jane
        lastName:
          type: string
          description: Customer last name
          example: Doe
        phoneNumber:
          type: string
          description: Customer phone number
          example: '+5215555555555'
        address:
          type: object
          nullable: true
          description: Customer billing address
          properties:
            addressLine:
              type: string
              description: Street address
              example: Calle Example 123
            city:
              type: string
              description: City
              example: Ciudad de Mexico
            state:
              type: string
              description: State or province
              example: CDMX
            zip:
              type: string
              description: Postal code
              example: '01000'
          required:
            - addressLine
            - city
            - state
            - zip
      required:
        - email
        - firstName
        - lastName
        - phoneNumber
    Salesperson:
      type: object
      description: Salesperson who processed the payment (populated for POS payments)
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the salesperson
        name:
          type: string
          description: Display name of the salesperson
          example: Maria Garcia
        username:
          type: string
          description: Username used by the salesperson to sign in on POS apps
          example: maria.garcia
      required:
        - id
        - name
        - username
    BusinessStoreBranch:
      type: object
      description: >-
        Store branch where the payment was processed (populated for POS
        payments)
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the store branch
        name:
          type: string
          description: Display name of the store branch
          example: Polanco Branch
      required:
        - id
        - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````