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

# List payouts

> Get a paged list of payouts for a business



## OpenAPI

````yaml https://api.halth.com/v1/api-yaml get /v1/businesses/{businessId}/payouts
openapi: 3.0.0
info:
  title: HaltH API
  description: The API for the HaltH platform business services
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.halth.com
    description: Production
  - url: https://api.stg.halth.com
    description: Staging
security: []
tags: []
paths:
  /v1/businesses/{businessId}/payouts:
    get:
      tags:
        - Payout
      summary: List payouts
      description: Get a paged list of payouts for a business
      operationId: PayoutController_list
      parameters:
        - name: businessId
          required: true
          in: path
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            minimum: 1
            maximum: 9007199254740991
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Number of items per page
          schema:
            minimum: 1
            maximum: 200
            default: 10
            example: 10
            type: number
        - name: source
          required: false
          in: query
          description: >-
            The sources to list payouts from. Omit this parameter to list all
            sources.
          schema:
            type: array
            items:
              type: string
              enum:
                - halth
                - health_fund
        - name: status
          required: false
          in: query
          schema:
            type: string
            enum:
              - paid
              - pending
              - in_transit
              - canceled
              - failed
        - name: arrivesAtMin
          required: false
          in: query
          schema:
            format: date-time
            type: string
        - name: arrivesAtMax
          required: false
          in: query
          schema:
            format: date-time
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/Payout'
                      page:
                        type: number
                        example: 1
                      limit:
                        type: number
                        example: 10
                      totalItems:
                        type: number
                        example: 100
                      totalPages:
                        type: number
                        example: 10
components:
  schemas:
    ApiResponse:
      type: object
      properties: {}
    Payout:
      type: object
      properties:
        arrivesAt:
          format: date-time
          type: string
          description: Estimated arrival date and time
      required:
        - arrivesAt

````