TaxWithheldAmount
objectAllowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER
A unique identifier linking the party to the policy
Example:Party_PI_1
Allowed values:FEDERALSTATENRABACKUP
The actual dollar amount withheld for taxes
Example:100
The portion of the transaction amount eligible for taxation
Example:100
Indicates whether the transaction is taxable
Allowed values:true
The actual tax rate used for withholding calculations
Example:100
TransactionPayor
objectAllowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER
A unique identifier linking the party to the policy
Example:Party_PI_1
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE
A unique identifier for the bank associated with the payor
Example:Bank_1
TransactionPayeeOrBeneficiary
objectA unique identifier linking the party to the policy
Example:Party_PI_1
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE
The percentage of the total disbursement allocated to the payee
Example:100
A unique identifier for the financial institution handling the transaction
Example:Bank_1
The actual dollar amount disbursed to the payee
Example:20
Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER
Example:20
A unique identifier for the address associated with the payee or policyholder
Example:1
FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out).
Example:TBD
ExternalIdentifiers
objectThe unique payment reference number for all premium-related transactions by carrier
The unique ID to identify transaction on carrier side
The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program
Transaction
objectA unique identifier assigned to every transaction within the system, used to track and reference individual actions such as premium payments, policy updates, or claims etc
Example:93
1
Example:The unique identifier of the reversed transaction. When a transaction is reversed, this field holds the ID of the original transaction that was reversed. We capture this to ensure proper tracking and auditing of financial adjustments within the system
Unique identifier for the impacted party data being updated with a transaction or event. For example, if multiple addresses are modified, this field identifies the specific address Id for which change is being processed
Example:1
Trigger to Pass in API which non financial was newly added out of multiple change requests, for example a new email was added
Example:1
A code that represents the specific type of life insurance plan or annuity plan
Example:SBFIXUL1
A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract
Example:AU12345678
The unique ID to track each transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
The unique identifier of a Parent Transaction or Parent Program ID. The value of parentId varies based on the transaction type. >>For Subsequent Premium, One-Time Premium, Loan Repayment (One-Time & Systematic) → The Parent Payment Transaction ID is stamped. >> For Forceout and Disbursement → The Parent Money Out or Money In Transaction ID is stamped
Example:Arr_1
Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty
Indicates whether a transaction results in any setup, update, or modification to a systematic program or billing change. This field is set to true whenever any part of the systematic program or billing is modified, including changes to its configuration or associated fields
Allowed values:true
The date when the transaction request was initiated or received in the system. For example, for system generated events date on which transaction was initiated by the system for adhoc events date on which transaction was received by the system.
Example:2023-01-01
The date when the transaction takes effect on the policy or contract.
Example:2023-01-01
The date when the system actually processes the transaction. This may differ from the request or effective date due to business rules, batch cycle date, business day calender or reversals
Example:2023-01-01
The date when a transaction is reversed in the system
Example:2023-01-01
Allowed values:PendingCompletedFailedReversedCanceledPendingReversal
Allowed values:truefalse
A system-generated code that corresponds to the transaction outcome when transaction is cancelled
Example:true
A detailed explanation of the outcome, providing context for why a transaction was cancelled
Example:precheck validations failed
The justification or business reason for the transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
A unique identifier assigned to a transaction case by external systems such as BPM.
Example:e2eb325f-203b-4d49-b6d5-41072cb66866
The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)
Example:Party_PI_1
Create or Update timestamp of transaction event
Example:2023-01-01T12:00:00.000Z
A boolean flag that applies only to financial transactions. When set to true, it allows a backdated transaction to be processed. This triggers a reversal on the policy to the earliest transaction on the specified effective date, applies the new transaction, and then reprocesses all subsequent transactions (similar to (R&R) process). This ensures that the policy`s financial history remains accurate and aligned with the backdated change.
Default:false
Example:true
Version number indicating the number of changes made to policy
Example:1