Skip to main content
POST
Create an immediate bulk payout batch

Authorizations

x-api-key
string
header
required

Headers

X-Idempotency-Key
string
required

Unique key for this logical batch. Idempotency-Key is also accepted; if both headers are sent, they must match.

Maximum string length: 255

Body

multipart/form-data
accountNumber
string
required

Merchant-owned master wallet or subaccount number funding the batch.

batchReference
string
required

Globally unique merchant-defined batch reference.

Maximum string length: 255
executionMode
enum<string>
required
Available options:
IMMEDIATE
csvFile
file
required

UTF-8 CSV containing Account Number, Bank Name, Amount, and Narration columns.

Response

Batch accepted for processing or idempotently replayed

status
string
required
Allowed value: "success"
statusCode
enum<integer>
required
Available options:
200,
202
message
string
required
data
object
required