Skip to main content
POST
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
batches
/
create
Create bulk payment batches
curl --request POST \
  --url https://sandbox-api.kotanipay.com/api/v3/dashboard/bulk-payments/api/batches/create \
  --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>"
}
'
[
  {
    "id": "<string>",
    "batchName": "<string>",
    "status": "<string>",
    "totalAmount": 123,
    "totalPayments": 123,
    "successfulPayments": 123,
    "failedPayments": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "progress": [
      {
        "step": "<string>",
        "status": "<string>",
        "message": "<string>",
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z",
        "details": {}
      }
    ]
  }
]
Create bulk payment batches from validated payment data.

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

201 - application/json

Created bulk payment batch

id
string
required

Batch ID

batchName
string
required

Batch name

status
string
required

Batch status

totalAmount
number
required

Total amount

totalPayments
number
required

Total payments count

successfulPayments
number
required

Successful payments count

failedPayments
number
required

Failed payments count

createdAt
string<date-time>
required

Created date

progress
object[]
required

Progress tracking