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

# Get Bulk Payment Statistics

Get statistics and analytics for bulk payments.


## OpenAPI

````yaml GET /api/v3/dashboard/bulk-payments/api/stats
openapi: 3.0.0
info:
  title: KOTANI PAY API PLATFORM
  description: ''
  version: '3.0'
  contact: {}
servers:
  - url: https://preview.kotanipay.com
security: []
tags: []
paths:
  /api/v3/dashboard/bulk-payments/api/stats:
    get:
      tags:
        - API Bulk Payments
      summary: Get bulk payment statistics
      operationId: ApiBulkPaymentsController_getStats_api/v3
      parameters:
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            type: number
        - name: limit
          required: false
          in: query
          description: Items per page
          schema:
            type: number
        - name: status
          required: false
          in: query
          description: Filter by status
          schema:
            type: string
        - name: currency
          required: false
          in: query
          description: Filter by currency
          schema:
            type: string
            enum:
              - KES
              - GHS
              - NGN
              - ZAR
              - ZAR
              - USD
              - XOF
              - ZMW
              - XAF
              - SLE
              - CDF
              - TZS
              - UGX
              - EGP
              - MWK
              - RWF
              - ETB
              - MZN
              - LSL
              - GNF
              - USDT
              - BTC
              - ETH
              - USDC
      responses:
        '200':
          description: Bulk payment statistics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPaymentStatsDto'
      security:
        - bearer: []
components:
  schemas:
    BulkPaymentStatsDto:
      type: object
      properties:
        totalBatches:
          type: number
          description: Total batches
        totalSuccessfulPayments:
          type: number
          description: Total successful payments
        totalFailedPayments:
          type: number
          description: Total failed payments
        averageBatchSize:
          type: number
          description: Average batch size
        successRate:
          type: number
          description: Success rate percentage
        currencyBreakdown:
          type: object
          description: Currency breakdown
          example:
            KES:
              totalAmount: 50000
              totalBatches: 3
              totalPayments: 25
            ZMW:
              totalAmount: 15000
              totalBatches: 1
              totalPayments: 10
      required:
        - totalBatches
        - totalSuccessfulPayments
        - totalFailedPayments
        - averageBatchSize
        - successRate
        - currencyBreakdown

````