Run Remita Collection Batch

Overview

Executes all collection items in an authorized batch. Each item triggers a debit request to Remita against the associated mandate. The batch transitions to Processing status while collections are being submitted.

warning

Running a collection batch will initiate real debit calls to the Remita platform. Each collection item will attempt to debit the payer's account at their bank. Ensure the batch contents are correct before executing this command. This action cannot be undone once Remita begins processing.

Command Details

• Command: RunRemitaCollectionBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
id	long	Yes	The ID of the batch to execute

Try It Out

POST/api/bpm/cmdRunRemitaCollectionBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "RunRemitaCollectionBatchCommand", "data": { "id": 3001 } }

Response Structure

{
  "success": true,
  "data": {
    "id": 3001,
    "status": "Processing",
    "startedAt": "2026-03-08T14:00:00Z"
  },
  "message": "Collection batch execution started"
}

Related Operations

• Authorize Collection Batch — Authorize the batch before running
• Retrieve Collections — List individual collection records
• Retrieve Collection Batches — List batch records