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

# Retrieve a payout batch



## OpenAPI

````yaml https://api.withacclaim.com/openapi.yaml get /payout_batches/{batch_id}
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:
  /payout_batches/{batch_id}:
    get:
      tags:
        - Payout Batches
      summary: Retrieve a payout batch
      parameters:
        - $ref: '#/components/parameters/BatchId'
      responses:
        '200':
          description: The payout batch.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutBatch'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    BatchId:
      name: batch_id
      in: path
      required: true
      schema:
        type: string
      description: ID of the payout batch.
  schemas:
    PayoutBatch:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the payout batch.
          example: pob_r8PxTnQ5Dv
        reference:
          type: string
          nullable: true
          maxLength: 100
          description: Optional client reference for reconciliation.
        description:
          type: string
          nullable: true
          maxLength: 255
          description: Optional human-readable description.
        processed_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the batch was processed, if applicable.
        status:
          type: string
          description: Current lifecycle status of the batch.
          enum:
            - Draft
            - ReadyToProcess
            - Processing
            - Completed
            - PartialCompleted
            - Failed
            - Canceled
          example: ReadyToProcess
        total_items:
          type: integer
          description: Total number of payouts in the batch.
          minimum: 0
          example: 100
        valid_items:
          type: integer
          description: Number of payouts in the batch that are valid for processing.
          minimum: 0
          example: 100
        metadata:
          type: object
          nullable: true
          description: Optional key-value metadata attached to the batch.
          additionalProperties: true
        created_at:
          type: string
          format: date-time
          description: When the batch was created.
          example: '2025-10-08T18:20:31Z'
        updated_at:
          type: string
          format: date-time
          description: When the batch was last updated.
          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
  responses:
    ErrorResponse:
      description: Error payload.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````