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

# Query All Payouts

> Query all payouts with filtering, sorting, and pagination capabilities



## OpenAPI

````yaml GET /payouts/all
openapi: 3.0.1
info:
  title: CORE API OpenAPI Specification
  description: This is the API documentation for the ClickPesa CORE API
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.clickpesa.com/third-parties
security:
  - bearerAuth: []
paths:
  /payouts/all:
    get:
      description: Query all payouts with filtering, sorting, and pagination capabilities
      parameters:
        - name: startDate
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Start date for filtering payouts . Accepted formats :  `YYYY-MM-DD`
            or `DD-MM-YYYY`
        - name: endDate
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            End date for filtering payouts . Accepted formats :  `YYYY-MM-DD` or
            `DD-MM-YYYY`
        - name: channel
          in: query
          required: false
          schema:
            type: string
            enum:
              - BANK TRANSFER
              - MOBILE MONEY
          description: Payout channel filter
        - name: currency
          in: query
          required: false
          schema:
            type: string
          description: Currency filter (e.g., TZS, USD)
        - name: orderReference
          in: query
          required: false
          schema:
            type: string
          description: Order reference filter
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - SUCCESS
              - PROCESSING
              - PENDING
              - FAILED
              - REFUNDED
              - REVERSED
          description: Payout status filter
        - name: transferType
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACH
              - RTGS
          description: Settlement type filter
        - name: clientId
          in: query
          required: false
          schema:
            type: string
          description: Client ID filter
        - name: sortBy
          in: query
          required: false
          schema:
            type: string
          description: >-
            Field to sort by (default: createdAt). All response fields are
            sortable including beneficiary fields
        - name: orderBy
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
          description: 'Sort order (default: DESC)'
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of records to skip for pagination
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 20
          description: Number of records to return
      responses:
        '200':
          description: Query all payouts response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutsListResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: Invalid or Expired Token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
components:
  schemas:
    PayoutsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PayoutResponse'
          description: Array of payout records
        totalCount:
          type: integer
          description: Total number of payouts matching the query criteria
    BadRequestError:
      type: object
      properties:
        message:
          type: string
          description: Bad request error message
    UnauthorizedError:
      type: object
      properties:
        message:
          type: string
          description: Unauthorized Error
          example: Unauthorized
    PayoutResponse:
      type: object
      properties:
        updatedAt:
          type: string
          format: date-time
          description: Last updated timestamp
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
        id:
          type: string
          description: Payout ID
        orderReference:
          type: string
          description: Associated order reference
        amount:
          type: string
          description: Payout amount
        currency:
          type: string
          description: Currency code
        fee:
          type: string
          description: Transaction fee
        status:
          type: string
          description: Payout status
          enum:
            - SUCCESS
            - PROCESSING
            - PENDING
            - FAILED
            - REFUNDED
            - REVERSED
        exchanged:
          type: boolean
          description: >-
            Indicates if currency conversion was applied (true when source
            currency differs from receiving currency)
          example: true
        exchange:
          type: object
          description: Exchange rate details (only present when exchanged is true)
          properties:
            sourceCurrency:
              type: string
              description: Source currency for the exchange
              example: USD
            targetCurrency:
              type: string
              description: Target currency for the exchange
              example: TZS
            sourceAmount:
              type: number
              description: Amount in source currency
              example: 1000
            rate:
              type: number
              description: Exchange rate used for conversion
              example: 2500
        channel:
          type: string
          description: Payment channel
          enum:
            - BANK TRANSFER
            - MOBILE MONEY
        channelProvider:
          type: string
          description: Name of the payment provider
        settlementType:
          type: string
          description: Settlement type if applicable
          enum:
            - ACH
            - RTGS
        notes:
          type: string
          description: Additional notes if available
        beneficiary:
          type: object
          properties:
            accountNumber:
              type: string
              description: Beneficiary's account number
            accountName:
              type: string
              description: Beneficiary's account name
            swiftNumber:
              type: string
              description: SWIFT number if applicable
            routingNumber:
              type: string
              description: Routing number if applicable
            beneficiaryMobileNumber:
              type: string
              description: Beneficiary's mobile number if applicable
            beneficiaryEmail:
              type: string
              format: email
              description: Beneficiary's email if applicable
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````