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

# List payments

> Returns payments for the organization.



## OpenAPI

````yaml /openapi.yaml get /v1/payments
openapi: 3.0.3
info:
  title: Quentli REST API
  version: 1.0.0
  description: OpenAPI spec for Quentli REST endpoints.
servers:
  - url: https://api.quentli.com
    description: Production API
  - url: https://api.staging.quentli.com
    description: Staging API for production-like validation
  - url: https://api.demo.quentli.com
    description: Demo API hostname served by staging
security:
  - organizationApiKey: []
tags:
  - name: Auth
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
paths:
  /v1/payments:
    get:
      tags:
        - Payments
      summary: List payments
      description: Returns payments for the organization.
      operationId: payments_list
      parameters:
        - schema:
            type: string
            description: A `qs`-encoded `paymentFilter` object.
            example: isCompleted=true&type[equals]=CARD
          required: false
          description: A `qs`-encoded `paymentFilter` object.
          name: filter
          in: query
        - schema:
            type: number
            minimum: 0
            default: 0
            description: Pagination offset.
            example: 0
          required: false
          description: Pagination offset.
          name: skip
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
            description: Pagination limit.
            example: 20
          required: false
          description: Pagination limit.
          name: take
          in: query
        - schema:
            type: string
            description: A `qs`-encoded `paymentOrderBy` object.
            example: createdAt=desc
          required: false
          description: A `qs`-encoded `paymentOrderBy` object.
          name: orderBy
          in: query
      responses:
        '200':
          description: Payments list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentsResponse'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserError'
components:
  schemas:
    GetPaymentsResponse:
      type: array
      items:
        $ref: '#/components/schemas/PaymentWithItems'
      description: List of payments with expanded line items.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    PaymentWithItems:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the payment.
          example: p_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the payment record was created.
          example: '2025-01-15T18:30:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the payment was last updated.
          example: '2025-01-15T18:30:00.000Z'
        amount:
          type: number
          description: Payment amount in minor currency units.
          example: 150000
        currency:
          type: string
          description: ISO 4217 currency code.
          example: MXN
        description:
          type: string
          nullable: true
          description: Human-readable description of the payment.
          example: Colegiatura Enero 2025
        type:
          type: string
          nullable: true
          enum:
            - TRANSFER
            - CARD
            - OXXO
            - OTHER
            - CASH
            - DIRECT_DEBIT
            - null
          description: Payment type.
          example: CARD
        status:
          type: string
          nullable: true
          enum:
            - INCOMPLETE
            - COMPLETE
            - CANCELED
            - INITIATED
            - REFUNDED
            - DISPUTED
            - REVERTED
            - null
          description: Current payment status.
          example: COMPLETE
        isCompleted:
          type: boolean
          description: Whether the payment has been fully settled.
          example: true
        paymentTime:
          type: string
          nullable: true
          format: date-time
          description: Date and time when the payment was completed.
          example: '2025-01-15T18:30:00.000Z'
        customerId:
          type: string
          description: Identifier of the customer who made the payment.
          example: cus_1234567890abcdefghij
        paymentIntentId:
          type: string
          nullable: true
          description: Payment processor intent identifier, if any.
          example: null
        paymentMethodId:
          type: string
          nullable: true
          description: Identifier of the payment method used, if any.
          example: pm_1234567890abcdefghij
        organizationId:
          type: string
          description: Identifier of the owning organization.
          example: org_1234567890abcdefghij
        skipTaxInvoice:
          type: boolean
          description: Whether tax invoice generation is skipped for this payment.
          example: false
        monthlyInstallments:
          type: integer
          nullable: true
          description: Number of monthly installments, if any.
          example: null
        processor:
          type: string
          nullable: true
          enum:
            - FISERV
            - KUSHKI
            - QUENTLI
            - SANTANDER
            - STRIPE
            - TAPI
            - null
          description: Processor that handled the payment, if any.
          example: null
        processorFee:
          type: integer
          nullable: true
          description: Processor fee in minor currency units, if known.
          example: null
        processorFeeTax:
          type: integer
          nullable: true
          description: Tax on the processor fee in minor currency units, if known.
          example: null
        installmentsFee:
          type: integer
          nullable: true
          description: Installments fee in minor currency units, if any.
          example: null
        installmentsFeeTax:
          type: integer
          nullable: true
          description: Tax on the installments fee in minor currency units, if any.
          example: null
        externalPaymentTypeId:
          type: string
          nullable: true
          description: External payment type identifier when type is OTHER.
          example: null
        sessionId:
          type: string
          nullable: true
          description: Payment session identifier associated with this payment, if any.
          example: null
        metadata:
          type: array
          nullable: true
          items:
            type: object
            properties:
              key:
                type: string
              value:
                type: string
            required:
              - key
              - value
            additionalProperties: false
          description: Structured metadata entries.
          example: null
        meta:
          type: object
          nullable: true
          additionalProperties:
            type: string
          description: Flattened metadata key-value map.
          example: null
        items:
          type: array
          items:
            type: object
            properties:
              description:
                type: string
                description: Line item description.
              amount:
                type: number
                description: Unit amount in minor currency units.
              currency:
                type: string
                description: ISO 4217 currency code.
              quantity:
                type: number
                description: Quantity of units.
              conceptId:
                type: string
                nullable: true
                description: Identifier of the related payment concept, if any.
              concept:
                type: object
                nullable: true
                properties:
                  id:
                    type: string
                    description: Payment concept identifier.
                  displayName:
                    type: string
                    description: Concept display name.
                  description:
                    type: string
                    nullable: true
                    description: Concept description.
                  createdAt:
                    type: string
                    format: date-time
                    description: When the concept was created.
                  updatedAt:
                    type: string
                    format: date-time
                    description: When the concept was last updated.
                required:
                  - id
                  - displayName
                  - description
                  - createdAt
                  - updatedAt
                description: Resolved payment concept for the line item.
            required:
              - description
              - amount
              - currency
              - quantity
              - conceptId
              - concept
      required:
        - id
        - createdAt
        - updatedAt
        - amount
        - currency
        - description
        - type
        - status
        - isCompleted
        - paymentTime
        - customerId
        - paymentIntentId
        - organizationId
        - skipTaxInvoice
        - monthlyInstallments
        - processor
        - processorFee
        - processorFeeTax
        - installmentsFee
        - installmentsFeeTax
        - externalPaymentTypeId
        - sessionId
        - items
      description: Payment with expanded line items.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'

````