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

# List payouts



## OpenAPI

````yaml https://api.withacclaim.com/openapi.yaml get /payouts
openapi: 3.1.0
info:
  title: Acclaim API
  version: 1.0.0
  description: >
    Payments infrastructure built for the insurance industry. This specification
    describes

    the core resources and operations for treasury accounts, payouts, funding,
    and more.


    Authentication uses a secret API key passed as a Bearer token. The API is
    JSON-only

    and available via HTTPS only.
servers:
  - url: https://api.withacclaim.com/v1
security:
  - bearerAuth: []
tags:
  - name: Treasury / Treasury Accounts
    description: Manage treasury accounts and balances.
  - name: Payees
    description: Manage recipients of payouts.
  - name: Payout Methods
    description: Manage payout methods (e.g. bank accounts) for a payee.
  - name: Payouts
    description: Create and track individual payouts.
  - name: Payout Batches
    description: Create and track groups of payouts.
  - name: Treasury / Funding
    description: Move funds between settlement accounts and treasury accounts.
  - name: Payment Requests
    description: Create and manage payment requests for collecting payments.
  - name: Setup Requests
    description: Create and manage setup requests for securely storing payment methods.
  - name: Refunds
    description: Create and manage refunds for payments.
  - name: Payers
    description: Create and manage payers for payment collection.
  - name: Payment Methods
    description: Manage payment methods (e.g. cards, bank accounts) for a payer.
paths:
  /payouts:
    get:
      tags:
        - Payouts
      summary: List payouts
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - in: query
          name: cursor
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: string
            enum:
              - ReadyToProcess
              - Processing
              - Succeeded
              - Failed
              - Canceled
              - RequiresPayeeInfo
              - RequiresAction
              - RequiresPayoutMethod
              - NeedsApproval
      responses:
        '200':
          description: A list of payouts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPayoutsResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    ListPayoutsResponse:
      allOf:
        - $ref: '#/components/schemas/CursorPage'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Payout'
    CursorPage:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
        next_cursor:
          type: string
          nullable: true
        has_more:
          type: boolean
    Payout:
      type: object
      properties:
        id:
          type: string
          example: po_dlZwQyd0Sn
        treasury_account_id:
          type: string
          example: tac_b0TrsSg91h
          nullable: true
          description: ID of the treasury account funding the payout
        payee_id:
          type: string
          example: pyee_KfIuLz83Ya
          description: ID of the payee
        batch_id:
          type: string
          nullable: true
          example: pob_r8PxTnQ5Dv
          description: ID of the payout batch if this payout belongs to one
        funded_amount:
          type: integer
          nullable: true
          description: >-
            The amount funded from the treasury account in smallest currency
            unit
          example: 125000
        funding_currency:
          type: string
          nullable: true
          description: ISO 4217 currency code for the funded amount
          example: USD
        payment_amount:
          type: integer
          nullable: true
          description: >-
            Amount sent to payee in smallest currency unit (after currency
            conversion)
          example: 125000
        payment_currency:
          type: string
          nullable: true
          description: ISO 4217 currency code for the payment amount
          example: USD
        exchange_rate:
          type: string
          nullable: true
          description: Exchange rate used for currency conversion (if applicable)
          example: '1.00000000'
        status:
          type: string
          enum:
            - ReadyToProcess
            - Processing
            - Succeeded
            - Failed
            - Canceled
            - RequiresPayeeInfo
            - RequiresAction
            - RequiresPayoutMethod
            - NeedsApproval
        payout_link_url:
          type: string
          format: uri
          nullable: true
          description: URL for the payout link if generated for recipient choice
        payout_method:
          allOf:
            - $ref: '#/components/schemas/PayoutMethod'
          nullable: true
          description: The payout method used for this payout
        reference:
          type: string
          nullable: true
          example: REF-2025-001
          description: Client-supplied reference for reconciliation
        description:
          type: string
          nullable: true
          example: Payment for services rendered
        purpose_of_payment:
          type: string
          nullable: true
          enum:
            - ProviderBillPayment
            - Commission
            - Refund
            - ClaimReimbursement
          description: Purpose of the payment
        processed_at:
          type: string
          format: date-time
          nullable: true
          example: '2025-10-08T18:25:00Z'
          description: When the payout was processed
        payment_date:
          type: string
          format: date
          nullable: true
          example: '2025-10-08'
          description: Expected or actual payment date
        swift_charge_option:
          type: string
          nullable: true
          enum:
            - Our
            - Shared
            - Beneficiary
          description: SWIFT charge option (for international wire transfers)
        lock_side:
          type: string
          enum:
            - Funding
            - Payment
          description: >-
            Which side of the FX quote has a locked rate. Funding means the
            funded amount is fixed; Payment means the payment amount is fixed.
        failure_code:
          type: string
          nullable: true
          example: insufficient_funds
          description: Error code if the payout failed
        failure_message:
          type: string
          nullable: true
          example: Insufficient funds in treasury account
          description: Human-readable error message if the payout failed
        metadata:
          type: object
          nullable: true
          description: Optional metadata as key-value pairs
          additionalProperties: true
          example:
            custom_field: value
            source: api
        created_at:
          type: string
          format: date-time
          example: '2025-10-08T18:20:31Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-10-08T18:25:00Z'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: 'Missing required field: amount'
            details:
              type: object
              additionalProperties: true
            request_id:
              type: string
              example: req_7lYt4o2x
    PayoutMethod:
      type: object
      properties:
        id:
          type: string
          example: pmet_abc123
          description: Public ID of the payout method
        payout_method_type:
          type: string
          example: UnitedStatesAch
          description: Type of payout method
        active:
          type: boolean
          example: true
        currency:
          type: string
          nullable: true
          description: ISO 4217 currency code
        country:
          type: string
          nullable: true
          description: ISO 3166-1 alpha-2 country code
        account_number:
          type: string
          nullable: true
        routing_type1:
          type: string
          nullable: true
        routing_value1:
          type: string
          nullable: true
        routing_type2:
          type: string
          nullable: true
        routing_value2:
          type: string
          nullable: true
        bank_name:
          type: string
          nullable: true
        account_holder_name:
          type: string
          nullable: true
        account_type:
          type: string
          nullable: true
        swift_code:
          type: string
          nullable: true
        iban:
          type: string
          nullable: true
        tax_id_type:
          type: string
          nullable: true
        tax_id:
          type: string
          nullable: true
        payout_speed:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  responses:
    ErrorResponse:
      description: Error payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````