Initiate Disbursement Batch

Overview

Creates a new disbursement batch with one or more entries. This is the primary command for initiating a batch fund transfer from a single source account to multiple destination accounts. The batch is created in Draft status.

Command Details

• Command: InitiateDisbursementBatchCommand
• Type: Command (write operation)
• Status on success: Batch created in Draft status
• Permissions required: Disbursement Create

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchDescription	string	Yes	Description for the batch
sourceAccount	string	Yes	Source account number for funds
transactionSource	int	No	Transaction source identifier (default: 1)
entries	array	Yes	List of disbursement entries
entries[].bankCode	string	Yes	Bank code of destination
entries[].destinationAccount	string	Yes	Destination account number
entries[].amount	decimal	Yes	Amount to disburse
entries[].narration	string	No	Narration for the entry

Try It Out

POST/api/bpm/cmdInitiateDisbursementBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "InitiateDisbursementBatchCommand", "data": { "batchDescription": "March 2026 Salary Disbursement", "sourceAccount": "0012345678", "transactionSource": 1, "entries": [ { "bankCode": "058", "destinationAccount": "0098765432", "amount": 250000, "narration": "March salary - John Doe" }, { "bankCode": "044", "destinationAccount": "0056781234", "amount": 180000, "narration": "March salary - Jane Smith" } ] } }

Response Structure

{
  "success": true,
  "data": {
    "batchId": 1024,
    "status": "Draft",
    "batchDescription": "March 2026 Salary Disbursement",
    "sourceAccount": "0012345678",
    "totalAmount": 430000.00,
    "entryCount": 2,
    "createdAt": "2026-03-08T10:30:00Z"
  },
  "message": "Disbursement batch created successfully"
}

Related Operations

• Add Disbursement Batch Entry — Add more entries to the batch after creation
• Remove Disbursement Batch Entry — Remove an entry from the batch
• Validate Disbursement Batch — Validate destination accounts
• Confirm Disbursement Batch — Submit batch for review