Skip to main content
GET
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
batches
/
{batchId}
Get bulk payment batch by ID
curl --request GET \
  --url https://sandbox-api.kotanipay.com/api/v3/api/v3/dashboard/bulk-payments/api/batches/{batchId}
{
  "id": "<string>",
  "recipientName": "<string>",
  "recipientEmail": "<string>",
  "recipientPhone": "<string>",
  "amount": 123,
  "currency": "KES",
  "reference": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "customerKey": "<string>",
  "withdrawalId": "<string>",
  "errorMessage": "<string>"
}
Get detailed information about a specific bulk payment batch.

Path Parameters

batchId
string
required

Response

200 - application/json

Bulk payment batch retrieved successfully

id
string
required

Payment ID

recipientName
string
required

Recipient name

recipientEmail
string
required

Recipient email

recipientPhone
string
required

Recipient phone

amount
number
required

Payment amount

currency
enum<string>
required

Currency

Available options:
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
string
required

Payment reference

status
string
required

Payment status

createdAt
string<date-time>
required

Created date

customerKey
string

Customer key if created

withdrawalId
string

Withdrawal ID if processed

errorMessage
string

Error message if failed