Remita Collections API

Overview

The Remita Collections API provides operations for managing loan repayment collections via the Remita payment platform. It supports batch-based collection workflows — creating batches of loan requests, authorizing them through a maker-checker flow, executing the collection run against Remita, and posting or reversing resulting transactions.

Available Commands

#	Command	Type	Description
1	CreateRemitaCollectionBatchCommand	Command	Create a new collection batch from loan requests
2	AuthorizeRemitaCollectionBatchCommand	Command	Authorize a collection batch for execution
3	RejectRemitaCollectionBatchCommand	Command	Reject a collection batch
4	RunRemitaCollectionBatchCommand	Command	Execute all collections in an authorized batch
5	CancelRemitaCollectionBatchCommand	Command	Cancel a collection batch
6	RetrieveRemitaCollectionBatchesQuery	Query	List collection batches with filtering
7	RetrieveRemitaCollectionBatchByIdQuery	Query	Get a single collection batch by ID
8	RetrieveRemitaCollectionsQuery	Query	List individual collection records
9	PostRemitaCollectionCommand	Command	Post a successful collection transaction
10	ReverseRemitaCollectionCommand	Command	Reverse a posted collection transaction

Common Request Pattern

All commands and queries are sent as a POST to the unified BPM endpoint:

POST /api/bpm/cmd
Content-Type: application/json
Authorization: Bearer {token}

Request body:

{
  "$type": "CommandOrQueryClassName",
  // ...command-specific fields
}

Common Response Pattern

Success:

{
  "success": true,
  "data": { },
  "message": "Operation completed successfully"
}

Error:

{
  "success": false,
  "data": null,
  "message": "Description of what went wrong",
  "errors": ["Detailed error 1", "Detailed error 2"]
}

Authentication

All Remita Collections API requests require a valid Bearer token in the Authorization header. Tokens are obtained via the authentication endpoint and must belong to a user with the appropriate collection permissions.

Collection Batch Lifecycle

Collection Transaction Flow

Related Operations

• Create Collection Batch — Create a batch for bulk collections
• Retrieve Collection Batches — List batch records
• Retrieve Collections — List individual collection records