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

> Returns payouts deposited to the organization, most recently settled first.



## OpenAPI

````yaml /openapi.yaml get /v1/payouts
openapi: 3.1.0
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
security:
  - organizationApiKey: []
  - oauthAccessToken: []
tags:
  - name: Auth
  - name: Management
  - name: Billing
  - name: Catalog
  - name: Customers
  - name: Invoices
  - name: Payment Methods
  - name: Payment Sessions
  - name: Payments
  - name: Subscriptions
  - name: Tax Invoices
  - name: Webhooks
  - name: Messaging
paths:
  /v1/payouts:
    get:
      tags:
        - Management
      summary: List payouts
      description: >-
        Returns payouts deposited to the organization, most recently settled
        first.
      operationId: payouts_list
      parameters:
        - schema:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/StringFilter'
              createdAt:
                $ref: '#/components/schemas/DateTimeFilter'
              settleDate:
                $ref: '#/components/schemas/DateTimeFilter'
              updatedAt:
                $ref: '#/components/schemas/DateTimeFilter'
              grossAmount:
                type: object
                properties:
                  equals:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  in:
                    type: array
                    items:
                      anyOf:
                        - type: number
                          description: Number
                        - type: string
                          description: Numeric string
                  notIn:
                    type: array
                    items:
                      anyOf:
                        - type: number
                          description: Number
                        - type: string
                          description: Numeric string
                  lt:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  lte:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  gt:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                  gte:
                    anyOf:
                      - type: number
                        description: Number
                      - type: string
                        description: Numeric string
                additionalProperties: false
              inconsistent:
                anyOf:
                  - type: boolean
                    description: Boolean
                  - type: string
                    description: Boolean string
              payer:
                type: object
                properties:
                  equals:
                    type: string
                    enum:
                      - AMEX
                      - FISERV
                      - STRIPE
                      - KUSHKI
                      - SANTANDER
                      - TAPI
                      - QUENTLI
                  in:
                    type: array
                    items:
                      type: string
                      enum:
                        - AMEX
                        - FISERV
                        - STRIPE
                        - KUSHKI
                        - SANTANDER
                        - TAPI
                        - QUENTLI
                  notIn:
                    type: array
                    items:
                      type: string
                      enum:
                        - AMEX
                        - FISERV
                        - STRIPE
                        - KUSHKI
                        - SANTANDER
                        - TAPI
                        - QUENTLI
                additionalProperties: false
            additionalProperties: false
            description: Filter fields encoded with `qs` bracket notation.
          required: false
          description: Filter fields encoded with `qs` bracket notation.
          style: deepObject
          explode: true
          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
      responses:
        '200':
          description: Payouts list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPayoutsResponse'
        '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:
    StringFilter:
      type: object
      properties:
        equals:
          type: string
        in:
          type: array
          items:
            type: string
        notIn:
          type: array
          items:
            type: string
        lt:
          type: string
        lte:
          type: string
        gt:
          type: string
        gte:
          type: string
        contains:
          type: string
        startsWith:
          type: string
        endsWith:
          type: string
        search:
          type: string
        not:
          $ref: '#/components/schemas/StringFilter'
      additionalProperties: false
    DateTimeFilter:
      type: object
      properties:
        equals:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        lt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        lte:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        gt:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        gte:
          anyOf:
            - type: string
              description: Date string
            - type: string
              format: date-time
              description: Date object
        not:
          $ref: '#/components/schemas/DateTimeFilter'
      additionalProperties: false
    GetPayoutsResponse:
      type: array
      items:
        $ref: '#/components/schemas/Payout'
      description: List of payouts returned by the query.
    UserError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
          required:
            - message
      required:
        - error
      additionalProperties: false
      description: Standard user-facing error response envelope.
    Payout:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the payout.
          example: po_1234567890abcdefghij
        createdAt:
          type: string
          format: date-time
          description: When the payout was recorded.
        updatedAt:
          type: string
          format: date-time
          description: When the payout was last updated.
        settleDate:
          type: string
          format: date-time
          description: When the payout settled in the organization's bank account.
        isApproximateDate:
          type: boolean
          description: Whether the settle date is an estimate.
        inconsistent:
          type: boolean
          description: >-
            Whether its amounts are inconsistent with its linked records and
            transactions.
        organizationId:
          type: string
          description: Organization that received the payout.
        currency:
          type: string
          description: ISO 4217 currency code.
          example: MXN
        grossAmount:
          type: integer
          description: Amount before fees, in minor currency units.
          example: 1500000
        netAmount:
          type:
            - integer
            - 'null'
          description: Amount deposited after fees, in minor currency units.
          example: 1440000
        quentliFee:
          type:
            - integer
            - 'null'
          description: Quentli fee, in minor currency units.
        quentliFeeTax:
          type:
            - integer
            - 'null'
          description: Tax on the Quentli fee, in minor currency units.
        processorFee:
          type:
            - integer
            - 'null'
          description: Processor fee, in minor currency units.
        processorFeeTax:
          type:
            - integer
            - 'null'
          description: Tax on the processor fee, in minor currency units.
        disputesAmount:
          type:
            - integer
            - 'null'
          description: Dispute amount deducted from this payout, in minor currency units.
        processor:
          type: string
          enum:
            - FISERV
            - STRIPE
            - KUSHKI
            - SANTANDER
            - TAPI
            - QUENTLI
          description: Payment processor that generated the payout.
        payer:
          type: string
          enum:
            - AMEX
            - FISERV
            - STRIPE
            - KUSHKI
            - SANTANDER
            - TAPI
            - QUENTLI
          description: Party that sent the payout.
        externalId:
          type:
            - string
            - 'null'
          description: Payout identifier at the payment processor.
        stripePayoutId:
          type:
            - string
            - 'null'
          description: Stripe payout identifier, when paid by Stripe.
        cep:
          type:
            - string
            - 'null'
          description: URL of the SPEI electronic payment receipt (CEP), when available.
      required:
        - id
        - createdAt
        - updatedAt
        - settleDate
        - isApproximateDate
        - inconsistent
        - organizationId
        - currency
        - grossAmount
        - netAmount
        - quentliFee
        - quentliFeeTax
        - processorFee
        - processorFeeTax
        - disputesAmount
        - processor
        - payer
        - externalId
        - stripePayoutId
        - cep
      description: A settlement deposited into the organization's bank account.
  securitySchemes:
    organizationApiKey:
      type: http
      scheme: bearer
      description: 'Organization API key using `Authorization: Bearer sk_...`.'
    oauthAccessToken:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.1
      description: 'OAuth access token using `Authorization: Bearer qoa_at_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.