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

# Get Bulk Payout Status

> Retrieve and reconcile the processing summary for a bulk payout batch

Use this endpoint when a terminal webhook is delayed or when reconciling a `processing` batch. It returns the latest available processing summary.

```bash theme={null}
curl --request GET \
  --url https://api-production.fossapay.com/api/v1/payouts/batches/2ebee4e9-e4d7-4cbe-b6ee-eaf75369b851/status \
  --header "x-api-key: $FOSSAPAY_API_KEY"
```

This request can reconcile a terminal batch state when newer processing information is available. Repeated requests are safe; terminal processing is idempotent.


## OpenAPI

````yaml api-reference/openapi.json GET /api/v1/payouts/batches/{batchId}/status
openapi: 3.1.0
info:
  title: FossaPay API
  description: >-
    FossaPay API for checkout wallets, master-wallet payouts, customer
    management, NGN wallets, crypto wallets, transfers, fees, banks, and
    webhooks.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-production.fossapay.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /api/v1/payouts/batches/{batchId}/status:
    get:
      tags:
        - Bulk Payouts
      summary: Get and reconcile bulk payout processing status
      operationId: ExternalPayoutController_getBatchStatus
      parameters:
        - name: batchId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Latest batch status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPayoutStatusResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Merchant is not eligible
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Batch not found for this merchant
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    BulkPayoutStatusResponse:
      type: object
      required:
        - status
        - statusCode
        - message
        - data
      properties:
        status:
          type: string
          const: success
        statusCode:
          type: integer
          const: 200
        message:
          type: string
        data:
          $ref: '#/components/schemas/BulkPayout'
      additionalProperties: false
    ApiError:
      type: object
      properties:
        status:
          oneOf:
            - type: string
            - type: boolean
        statusCode:
          type: integer
        message:
          type: string
        error:
          type: string
        code:
          type: string
        errors:
          type: object
          additionalProperties: true
      additionalProperties: true
    BulkPayout:
      type: object
      required:
        - id
        - reference
        - accountNumber
        - status
        - executionMode
        - totalRecipients
        - totalAmount
        - totalFee
        - totalDebit
        - failureReason
        - completedAt
        - failedAt
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
        reference:
          type: string
        accountNumber:
          type: string
        status:
          type: string
          enum:
            - processing
            - completed
            - failed
        executionMode:
          type: string
          enum:
            - IMMEDIATE
        totalRecipients:
          type: integer
        totalAmount:
          type: string
        totalFee:
          type: string
        totalDebit:
          type: string
        failureReason:
          type:
            - string
            - 'null'
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        failedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````