Skip to main content
POST
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
preview
Preview bulk payment batches
curl --request POST \
  --url https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/preview \
  --header 'Content-Type: application/json' \
  --data '
{
  "batchName": "<string>",
  "recipients": [
    {
      "recipientName": "<string>",
      "recipientEmail": "<string>",
      "recipientPhone": "<string>",
      "amount": 123,
      "currency": "KES",
      "reference": "<string>"
    }
  ],
  "walletSelections": [
    {
      "currency": "KES",
      "walletId": "<string>"
    }
  ],
  "batchDescription": "<string>",
  "callbackUrl": "<string>",
  "integratorId": "<string>"
}
'
{
  "totalBatches": 123,
  "totalRecipients": 123,
  "currencyBreakdown": [
    {
      "currency": "KES",
      "recipientCount": 123,
      "totalAmount": 123,
      "walletId": "<string>",
      "recipients": [
        {
          "recipientName": "<string>",
          "recipientEmail": "<string>",
          "recipientPhone": "<string>",
          "amount": 123,
          "currency": "KES",
          "reference": "<string>"
        }
      ]
    }
  ]
}
Preview bulk payment batches before creating them to review fees and totals.

Body

application/json
batchName
string
required

Batch name

recipients
object[]
required

Recipients list

walletSelections
object[]
required

Currency wallet selections

batchDescription
string

Batch description

callbackUrl
string

Callback URL for notifications

integratorId
string

For admin use - integrator ID

Response

200 - application/json

Preview of bulk payment batch

totalBatches
number
required

Total batches to be created

totalRecipients
number
required

Total recipients across all batches

currencyBreakdown
object[]
required

Breakdown by currency - never add amounts from different currencies