Disbursements API

Overview

The Disbursements API provides a complete set of operations for managing batch fund transfers from a source account to multiple destination accounts. It supports the full batch lifecycle — from creation and validation through multi-level approval to final processing.

Available Commands

#	Command	Type	Description
1	InitiateDisbursementBatchCommand	Command	Create a new disbursement batch with entries
2	AddDisbursementBatchEntryCommand	Command	Add an entry to an existing batch
3	RemoveDisbursementBatchEntryCommand	Command	Remove an entry from a batch
4	ValidateDisbursementBatchCommand	Command	Validate all destination accounts in a batch
5	ConfirmDisbursementBatchCommand	Command	Confirm a batch and move to pending review
6	ReviewDisbursementBatchCommand	Command	Accept a batch review
7	RejectDisbursementReviewCommand	Command	Reject a batch at the review stage
8	ApproveDisbursementBatchCommand	Command	Give final approval to a batch
9	RejectDisbursementApprovalCommand	Command	Reject a batch at the approval stage
10	CancelDisbursementBatchCommand	Command	Cancel a batch
11	DeleteDisbursementBatchCommand	Command	Permanently delete a batch
12	RetrieveDisbursementBatchesQuery	Query	List batches with filtering and pagination
13	RetrieveDisbursementBatchByIdQuery	Query	Get a single batch by ID
14	RetrieveDisbursementBatchEntriesQuery	Query	List entries within a batch
15	RetrieveDisbursementSourcesQuery	Query	List available disbursement sources
16	RetrieveDisbursementsQuery	Query	List individual disbursement records

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 Disbursements 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 disbursement permissions.

Batch Lifecycle

Related Operations

• Initiate Disbursement Batch — Create a new batch
• Validate Disbursement Batch — Validate destination accounts
• Retrieve Disbursement Batches — List all batches