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

# Preview Bulk Payment Batches

Preview bulk payment batches before creating them to review fees and totals.


## OpenAPI

````yaml POST /api/v3/dashboard/bulk-payments/api/preview
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/preview:
    post:
      tags:
        - API Bulk Payments
      summary: Preview bulk payment batches
      operationId: ApiBulkPaymentsController_previewBatch_api/v3
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBulkPaymentRequestDto'
      responses:
        '200':
          description: Preview of bulk payment batch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkPaymentPreviewDto'
      security:
        - bearer: []
components:
  schemas:
    CreateBulkPaymentRequestDto:
      type: object
      properties:
        batchName:
          type: string
          description: Batch name
        batchDescription:
          type: string
          description: Batch description
        recipients:
          description: Recipients list
          type: array
          items:
            $ref: '#/components/schemas/BulkPaymentRecipientDto'
        walletSelections:
          description: Currency wallet selections
          type: array
          items:
            $ref: '#/components/schemas/CurrencyWalletSelectionDto'
        callbackUrl:
          type: string
          description: Callback URL for notifications
        integratorId:
          type: string
          description: For admin use - integrator ID
      required:
        - batchName
        - recipients
        - walletSelections
    BulkPaymentPreviewDto:
      type: object
      properties:
        totalBatches:
          type: number
          description: Total batches to be created
        totalRecipients:
          type: number
          description: Total recipients across all batches
        currencyBreakdown:
          description: Breakdown by currency - never add amounts from different currencies
          type: array
          items:
            $ref: '#/components/schemas/CurrencyBreakdownDto'
      required:
        - totalBatches
        - totalRecipients
        - currencyBreakdown
    BulkPaymentRecipientDto:
      type: object
      properties:
        recipientName:
          type: string
          description: Recipient full name
        recipientEmail:
          type: string
          description: Recipient email address
        recipientPhone:
          type: string
          description: Recipient phone number
        amount:
          type: number
          description: Payment amount
        currency:
          type: string
          description: Payment currency
          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
        reference:
          type: string
          description: Unique payment reference
      required:
        - recipientName
        - recipientEmail
        - recipientPhone
        - amount
        - currency
        - reference
    CurrencyWalletSelectionDto:
      type: object
      properties:
        currency:
          type: string
          description: Currency code
          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
        walletId:
          type: string
          description: Selected wallet ID
      required:
        - currency
        - walletId
    CurrencyBreakdownDto:
      type: object
      properties:
        currency:
          type: string
          description: Currency
          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
        recipientCount:
          type: number
          description: Number of recipients
        totalAmount:
          type: number
          description: Total amount for this currency
        walletId:
          type: string
          description: Selected wallet ID
        recipients:
          description: Recipients for this currency
          type: array
          items:
            $ref: '#/components/schemas/BulkPaymentRecipientDto'
      required:
        - currency
        - recipientCount
        - totalAmount
        - walletId
        - recipients

````