POST
/BizTransaction/Redemption
When to Use
- Process partial or full investment withdrawals from investor accounts
- Handle retirement payouts and pension distribution requests
- Execute systematic withdrawal plans for regular income payments
- Facilitate portfolio rebalancing through strategic redemptions
- Process final redemptions for investment account closures
Prerequisites
- Valid authentication token (see Required Headers)
- Account record must exist with sufficient holdings for the redemption
- Investment record must exist and be active
- Transaction date must be provided (cannot be empty or default value)
Considerations
- Redemption transactions decrease account holdings by the specified quantity
- Transaction records are permanent - corrections require new offsetting transactions
- PricePerUnit and associated fees are recorded for client statements 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 a redemption transaction record and decreases account holdings by the specified quantity. Each redemption includes transaction details such as quantity, price per unit, associated fees, and transaction date.
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. | |
externalProductId |
string | External product identifier for cross-system product correlation. | |
amount |
number (double) | Dollar amount to redeem (system converts to units: amount ÷ price = units redeemed, redemptions ≥$10,000 AUD trigger enhanced monitoring). | |
overridePrice |
number (double) | Optional |
Manual price override for special circumstances (default: 0 uses current investment redemption price for transactionDate). |
comment |
string | Optional |
Audit trail notation for redemption purpose and context (appears on investor statements). |
accountID |
integer (int32) | Native account identifier specifying account from which to redeem units (system validates sufficient holdings available). | |
externalAccountId |
string | External account identifier for cross-platform integration. | |
exitFeeAmount |
number (double) | Fixed dollar exit fee (both exitFeeAmount and exitFeePercent apply cumulatively for total fee calculation). | |
exitFeePercent |
number (double) | Exit fee as percentage of redemption proceeds (e.g., 1.5 = 1.5% fee, combined with exitFeeAmount for total fee). | |
externalBizTransactionId |
string | Optional |
External transaction identifier for idempotency and preventing duplicate redemptions during integration failures. |
investmentID |
integer (int32) | Native investment identifier determining redemption pricing and fee structures (quantity × redemptionPrice = gross proceeds). | |
externalInvestmentId |
string | External investment identifier for cross-platform integration using fund codes or APIR codes. | |
quantity |
number (double) | Exact unit quantity to redeem (system converts to dollars: quantity × price = gross proceeds, account must have sufficient holdings). | |
reasonID |
integer (int32) | Redemption reason classification code from system lookup table. | |
transactionDate |
string (date) | Transaction date for the redemption. Format: YYYY-MM-DD. Cannot be empty or default value. |
productID
Native product identifier validating investment belongs to correct fund structure.
externalProductId
External product identifier for cross-system product correlation.
amount
Dollar amount to redeem (system converts to units: amount ÷ price = units redeemed, redemptions ≥$10,000 AUD trigger enhanced monitoring).
overridePrice
Manual price override for special circumstances (default: 0 uses current investment redemption price for transactionDate).
comment
Audit trail notation for redemption purpose and context (appears on investor statements).
accountID
Native account identifier specifying account from which to redeem units (system validates sufficient holdings available).
externalAccountId
External account identifier for cross-platform integration.
exitFeeAmount
Fixed dollar exit fee (both exitFeeAmount and exitFeePercent apply cumulatively for total fee calculation).
exitFeePercent
Exit fee as percentage of redemption proceeds (e.g., 1.5 = 1.5% fee, combined with exitFeeAmount for total fee).
externalBizTransactionId
External transaction identifier for idempotency and preventing duplicate redemptions during integration failures.
investmentID
Native investment identifier determining redemption pricing and fee structures (quantity × redemptionPrice = gross proceeds).
externalInvestmentId
External investment identifier for cross-platform integration using fund codes or APIR codes.
quantity
Exact unit quantity to redeem (system converts to dollars: quantity × price = gross proceeds, account must have sufficient holdings).
reasonID
Redemption reason classification code from system lookup table.
transactionDate
Transaction date for the redemption. Format: YYYY-MM-DD. Cannot be empty or default value.
Example Requests
json
{
"productID": 10,
"externalProductId": "",
"amount": 25000.00,
"overridePrice": 0,
"comment": "Partial redemption for education expenses",
"accountID": 12345,
"externalAccountId": "",
"exitFeeAmount": 0,
"exitFeePercent": 1.5,
"externalBizTransactionId": "RED-2024-001",
"investmentID": 25,
"externalInvestmentId": "",
"quantity": 0,
"reasonID": 1,
"transactionDate": "2025-08-14"
}Response Examples
json
{
"result": true,
"message": "Redemption processed successfully",
"recordCount": 1,
"data": {
"bizTransactionID": 4001,
"externalBizTransactionId": "RED-2024-001",
"bizTransactionTypeID": 2,
"typeName": "Redemption",
"movementReasonCode": "PARTIAL_WITHDRAWAL",
"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.2750,
"comment": "Partial redemption for education expenses",
"corporateActionID": null,
"externalCorporateActionId": null,
"corporateActionName": null,
"amount": -25000.00,
"quantity": -19607.84,
"transactionClosingAmount": null,
"transactionClosingQuantity": null,
"accountClosingAmount": null,
"accountClosingQuantity": null,
"createdDate": "2025-08-14T10:30:15Z",
"updatedDate": null,
"bizTransactionStatusID": 1,
"statusName": "Complete"
}
}