POST
/BizEvent/NoticeOfRedemption
When to Use
- Create redemption event notice records for investor withdrawal requests
- Record redemption details including quantity, amount, and transaction date
- Create event records with external identifiers for system integration
Prerequisites
- Valid account and investment identifiers (native or external)
- TransactionDate in YYYY-MM-DD format
Considerations
- Returns single event record upon successful creation
- Supports both amount-based and quantity-based redemptions (either or both can be provided)
- External identifiers (externalProductId, externalAccountId, externalInvestmentId) can be used as alternatives to native IDs
Description
Creates a redemption event notice record with specified quantity or amount, transaction date, and account/investment references. Returns the created event record with assigned BizEventID for tracking purposes.
Redemption Event Records
Redemption notice records capture withdrawal request details including investor comments and external transaction identifiers for system integration.
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
json
{
"productID": 100,
"externalProductId": "PROD-001",
"externalBizTransactionId": "REDEMP-001",
"investmentID": 200,
"externalInvestmentId": "INV-REDEMP-001",
"accountID": 5678,
"externalAccountId": "ACC-001",
"amount": 25000.00,
"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
}
}