POST

/BizEvent/NoticeOfDeposit

When to Use

  • Coordinate deposit workflows with AML/CTF compliance checks for contributions ≥$10,000 AUD requiring AUSTRAC reporting and enhanced due diligence
  • Generate settlement preparation notices for T+1 to T+3 processing timelines with pricing date validation and banking reconciliation requirements
  • Trigger automated investor communications upon deposit acceptance with mandatory fee disclosure and entry fee calculation transparency
  • Create pre-transaction coordination layer before BizTransaction/Deposit execution ensuring proper workflow sequencing and audit trail compliance
  • Process initial investment deposits with cheque clearing verification, banking details validation, and payment method reconciliation

Prerequisites

  • Valid Bearer token with event creation permissions
  • Active Investment record with allowAllotment=true - verify via GET /Investment before notice creation to prevent rejected deposits
  • Valid InvestmentPrice record for transactionDate - required for unit allocation calculations and pricing validation
  • Existing account records with sufficient KYC/AML documentation for regulatory compliance
  • Banking infrastructure configured for payment method processing (EFT, Direct Debit, Cheque clearing)

Considerations

⚠️ Critical Deposit Processing Rules

  • AML/CTF Compliance: Deposits ≥$10,000 AUD trigger AUSTRAC reporting requirements and enhanced customer due diligence - failure results in regulatory penalties up to $21M AUD
  • Settlement Timing: T+1 to T+3 settlement windows based on payment method (EFT=T+1, Cheque=T+3) - transactionDate cannot be future-dated
  • Entry Fee Calculations: Entry fees calculated at service layer using entryFeePercentage, entryFeeAmount takes precedence over percentage-based fees if both provided
  • Event Immutability: Once processed to Completed status, deposit events cannot be cancelled - requires reversal transaction via BizTransaction/Redemption
  • Workflow Sequence: BizEvent notice generation must precede BizTransaction/Deposit execution for regulatory audit compliance and investor notification timing

Description

Creates a notice of deposit event to confirm successful investor contributions and fee processing. Generates event records for compliance audit trail and triggers stakeholder notification workflows. Supports various payment methods and automatic fee calculation.

Deposit Processing

Deposit notices confirm the receipt and processing of investor funds, including entry fee calculations and payment method validation. The system tracks cheque details for audit purposes when applicable.

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
Native 7G identifier for the product containing the investment.
externalBizTransactionId
 string
Optional
External transaction identifier for cross-system reference and audit trail.
externalProductId >
string
Your external identifier for the product (alternative to productID).
InvestmentID >
integer
Native 7G identifier for the investment receiving the deposit funds.
externalInvestmentId >
string
Your external identifier for the investment (alternative to investmentID).
AccountID >
integer
Native 7G identifier for the account where funds will be deposited.
externalAccountId >
string
Your external identifier for the account (alternative to accountID).
amount
 decimal
Optional
Monetary value of the deposit. Used for unit calculations and fee computations.
comment
 string
Optional
Additional notes, deposit reason, or special instructions for processing.
transactionDate
 date
Optional
Effective date when the deposit is processed (YYYY-MM-DD format). Defaults to current date if not specified.
paymentMethodID
 integer
Optional
Payment method identifier (1=EFT, 2=Cheque, 3=Direct Debit). Required for payment processing.
chequeBankName
 string
Optional
Bank name for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeBSB
 string
Optional
Bank State Branch code for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeAccountNumber
 string
Optional
Bank account number for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeChequeNo
 string
Optional
Cheque number for audit trail. Required when paymentMethodID is 2 (Cheque).
chequeDrawer
 string
Optional
Name of the person who wrote the cheque. Required when paymentMethodID is 2 (Cheque).
entryFeeAmount
 decimal
Optional
Fixed entry fee amount in currency units. Takes precedence over percentage-based fees.
entryFeeDiscountPercentage
 decimal
Optional
Discount percentage to apply to calculated entry fees (0.0 to 100.0).
entryFeeOverridePercentage
 decimal
Optional
Override percentage to replace standard entry fee calculations (0.0 to 100.0).
entryFeePercentage
 decimal
Optional
Entry fee percentage to apply to deposit amount (0.0 to 100.0). Standard fee structure.
ProductID
integer
Native 7G identifier for the product containing the investment.
externalBizTransactionId
string
Optional
External transaction identifier for cross-system reference and audit trail.
externalProductId
string
Your external identifier for the product (alternative to productID).
InvestmentID
integer
Native 7G identifier for the investment receiving the deposit funds.
externalInvestmentId
string
Your external identifier for the investment (alternative to investmentID).
AccountID
integer
Native 7G identifier for the account where funds will be deposited.
externalAccountId
string
Your external identifier for the account (alternative to accountID).
amount
decimal
Optional
Monetary value of the deposit. Used for unit calculations and fee computations.
comment
string
Optional
Additional notes, deposit reason, or special instructions for processing.
transactionDate
date
Optional
Effective date when the deposit is processed (YYYY-MM-DD format). Defaults to current date if not specified.
paymentMethodID
integer
Optional
Payment method identifier (1=EFT, 2=Cheque, 3=Direct Debit). Required for payment processing.
chequeBankName
string
Optional
Bank name for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeBSB
string
Optional
Bank State Branch code for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeAccountNumber
string
Optional
Bank account number for cheque deposits. Required when paymentMethodID is 2 (Cheque).
chequeChequeNo
string
Optional
Cheque number for audit trail. Required when paymentMethodID is 2 (Cheque).
chequeDrawer
string
Optional
Name of the person who wrote the cheque. Required when paymentMethodID is 2 (Cheque).
entryFeeAmount
decimal
Optional
Fixed entry fee amount in currency units. Takes precedence over percentage-based fees.
entryFeeDiscountPercentage
decimal
Optional
Discount percentage to apply to calculated entry fees (0.0 to 100.0).
entryFeeOverridePercentage
decimal
Optional
Override percentage to replace standard entry fee calculations (0.0 to 100.0).
entryFeePercentage
decimal
Optional
Entry fee percentage to apply to deposit amount (0.0 to 100.0). Standard fee structure.

Example Requests

json
{
  "productID": 100,
  "externalBizTransactionId": "DEPOSIT-001",
  "externalProductId": "PROD-001",
  "investmentID": 200,
  "externalInvestmentId": "INV-DEPOSIT-001",
  "accountID": 5678,
  "externalAccountId": "ACC-001",
  "amount": 50000.00,
  "comment": "Initial investment deposit - bank transfer",
  "transactionDate": "2024-01-15",
  "paymentMethodID": 1,
  "chequeBankName": "Commonwealth Bank",
  "chequeBSB": "062-001",
  "chequeAccountNumber": "12345678",
  "chequeChequeNo": "000123",
  "chequeDrawer": "John Smith",
  "entryFeeAmount": 750.00,
  "entryFeeDiscountPercentage": 0.0,
  "entryFeeOverridePercentage": 0.0,
  "entryFeePercentage": 1.5
}

Response Examples

json
{
  "result": true,
  "message": "Deposit notice created successfully",
  "recordCount": 1,
  "data": [
    {
      "bizEventID": 50001,
      "bizEventTypeID": 51,
      "bizEventStatusID": 1,
      "productID": 100,
      "externalProductId": "PROD-001",
      "investmentID": 200,
      "externalInvestmentId": "INV-DEPOSIT-001",
      "accountID": 5678,
      "externalAccountId": "ACC-001",
      "accountNumber": "ACC123456",
      "bizEntityName": "Smith Family Trust",
      "bizEventDate": "2024-01-15",
      "amount": 50000.00,
      "quantity": null,
      "comment": "Initial investment deposit - bank transfer",
      "conversionMethodID": null,
      "conversionFactor": null,
      "createdDate": "2024-01-15T09:30:00Z",
      "updatedDate": null
    }
  ]
}
GET Get Events POST Execute Deposit PUT Cancel Event