POST

/BizTransaction/Deposit

Usage Notes

When

  • Process initial investment deposits for new accounts
  • Handle additional contributions to existing holdings
  • Record lump sum or scheduled investment deposits

Requirements

  • Account must exist and be active
  • Investment must exist with active pricing for transaction date
  • TransactionDate required (cannot be empty)

Notes

  • Deposits increase account holdings by specified quantity
  • Transaction records are permanent - use offsetting transactions for corrections
  • PricePerUnit and fees recorded for statements and reporting

Description

Creates a deposit transaction that increases account holdings. Returns complete transaction record with system-assigned bizTransactionID for confirmation and reconciliation.

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
amount >
number (double)
Gross deposit amount before fee deductions. Used to calculate units when quantity not specified.
comment
 string
Optional
Audit trail notation for deposit purpose, source, and context (appears on investor statements).
chequeAccountNumber
 string
Optional
Bank account number from which cheque drawn (required when paymentMethodID indicates cheque).
chequeBankName
 string
Optional
Financial institution name for cheque payment (required when paymentMethodID indicates cheque).
chequeBSB
 string
Optional
BSB routing number for Australian cheque payments (required when paymentMethodID indicates cheque, format: XXX-XXX).
chequeChequeNo
 string
Optional
Cheque serial number for payment identification (required when paymentMethodID indicates cheque).
chequeDrawer
 string
Optional
Legal name of individual or entity who wrote the cheque (required when paymentMethodID indicates cheque).
entryFeeAmount
 number (double)
Optional
Fixed dollar entry fee overriding percentage-based calculations (net investment = gross deposit minus fee).
entryFeePercentage
 number (double)
Optional
Standard entry fee as percentage of deposit amount (e.g., 2.0 = 2% fee).
entryFeeDiscountPercentage
 number (double)
Optional
Discount reduction applied to entryFeePercentage for promotional offers or volume discounts.
entryFeeOverridePercentage
 number (double)
Optional
Complete fee override replacing entryFeePercentage and discounts (setting to 0 waives all fees).
accountID >
integer (int32)
Native account identifier for deposit (creates/updates Holdings record for accountID+investmentID combination).
externalAccountId >
string
External account identifier for cross-platform integration.
externalBizTransactionId
 string
Optional
External transaction identifier for idempotency and preventing duplicate transactions during integration failures.
investmentID >
integer (int32)
Native investment identifier determining unit pricing and fee structures (amount ÷ investmentPrice = units allocated).
externalInvestmentId >
string
External investment identifier for cross-platform integration using external fund codes or APIR codes.
productID >
integer (int32)
Native product identifier validating investment belongs to correct fund structure.
externalProductId >
string
External product identifier for cross-system product correlation.
paymentMethodID >
integer (int32)
Payment method classification determining settlement processing and required supporting documentation (cheque, direct debit, wire transfer).
transactionDate >
string (date)
Transaction date for the deposit. Format: YYYY-MM-DD. Cannot be empty or default value.
amount
number (double)
Gross deposit amount before fee deductions. Used to calculate units when quantity not specified.
comment
string
Optional
Audit trail notation for deposit purpose, source, and context (appears on investor statements).
chequeAccountNumber
string
Optional
Bank account number from which cheque drawn (required when paymentMethodID indicates cheque).
chequeBankName
string
Optional
Financial institution name for cheque payment (required when paymentMethodID indicates cheque).
chequeBSB
string
Optional
BSB routing number for Australian cheque payments (required when paymentMethodID indicates cheque, format: XXX-XXX).
chequeChequeNo
string
Optional
Cheque serial number for payment identification (required when paymentMethodID indicates cheque).
chequeDrawer
string
Optional
Legal name of individual or entity who wrote the cheque (required when paymentMethodID indicates cheque).
entryFeeAmount
number (double)
Optional
Fixed dollar entry fee overriding percentage-based calculations (net investment = gross deposit minus fee).
entryFeePercentage
number (double)
Optional
Standard entry fee as percentage of deposit amount (e.g., 2.0 = 2% fee).
entryFeeDiscountPercentage
number (double)
Optional
Discount reduction applied to entryFeePercentage for promotional offers or volume discounts.
entryFeeOverridePercentage
number (double)
Optional
Complete fee override replacing entryFeePercentage and discounts (setting to 0 waives all fees).
accountID
integer (int32)
Native account identifier for deposit (creates/updates Holdings record for accountID+investmentID combination).
externalAccountId
string
External account identifier for cross-platform integration.
externalBizTransactionId
string
Optional
External transaction identifier for idempotency and preventing duplicate transactions during integration failures.
investmentID
integer (int32)
Native investment identifier determining unit pricing and fee structures (amount ÷ investmentPrice = units allocated).
externalInvestmentId
string
External investment identifier for cross-platform integration using external fund codes or APIR codes.
productID
integer (int32)
Native product identifier validating investment belongs to correct fund structure.
externalProductId
string
External product identifier for cross-system product correlation.
paymentMethodID
integer (int32)
Payment method classification determining settlement processing and required supporting documentation (cheque, direct debit, wire transfer).
transactionDate
string (date)
Transaction date for the deposit. Format: YYYY-MM-DD. Cannot be empty or default value.

Example Requests

bash
# Direct debit deposit (no cheque details)
curl -X POST 'https://api.7g.com.au/BizTransaction/Deposit' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 25000.00,
    "comment": "Monthly contribution - automatic debit",
    "entryFeePercentage": 2.0,
    "entryFeeDiscountPercentage": 0.5,
    "accountID": 12345,
    "investmentID": 25,
    "productID": 10,
    "paymentMethodID": 2,
    "transactionDate": "2025-08-14"
  }'

# Cheque deposit (with cheque details)
curl -X POST 'https://api.7g.com.au/BizTransaction/Deposit' \
  -H 'Authorization: {accessToken}' \
  -H 'Version: 2.0' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 50000.00,
    "comment": "Initial investment - Growth Fund",
    "chequeAccountNumber": "123456789",
    "chequeBankName": "Commonwealth Bank",
    "chequeBSB": "062-001",
    "chequeChequeNo": "001234",
    "chequeDrawer": "John Smith",
    "entryFeePercentage": 2.0,
    "accountID": 12345,
    "investmentID": 25,
    "productID": 10,
    "paymentMethodID": 1,
    "transactionDate": "2025-08-14"
  }'

Response Examples

json
{
  "result": true,
  "message": "Deposit processed successfully",
  "recordCount": 1,
  "data": {
    "bizTransactionID": 3001,
    "externalBizTransactionId": "DEP-2024-001",
    "bizTransactionTypeID": 1,
    "typeName": "Deposit",
    "movementReasonCode": "NEW_INVESTMENT",
    "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.2500,
    "comment": "Initial investment - Growth Fund",
    "corporateActionID": null,
    "externalCorporateActionId": null,
    "corporateActionName": null,
    "amount": 50000.00,
    "quantity": 40000.00,
    "transactionClosingAmount": null,
    "transactionClosingQuantity": null,
    "accountClosingAmount": null,
    "accountClosingQuantity": null,
    "createdDate": "2025-08-14T10:30:15Z",
    "updatedDate": null,
    "bizTransactionStatusID": 1,
    "statusName": "Complete"
  }
}
GET Get BizTransactions POST Redemption POST Allotment GET Get Account Holdings