TransactionSubtype
objectComplete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts
Transaction subtype name
Example:Partial Withdrawal
Transaction subtype code
Example:PARTIAL_WD
Amount associated with this transaction subtype from VI 21209 response.
Maps transaction subtypes to their corresponding VI amounts:
- INTEREST_ONLY → interestOnlyAmount
- RMD → rmdAmount
- RIDER_FREE → riderFreeAmount
- FREE_AVAILABLE → freeAvailableAmount (surrenderValueWithoutMarketValueAdjustment)
- SURRENDER_FREE_ATD → surrenderFreeAmountATD (freeWithdrawalAmount)
- SURRENDER/PARTIAL → surrenderValue
Null if VI data is not available or amount is zero.
Example:5000
Minimum transaction amount
Example:100.00
Maximum transaction amount
Example:50000.00
Minimum percentage allowed
Example:1
Maximum percentage allowed
Example:100
Minimum remaining balance amount after transaction
Example:500.00
Minimum contract amount
Example:1000
Generic code/displayName object
Example:{"code":"PRO_RATA","displayName":"Pro Rata"}{"code":"SPECIFIC_FUND","displayName":"Specific Fund"}
Show Child Parameters
Generic code/displayName object
Example:{"code":"DOLLAR","displayName":"Dollar Amount"}{"code":"PERCENT","displayName":"Percentage"}{"code":"UNITS","displayName":"Units"}
Show Child Parameters
Generic code/displayName object
Example:{"code":"GROSS","displayName":"Gross"}{"code":"NET","displayName":"Net"}
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Example:{"code":"CHECK","displayName":"Check"}{"code":"EFT","displayName":"Electronic Funds Transfer"}{"code":"WIRE","displayName":"Wire Transfer"}
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Minimum tax withholding percentage
Example:0
Maximum tax withholding percentage
Example:100
Tax transfer amount type
Example:PERCENT
Available calendar date
Example:2024-01-01
Minimum duration value
Example:1
Generic code/displayName object
Show Child Parameters
Maximum duration value
Example:365
Generic code/displayName object
Show Child Parameters
Effective date duration with min/max values in days
Show Child Parameters
Jurisdiction effective date
Example:2024-01-01
Sale effective date
Example:2024-01-01
Sale expiration date
Example:2025-12-31
Feature code
Example:PARTIAL_WD_001
Maximum number of feature instances
Example:12
Generic code/displayName object
Show Child Parameters
Feature product information
Maximum number of source investment products
Example:10
Minimum number of source investments
Example:1
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
Generic code/displayName object
Show Child Parameters
EffectiveDateDuration
objectEffective date duration with min/max values in days
Minimum duration in days
Example:1
Maximum duration in days
Example:365
CodeDisplayName
objectGeneric code/displayName object
Code value
Example:WD
Display name
Example:Withdrawal
ViAmounts
objectVI-derived amount values for withdrawal rule evaluation.
Contains real-time policy values from VI 21209 response.
Interest-only withdrawal amount
Example:500
Required Minimum Distribution amount
Example:1000
Rider free amount
Example:200
Free available amount (surrenderValueWithoutMarketValueAdjustment)
Example:300
Surrender-free amount year-to-date
Example:400
Total surrender value
Example:10000
Total policy value
Example:50000
ViFund
objectVI-derived fund information with withdrawal eligibility
Fund identifier (ProductCode)
Example:ABAF
Fund key (SubAccountKey)
Example:SUB123
Fund name
Example:LVIP American Balanced Allocation Fund
Whether withdrawals are allowed from this fund
Example:true
Total value of the fund
Example:5000
Available funds amount
Example:4500
Number of units held
Example:100.25
Fund restriction reason if any
Whether transfer send is allowed
Example:true
Whether fund can be a transfer destination
Example:true