POST
/Distribution/Distribute
When to Use
- Execute Step 3 of distribution workflow after declaration locks eligible investors
- Execute electronic payments to investor bank accounts
- Process distributions with automatic withholding tax deductions
- Execute batch payment processing for large distribution volumes
- Handle DRP cash components before unit allocation
- Process international payments for offshore investors
Prerequisites
- Distribution must be declared with locked investor entitlements
- Sufficient funds available in distribution accounts
- Current verified banking details for all investors
Considerations
- Once payment processing begins, distributions cannot be reversed
- Payments after banking cut-offs (typically 1:00 PM AEST) process next business day
- Foreign resident withholding tax automatically calculated and applied
- International payments require cross-border compliance verification
- DRP participants receive cash payments held until unit allocation completes
Description
Executes the distribution payment process for a declared distribution, processing cash payments to all eligible investors based on their account records and payment preferences. This endpoint initiates the payment workflows and updates account statuses to reflect distribution completion.
Distribution Workflow - Step 3 of 4
- Create: Define distribution parameters and settings
- Declare: Lock eligible investors and calculate amounts
- Distribute: Process payments to investors (this endpoint)
- Allotment: Execute DRP unit allocation if applicable
Payment Processing
Distribution execution triggers various payment methods based on investor preferences:
- Electronic Transfer: Direct bank account deposits
- Check Payment: Physical check generation and mailing
- DRP Preparation: Cash held for subsequent unit reinvestment
Required Headers - See Authentication
| Header | Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Authorization | {accessToken} | Bearer token for API access |
| Version | 2.0 | API version identifier |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
ProductID |
integer | Native 7G product identifier for execution validation and permission checks. | |
externalProductId |
string | Optional |
Client-supplied product reference (alternative to productID). |
CorporateActionID |
integer | Native 7G distribution identifier targeting payment execution. | |
externalCorporateActionId |
string | Optional |
Client-supplied distribution reference (alternative to corporateActionID). |
overrideDate |
date | Optional |
Payment execution date override (defaults to distribution's paymentDate). |
comment |
string | Optional |
Payment execution comment for audit trail and reconciliation records. |
ProductID
Native 7G product identifier for execution validation and permission checks.
externalProductId
Client-supplied product reference (alternative to productID).
CorporateActionID
Native 7G distribution identifier targeting payment execution.
externalCorporateActionId
Client-supplied distribution reference (alternative to corporateActionID).
overrideDate
Payment execution date override (defaults to distribution's paymentDate).
comment
Payment execution comment for audit trail and reconciliation records.
Example Requests
json
{
"productID": 100,
"externalProductId": "PROD-100",
"corporateActionID": 12346,
"externalCorporateActionId": "DIST-2024-Q2",
"overrideDate": "2024-07-20",
"comment": "Q2 2024 distribution payment execution with extended settlement"
}Response Examples
json
{
"result": true,
"message": "Distribution payments executed successfully",
"recordCount": 1,
"data": {
"distributionId": "EXEC-2024-Q2-001",
"corporateActionID": 12346,
"externalCorporateActionId": "DIST-2024-Q2",
"productID": 100,
"totalAmountDistributed": 135000.00,
"totalInvestorsPaid": 247,
"electronicTransfers": 198,
"checkPayments": 34,
"drpParticipants": 15,
"paymentDate": "2024-07-20",
"status": "Distributed",
"paymentBatchId": "BATCH-20240720-001",
"processedAt": "2024-07-20T09:30:45Z"
}
}