Create Remita Collection Batch

Overview

Creates a new collection batch for grouping loan repayment collections. The batch is created in Draft status and must be authorized before it can be run. Optionally, you can pre-populate the batch with specific loan requests at creation time.

Command Details

• Command: CreateRemitaCollectionBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchName	string	Yes	Name for the collection batch
batchDescription	string	No	Description or label for the batch
organisationId	long	Yes	Organisation the batch belongs to
loanRequestIds	array of long	No	Pre-populate batch with specific loan requests

Try It Out

POST/api/bpm/cmdCreateRemitaCollectionBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "CreateRemitaCollectionBatchCommand", "data": { "batchName": "March 2026 Loan Collections", "batchDescription": "Monthly Remita loan repayment batch", "organisationId": 1001, "loanRequestIds": [ 5001, 5002, 5003 ] } }

Response Structure

{
  "success": true,
  "data": {
    "id": 3001,
    "batchName": "March 2026 Loan Collections",
    "status": "Draft",
    "createdAt": "2026-03-08T10:30:00Z"
  },
  "message": "Collection batch created successfully"
}

Related Operations

• Authorize Collection Batch — Authorize the batch for execution
• Run Collection Batch — Execute all collections in the batch
• Retrieve Collection Batches — List batch records