POST

/BizTransaction/Redemption

Usage Notes

When

  • Process investor withdrawals and portfolio reductions
  • Execute unit liquidation with cash conversion
  • Handle partial or full account redemptions

Requirements

  • Account must have sufficient holdings
  • Investment must exist with active pricing
  • TransactionDate required

Notes

  • Specify either quantity (units) or amount (dollars) - system calculates the other
  • Exit fees deducted from redemption proceeds
  • Transaction records are permanent

Description

Creates a redemption transaction that decreases account holdings. Returns complete transaction record including calculated exit fees and net proceeds.

Required Headers - See Authentication

HeaderValueDescription
Content-Typeapplication/jsonRequest content type
Authorization{accessToken}Bearer token for API access
Version2.0API 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
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.

Example Requests

bash
# Amount-based redemption (dollar value)
curl -X POST 'https://api.7g.com.au/BizTransaction/Redemption' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "productID": 10,
    "amount": 25000.00,
    "comment": "Partial redemption for education expenses",
    "accountID": 12345,
    "exitFeeAmount": 0,
    "exitFeePercent": 1.5,
    "investmentID": 25,
    "reasonID": 1,
    "transactionDate": "2025-08-14"
  }'

# Quantity-based redemption (unit count)
curl -X POST 'https://api.7g.com.au/BizTransaction/Redemption' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "productID": 10,
    "quantity": 20000.00,
    "comment": "Systematic withdrawal - monthly income",
    "accountID": 12345,
    "exitFeeAmount": 0,
    "exitFeePercent": 0,
    "investmentID": 25,
    "reasonID": 2,
    "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"
  }
}
GET Get BizTransactions POST Deposit POST Transfer GET Get Account Holdings