Retrieve Disbursement Sources

Overview

Retrieves the list of available disbursement sources. These are the accounts or channels from which funds can be disbursed.

Command Details

• Command: RetrieveDisbursementSourcesQuery
• Type: Query (read operation)
• Permissions required: Disbursement View

API Endpoint

POST /api/bpm/cmd

Request Structure

This query takes no parameters. It returns all available disbursement sources.

Try It Out

POST/api/bpm/cmdRetrieveDisbursementSourcesQuery

Base URL

Bearer Token

Request Body

{ "cmd": "RetrieveDisbursementSourcesQuery", "data": {} }

Response Structure

{
  "success": true,
  "data": [
    {
      "accountNumber": "0011234567",
      "sourceAccountName": "Main Disbursement Account",
      "sourceAccountCIF": "CIF001",
      "sourceChannel": "INTERNAL",
      "disbursementSourceAccountGroup": 1,
      "sourceGroupDescription": "Primary Disbursement Pool",
      "isEnabled": true
    }
  ],
  "message": "Disbursement sources retrieved successfully."
}

YAML Configuration

Disbursement sources are configured in the Channel Configuration (CC config). Add entries under the disbursementSources key:

disbursementSources:
  - accountNumber: '0011234567'
    sourceAccountName: Main Disbursement Account
    sourceAccountCIF: CIF001
    sourceChannel: INTERNAL
    disbursementSourceAccountGroup: 1
    sourceGroupDescription: Primary Disbursement Pool
    isEnabled: true
  - accountNumber: '0019876543'
    sourceAccountName: Payroll Disbursement Account
    sourceAccountCIF: CIF002
    sourceChannel: INTERNAL
    disbursementSourceAccountGroup: 2
    sourceGroupDescription: Payroll Pool
    isEnabled: true

Field	Type	Required	Description
accountNumber	string	Yes	Source account number
sourceAccountName	string	Yes	Display name for the source account
sourceAccountCIF	string	No	Core banking CIF for the source account
sourceChannel	string	No	Channel identifier (e.g. INTERNAL, NIBSS)
disbursementSourceAccountGroup	int	No	Group number for categorising sources (default: 1)
sourceGroupDescription	string	No	Description of the source group
isEnabled	bool	No	Whether the source is available for new batches (default: true)

info

If no sources are configured in the CC config, the system falls back to the DisbursementBatchSource database table.

Related Operations

• Initiate Disbursement Batch — Create a batch using a source
• Retrieve Disbursement Batches — List all batches