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

# Fetch Batch Status

> Retrieve the processing status and results of a bulk payout batch.

This endpoint allows you to check the realtime status of a previously submitted bulk payout batch using its `batchId`.


## OpenAPI

````yaml get /v1/bulk/payout/{batchId}/status
openapi: 3.0.3
info:
  title: meCash API
  version: 3.0.3
  description: >-
    API for meCash services, including FIAT and Ramp operations. This is the
    OpenAPI specification for the meCash API, covering all available endpoints
    for wallet management, currency quotes, and payouts.


    It follows a design-first approach based on OpenAPI 3.0.


    Authentication is handled via an API key passed in the `x-api-key` header.
    Replace `YOUR_API_KEY` with your actual key when making requests.


    Some useful links:

    - [meCash Documentation](https://docs.me-cash.com/)

    - [Authentication Guide](https://docs.me-cash.com/authentication)
servers:
  - url: https://sandboxapi.me-cash.com
    description: Sandbox Server for Testing
security:
  - ApiKeyAuth: []
tags:
  - name: Wallet
    description: Wallet management operations
  - name: Quote
    description: Currency quote operations
  - name: Payout
    description: Payout operations
  - name: Transaction
    description: Transaction management
  - name: Virtual Account
    description: Virtual account operations for static and dynamic accounts
  - name: Bank
    description: Bank account and list operations
  - name: Ramp
    description: Ramp operations for crypto
  - name: Miscellaneous
    description: Utility and miscellaneous operations
  - name: Collection
    description: Mobile money and wallet funding operations
  - name: Bulk Payout
    description: >-
      Bulk transfer operations for sending to multiple beneficiaries in a single
      request
paths:
  /v1/bulk/payout/{batchId}/status:
    get:
      tags:
        - Bulk Payout
      summary: Fetch Batch Status
      description: >-
        Retrieves the processing status and results of a bulk payout batch using
        its unique ID.
      operationId: getBulkPayoutStatus
      parameters:
        - name: batchId
          in: path
          required: true
          description: The unique identifier for the batch submission.
          schema:
            type: string
            format: uuid
          example: 44cbef79-3b95-4214-bda2-78014f400d11
      responses:
        '200':
          description: Batch status retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  message:
                    type: string
                    example: Transaction Processing
                  data:
                    type: object
                    properties:
                      state:
                        type: string
                        example: pending
                      batchId:
                        type: string
                        format: uuid
                        example: 44cbef79-3b95-4214-bda2-78014f400d11
                      startTimestamp:
                        type: string
                        format: date-time
                        example: '2026-04-08T17:35:54.070396Z'
                      endTimestamp:
                        type: string
                        format: date-time
                        nullable: true
                        example: null
                      batchTotal:
                        type: integer
                        example: 15
                      totalSuccessful:
                        type: integer
                        example: 0
                      totalFailed:
                        type: integer
                        example: 0
                      totalPending:
                        type: integer
                        example: 15
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            referenceNumber:
                              type: string
                              example: REF_ZZOEAZH8ZJI6
                            status:
                              type: string
                              example: pending
                            targetAmount:
                              type: string
                              example: '1500'
                            reason:
                              type: string
                              example: Salary payment
                            recipient:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                  example: f55914fe-0568-473d-bf6f-95c32c71094e
                                name:
                                  type: string
                                  example: NNOROM UZOMA CHUKWUDI
                                account:
                                  type: object
                                  properties:
                                    bankName:
                                      type: string
                                      example: FCMB
                                    sortCode:
                                      type: string
                                      example: '214'
                                    accountNumber:
                                      type: string
                                      example: '2483520014'
                                paymentChannel:
                                  type: string
                                  example: BANK_TRANSFER
                                currency:
                                  type: string
                                  example: NGN
                                country:
                                  type: string
                                  example: NG
                      paymentChannel:
                        type: string
                        example: BANK_TRANSFER
                      remark:
                        type: string
                        example: June 2026 Salary
        '401':
          $ref: '#/components/responses/PayoutUnauthorized'
        '403':
          $ref: '#/components/responses/PayoutForbidden'
        '404':
          description: Batch not found.
components:
  responses:
    PayoutUnauthorized:
      description: Unauthorized. The provided API key is invalid or missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayoutFailedResponse'
          example:
            message: Invalid API key
            status: failed
    PayoutForbidden:
      description: >-
        Forbidden. The request is not allowed because the source IP is not
        whitelisted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PayoutFailedResponse'
          example:
            message: 'Access denied: IP address not whitelisted'
            status: failed
  schemas:
    PayoutFailedResponse:
      type: object
      properties:
        message:
          type: string
          description: A human-readable error message.
        status:
          type: string
          example: failed
      required:
        - message
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````