POST
/BizTransaction/Allotment
When to Use
- Allocate shares or units from new investment offerings to investor accounts
- Convert cash deposits into investment units following successful payment processing
- Process bonus unit distributions, rights issues, and share restructures
- Distribute newly issued securities following successful fundraising rounds
- Convert exercised rights or warrants into underlying investment units
- Allocate new investment units from corporate demergers or restructures
Prerequisites
- Valid authentication token (see Required Headers)
- Source account (unallocated pool) must exist with sufficient units available
- Target account must exist in the system
- Investment record must exist and be active
- Transaction date must be provided (cannot be empty or default value)
Considerations
- Allotment transactions allocate units from source account (unallocated pool) to target account
- Transaction records are permanent - corrections require new offsetting transactions
- PricePerUnit is recorded for transaction value calculation and reporting
- ExternalBizTransactionId enables matching with external system records (dual-ID system)
- Returned transaction record includes complete details for confirmation and record-keeping
Description
Creates an allotment transaction that allocates units from an unallocated pool account to a specific investor account. Common use cases include processing new unit issues after capital raising or distributing units following application approvals.
The API validates that a transaction date is provided and returns the complete transaction record including system-generated identifiers (BizTransactionID) and external reference fields. Transaction data can be used for investor statements, reconciliation, and external reporting systems.
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 date for the allotment. Format: YYYY-MM-DD. Cannot be empty or default value. | |
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. If specified, must be greater than 0. |
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 date for the allotment. Format: YYYY-MM-DD. Cannot be empty or default value.
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. If specified, must be greater than 0.
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"
}
}