POST
/Distribution/Distribute
Usage Notes
When
- Process payments to investors
- Execute step 3 of 4-stage workflow
- Complete cash distribution processing
Requirements
- Distribution must be declared
- Declaration calculations complete
Notes
- Step 3 of 4-stage workflow
- Creates payment records for distribution processing
- Proceeds to allotment stage for DRP participants
Description
Processes distribution payments to investors. Step 3 of the 4-stage workflow. Creates payment records for cash distributions and identifies DRP participants for allotment stage.
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
bash
# Execute distribution payments by corporate action ID
curl -X POST 'https://api.7g.com.au/Distribution/Distribute' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"productID": 100,
"corporateActionID": 12346,
"comment": "Standard Q2 2024 distribution execution"
}'
# Execute with external ID and override date
curl -X POST 'https://api.7g.com.au/Distribution/Distribute' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"productID": 100,
"externalCorporateActionId": "DIST-2024-Q2",
"overrideDate": "2024-07-20",
"comment": "Distribution with custom payment date"
}'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"
}
}