POST
/BizEvent/NoticeOfRedemption
Usage Notes
When
- Record pending redemption before actual processing
- Pre-register redemptions for workflow tracking
Requirements
- Account and Investment must exist
- TransactionDate required
Notes
- Creates single event record
- Specify either quantity or amount
Description
Creates a redemption event notice representing a pending redemption operation.
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 identifier for the product. | |
externalProductId |
string | External system identifier for the product (alternative to productID). | |
externalBizTransactionId |
string | Optional |
External transaction identifier for system integration. |
InvestmentID |
integer | Native 7G identifier for the investment. | |
externalInvestmentId |
string | External system identifier for the investment (alternative to investmentID). | |
AccountID |
integer | Native 7G identifier for the account. | |
externalAccountId |
string | External system identifier for the account (alternative to accountID). | |
amount |
decimal | Optional |
Monetary value to be redeemed. Optional (either amount or quantity can be specified). |
quantity |
decimal | Optional |
Number of units to redeem. Optional (either amount or quantity can be specified). |
comment |
string | Optional |
Additional notes or redemption reason. |
transactionDate |
date | Optional |
Effective date for the redemption (YYYY-MM-DD format). |
ProductID
Native 7G identifier for the product.
externalProductId
External system identifier for the product (alternative to productID).
externalBizTransactionId
External transaction identifier for system integration.
InvestmentID
Native 7G identifier for the investment.
externalInvestmentId
External system identifier for the investment (alternative to investmentID).
AccountID
Native 7G identifier for the account.
externalAccountId
External system identifier for the account (alternative to accountID).
amount
Monetary value to be redeemed. Optional (either amount or quantity can be specified).
quantity
Number of units to redeem. Optional (either amount or quantity can be specified).
comment
Additional notes or redemption reason.
transactionDate
Effective date for the redemption (YYYY-MM-DD format).
Example Requests
bash
curl -X POST 'https://api.7g.com.au/BizEvent/NoticeOfRedemption' \
-H 'Authorization: {accessToken}' \
-H 'Version: 2.0' \
-H 'Content-Type: application/json' \
-d '{
"productID": 100,
"investmentID": 200,
"accountID": 5678,
"quantity": 1000.00,
"comment": "Partial redemption for liquidity needs",
"transactionDate": "2024-03-15"
}'Response Examples
json
{
"result": true,
"message": "Redemption notice created successfully",
"recordCount": 1,
"data": {
"bizEventID": 50002,
"bizEventTypeID": 52,
"bizEventStatusID": 1,
"productID": 100,
"externalProductId": "PROD-001",
"investmentID": 200,
"externalInvestmentId": "INV-REDEMP-001",
"accountID": 5678,
"externalAccountId": "ACC-001",
"accountNumber": "ACC123456",
"bizEntityName": "Smith Family Trust",
"bizEventDate": "2024-03-15",
"amount": 25000.00,
"quantity": 1000.00,
"comment": "Partial redemption for liquidity needs",
"conversionMethodID": null,
"conversionFactor": null,
"createdDate": "2024-03-15T14:20:00Z",
"updatedDate": null
}
}