POST
/BizTransaction/Allotment
When to Use
- IPO Allotments: Allocate shares or units from new investment offerings to investor accounts
- Deposit Settlement: Convert cash deposits into investment units following successful payment processing
- Corporate Actions: Process bonus unit distributions, rights issues, and share restructures
- Capital Raisings: Distribute newly issued securities following successful fundraising rounds
- Rights Exercise: Convert exercised rights or warrants into underlying investment units
- Spin-off Distributions: Allocate new investment units from corporate demergers or restructures
Prerequisites
- Target account must be active and accessible
- Investment must be accepting allotments within cutoff periods
- Current investment pricing available or override price provided
Considerations
- Settlement Timing: Allotments typically settle T+1 to T+3 depending on investment type and payment method
- Pricing Method: Uses current investment price unless overridePrice is specified for special situations
- Partial Processing: System handles partial allotments when insufficient capacity or funds are available
- Deposit Linkage: Can allocate against specific deposit transactions for improved cash flow management
- Tax Implications: Allotments establish cost base for future capital gains tax calculations
- Compliance: Large allotments may trigger regulatory disclosure requirements or beneficial ownership reporting
Description
Processes investment allotments by allocating new securities to investor accounts. This endpoint handles the conversion of cash deposits into investment holdings, IPO distributions, and other allotment scenarios. The system automatically calculates quantities based on current pricing or accepts override prices for special allotment situations.
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 (int32) | Native product identifier validating investment belongs to correct fund structure (required for allotment unlike conditional for Deposit/Redemption). | |
externalProductId |
string | External product identifier for cross-system product correlation. | |
externalBizTransactionId |
string | Optional |
External transaction identifier for idempotency preventing duplicate allotments during integration failures (e.g., Distribution workflows, IPO processing). |
amount |
number (double) | Dollar amount for allotment (system converts to units: amount ÷ price = units allocated, used for distribution reinvestment and IPO applications). | |
quantity |
number (double) | Exact unit quantity to allot (used for bonus units, rights exercises, DRP where units already calculated). | |
overridePrice |
number (double) | Optional |
Manual price override for special allotment pricing (DRP discount pricing, IPO issue price, default: 0 uses current investmentPrice). |
comment |
string | Optional |
Audit trail notation for allotment source and context (appears on investor statements). |
accountID |
integer (int32) | Native account identifier receiving allotted units (creates/updates Holdings record for accountID+investmentID combination). | |
externalAccountId |
string | External account identifier for cross-platform integration (e.g., distribution processors, registry systems). | |
transactionDate |
string (date) | Transaction settlement date determining allotment pricing and CGT cost base date (format: YYYY-MM-DD, must not be DateOnly.MinValue per controller line 87). | |
investmentID |
integer (int32) | Native investment identifier determining unit type and pricing (amount ÷ price = units unless overridePrice specified, must have allowAllotment=true). | |
externalInvestmentId |
string | External investment identifier for cross-platform integration using fund codes, APIR codes, or ISIN. | |
depositBizTransactionID |
integer (int32) | Optional |
Links allotment to originating deposit transaction for Distribution integration workflows (AllotmentValidator line 12: if specified, must be >0 or null). |
depositExternalBizTransactionID |
string | Optional |
External deposit identifier for linking allotment to deposit using external system references (alternative to depositBizTransactionID). |
productID
Native product identifier validating investment belongs to correct fund structure (required for allotment unlike conditional for Deposit/Redemption).
externalProductId
External product identifier for cross-system product correlation.
externalBizTransactionId
External transaction identifier for idempotency preventing duplicate allotments during integration failures (e.g., Distribution workflows, IPO processing).
amount
Dollar amount for allotment (system converts to units: amount ÷ price = units allocated, used for distribution reinvestment and IPO applications).
quantity
Exact unit quantity to allot (used for bonus units, rights exercises, DRP where units already calculated).
overridePrice
Manual price override for special allotment pricing (DRP discount pricing, IPO issue price, default: 0 uses current investmentPrice).
comment
Audit trail notation for allotment source and context (appears on investor statements).
accountID
Native account identifier receiving allotted units (creates/updates Holdings record for accountID+investmentID combination).
externalAccountId
External account identifier for cross-platform integration (e.g., distribution processors, registry systems).
transactionDate
Transaction settlement date determining allotment pricing and CGT cost base date (format: YYYY-MM-DD, must not be DateOnly.MinValue per controller line 87).
investmentID
Native investment identifier determining unit type and pricing (amount ÷ price = units unless overridePrice specified, must have allowAllotment=true).
externalInvestmentId
External investment identifier for cross-platform integration using fund codes, APIR codes, or ISIN.
depositBizTransactionID
Links allotment to originating deposit transaction for Distribution integration workflows (AllotmentValidator line 12: if specified, must be >0 or null).
depositExternalBizTransactionID
External deposit identifier for linking allotment to deposit using external system references (alternative to depositBizTransactionID).
Example Requests
json
{
"productID": 10,
"externalProductId": "",
"externalBizTransactionId": "ALLOT-2024-001",
"amount": 50000.00,
"quantity": 40000.00,
"overridePrice": 1.25,
"comment": "IPO allotment - Growth Fund Class A",
"accountID": 12345,
"externalAccountId": "",
"transactionDate": "2025-08-14",
"investmentID": 25,
"externalInvestmentId": "",
"depositBizTransactionID": 998,
"depositExternalBizTransactionID": ""
}Response Examples
json
{
"result": true,
"message": "Allotment processed successfully",
"recordCount": 1,
"data": {
"bizTransactionID": 1001,
"externalBizTransactionId": "ALLOT-2024-001",
"bizTransactionTypeID": 6,
"typeName": "Allotment",
"movementReasonCode": "NEW_ALLOTMENT",
"parentBizTransactionID": null,
"transactionDate": "2025-08-14T00:00:00Z",
"productID": 10,
"externalProductId": "FUND-001",
"accountID": 12345,
"externalAccountId": "ACC-12345",
"accountNumber": "ACC001234",
"bizEntityName": "Smith Family Trust",
"investmentID": 25,
"externalInvestmentId": "INV-GROWTH",
"securityCode": "GRW001",
"investmentName": "Growth Investment Class A",
"investmentPrice": 1.2500,
"comment": "IPO allotment - Growth Fund Class A",
"corporateActionID": null,
"externalCorporateActionId": null,
"corporateActionName": null,
"amount": 50000.00,
"quantity": 40000.00,
"transactionClosingAmount": null,
"transactionClosingQuantity": null,
"accountClosingAmount": null,
"accountClosingQuantity": null,
"createdDate": "2025-08-14T10:30:15Z",
"updatedDate": null,
"bizTransactionStatusID": 1,
"statusName": "Complete"
}
}