Search
K
Policy

Transactions

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions

Query Parameters

reverseInitiatorOnlyboolean
statusarray[string]
endDatestring
startDatestring
limitinteger
offsetinteger
sortFieldstring

Allowed values:EFFECTIVEDATEPROCESSDATEREVERSALDATE

sortOrderstring

Allowed values:ASCDESC

versioninteger
transactionTypesarray[string]

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

transactionIdstring

A 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

originalTransactionIdstring

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

partyPolicyChangeReferenceIdstring

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

partyPolicyNewReferenceIdstring

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

planCodestring

A code that represents the specific type of life insurance plan or annuity plan

Example:SBFIXUL1

policyNumberstring

A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract

Example:AU12345678

correlationIdstring

The unique ID to track each transaction request across all systems

Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d

parentIdstring

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

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

systematicOrBillingChangeIndicatornumber

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

requestDatestring(date)

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

effectiveDatestring(date)

The date when the transaction takes effect on the policy or contract.

Example:2023-01-01

processDatestring(date)

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

reversalDatestring(date)

The date when a transaction is reversed in the system

Example:2023-01-01

statusstring

Allowed values:PendingCompletedFailedReversedCanceledPendingReversal

outcomestring

Allowed values:truefalse

outcomeCodestring

A system-generated code that corresponds to the transaction outcome when transaction is cancelled

Example:true

outcomeCodeDescriptionstring

A detailed explanation of the outcome, providing context for why a transaction was cancelled

Example:precheck validations failed

transactionReasonstring

The justification or business reason for the transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS

transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsobject
Show Child Parameters
fundActivitiesobject
Show Child Parameters
matchActivityobject
Show Child Parameters
loanActivityobject
Show Child Parameters
taxBasisobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
payorsarray[object]
Show Child Parameters
payeeOrBeneficiariesarray[object]
Show Child Parameters
caseIdstring

A unique identifier assigned to a transaction case by external systems such as BPM.

Example:e2eb325f-203b-4d49-b6d5-41072cb66866

partyIdstring

The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)

Example:Party_PI_1

timestampstring

Create or Update timestamp of transaction event

Example:2023-01-01T12:00:00.000Z

reverseInitiatorboolean

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

versioninteger(int32)

Version number indicating the number of changes made to policy

Example:1

externalIdentifiersobject
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/transactions
 
application/json

Transaction By Id

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}

Query Parameters

statusarray[string]
endDatestring
startDatestring
limitnumber
offsetnumber
sortOrderstring
versionnumber
transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

Path Parameters

planCodestringrequired
policyNumberstringrequired
transactionIdstringrequired

Response

application/json

OK

Transaction

transactionIdstring

A 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

originalTransactionIdstring

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

partyPolicyChangeReferenceIdstring

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

partyPolicyNewReferenceIdstring

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

planCodestring

A code that represents the specific type of life insurance plan or annuity plan

Example:SBFIXUL1

policyNumberstring

A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract

Example:AU12345678

correlationIdstring

The unique ID to track each transaction request across all systems

Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d

parentIdstring

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

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

systematicOrBillingChangeIndicatornumber

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

requestDatestring(date)

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

effectiveDatestring(date)

The date when the transaction takes effect on the policy or contract.

Example:2023-01-01

processDatestring(date)

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

reversalDatestring(date)

The date when a transaction is reversed in the system

Example:2023-01-01

statusstring

Allowed values:PendingCompletedFailedReversedCanceledPendingReversal

outcomestring

Allowed values:truefalse

outcomeCodestring

A system-generated code that corresponds to the transaction outcome when transaction is cancelled

Example:true

outcomeCodeDescriptionstring

A detailed explanation of the outcome, providing context for why a transaction was cancelled

Example:precheck validations failed

transactionReasonstring

The justification or business reason for the transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS

transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsobject
Show Child Parameters
fundActivitiesobject
Show Child Parameters
matchActivityobject
Show Child Parameters
loanActivityobject
Show Child Parameters
taxBasisobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
payorsarray[object]
Show Child Parameters
payeeOrBeneficiariesarray[object]
Show Child Parameters
caseIdstring

A unique identifier assigned to a transaction case by external systems such as BPM.

Example:e2eb325f-203b-4d49-b6d5-41072cb66866

partyIdstring

The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)

Example:Party_PI_1

timestampstring

Create or Update timestamp of transaction event

Example:2023-01-01T12:00:00.000Z

reverseInitiatorboolean

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

versioninteger(int32)

Version number indicating the number of changes made to policy

Example:1

externalIdentifiersobject
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{transactionId}
 
application/json

Transaction by External Transaction Id

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}

Path Parameters

planCodestringrequired
policyNumberstringrequired
externalIdstringrequired
externalIdTypestringrequired

Allowed values:ExternalTransactionIdReferenceNumberExternalArrangementId

Response

application/json

OK

Transaction

transactionIdstring

A 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

originalTransactionIdstring

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

partyPolicyChangeReferenceIdstring

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

partyPolicyNewReferenceIdstring

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

planCodestring

A code that represents the specific type of life insurance plan or annuity plan

Example:SBFIXUL1

policyNumberstring

A unique identifier assigned to a policy, used to track and manage the details of the insurance or annuity contract

Example:AU12345678

correlationIdstring

The unique ID to track each transaction request across all systems

Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d

parentIdstring

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

transactionTypestring

Specifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc

Allowed values:ActivationAddOwnerAddressChangeAgentChangeAnnuitantChangeAnniversaryAnnualPolicyRefreshAndRecalculationAssigneeChangeBankAccountChangeBeneficiaryChangeCalendarProcessingCancelNoPremiumClaimPayoutCommunicationPreferenceChangeConversionActivationCostOfInsuranceCoverageChargeCoverageCreditDeathClaimDeliveryDateSetupDisbursementEmailChangeExistingPartyNameChangeExpenseChargeFaceAmountChangeFaceAmountDecreaseFaceAmountIncreaseFeatureChangeForceOutFreeLookExpirationFreeLookCancellationFullSurrenderFundAllocationsChangeFundTransferGrantorChangePaymentInitialPremiumIdentifierChangeInitialPremiumInterestCreditInterestCreditLoanInterestCreditMatchInterestLoanIssuanceLapseLapseAssessmentLoanAnniversaryTrueUpLoanRepaymentOneTimeMatchBonusVestingMultipleBeneficiaryChangeMultipleEmailChangeMultiplePayeeChangeMultipleAgentChangeMultipleOwnerChangeMultipleAnnuitantChangeMultiplePhoneNumberChangeNewLoanNotificationOfDeathClaimOneTimePremiumOwnerChangePartialWithdrawalOneTimePayeeChangePaymentExpirationPaymentLoanRepaymentOneTimePaymentOneTimePremiumPaymentSystematicLoanRepaymentPayorChangePhoneNumberChangeRateRenewalRemoveOwnerRescissionPowerOfAttorneyChangePreferredMailingAddressChangeReinstatementReinstatementApprovedRequiredMinimumDistributionOneTimeSubsequentPaymentSubsequentPremiumSweepSystematicLoanRepaymentSystematicLoanRepaymentSetupSystematicPartialWithdrawalSystematicPartialWithdrawalSetupSystematicRequiredMinimumDistributionSystematicRequiredMinimumDistributionSetupSystematicPaymentSetupSystematicAnnuityPayoutSystematicAnnuityPayoutSetupSystematicProgramUpdateTPDChangeTrusteeChangeUnitExpenseChargeValueAdjustmentYearBeginningRefreshAndRecalculationWithdrawnApplicationDollarCostAverageProcessingDateServiceChargeTransferChargeRiderAdditionAnnuitizationAnnuityBenefitReductionReclassificationFlatExtraChangeCommutationDividendDividendFeatureChargeMarketTimerFeeInterimAnnualProcessingHardshipWithdrawalHardshipEndResetBenefitAmountsGuaranteedAccumulationBenefitPeriodEndGainLossChargeBackSpousalContinuationPeriodicChargeDeathBenefitLockInRatchetLockInGrowthDeathBenefitLockInDateOfDeathBenefitAmountAutoAdjustmentNotificationOfRiderClaimStartLongTermCareBenefitStartStopDailyRatchetAnnuitizationAnniversaryDeclineFeeChangeGuaranteedWithdrawalBenefitPaymentLockInExcessInterestCreditLongTermCareWithdrawalGuaranteedWithdrawalBenefitInterestAdjustmentInvestmentAdvisorFeePayoutAmountChangeAdditionalBenefitStartAdditionalBenefitEndRiderActivationAnniversaryAdditionalBenefitRenewQualifiedPlanChangeAdvanceAnnuityPaymentPartialCommutationGuaranteedIndexRatesBailoutRenewalNonLifeAnnuitizationAdditionalBenefitReCertificationCostBasisReceivedFreeWithdrawalRecalculationYearEndGainLongTermCareCertificationDateQuarterlyProcessingBenefitBaseAdjustmentRiderBenefitBaseLockInGuaranteedDeathBenefitRollUpRenewGuaranteedWithdrawalBenefitRollUpRenewRiderChargeLongTermCareFeeStartStopLongTermCareAssessmentChargeRoleBirthdayPendingUnclaimedPropertyPendingPartialUnclaimedPropertyLiquidatedUnclaimedProperty

systematicOrBillingChangeIndicatornumber

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

requestDatestring(date)

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

effectiveDatestring(date)

The date when the transaction takes effect on the policy or contract.

Example:2023-01-01

processDatestring(date)

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

reversalDatestring(date)

The date when a transaction is reversed in the system

Example:2023-01-01

statusstring

Allowed values:PendingCompletedFailedReversedCanceledPendingReversal

outcomestring

Allowed values:truefalse

outcomeCodestring

A system-generated code that corresponds to the transaction outcome when transaction is cancelled

Example:true

outcomeCodeDescriptionstring

A detailed explanation of the outcome, providing context for why a transaction was cancelled

Example:precheck validations failed

transactionReasonstring

The justification or business reason for the transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS

transactionAmountsobject
Show Child Parameters
exchangeobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
coverageBenefitarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsobject
Show Child Parameters
fundActivitiesobject
Show Child Parameters
matchActivityobject
Show Child Parameters
loanActivityobject
Show Child Parameters
taxBasisobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
payorsarray[object]
Show Child Parameters
payeeOrBeneficiariesarray[object]
Show Child Parameters
caseIdstring

A unique identifier assigned to a transaction case by external systems such as BPM.

Example:e2eb325f-203b-4d49-b6d5-41072cb66866

partyIdstring

The impacted party associated with a transaction or event.(party change requests i.e. non financial txns)

Example:Party_PI_1

timestampstring

Create or Update timestamp of transaction event

Example:2023-01-01T12:00:00.000Z

reverseInitiatorboolean

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

versioninteger(int32)

Version number indicating the number of changes made to policy

Example:1

externalIdentifiersobject
Show Child Parameters
get/policy/v1/policies/{planCode}/{policyNumber}/transactions/{externalIdType}/{externalId}
 
application/json

Systematic Programs

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms

Query Parameters

referenceIdstring
referenceTypestring

Allowed values:PartyIdBankIdAddressId

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

arrangementTypestring

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

arrangementIdstring

The unique payment number for payments by the party

Example:Arr_1

allocationOptionTypestring

Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY

reasonstring

Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION

numberOfOccurrencenumber(int32)

Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program

Example:12

disbursementTypestring

Allowed values:GROSSNETNETNET

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

frequencystring

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

requestedDatestring(date)

The date on which the request for the systematic program was submitted

Example:2023-01-01

startDatestring(date)

The date when the systematic program begins executing payments or transfers (entered by user)

Example:2023-01-01

endDatestring(date)

The date Special Program ends (Entered by user or determined by LPS based on Account Value)

Example:2023-01-01

previousProgramDatestring(date)

The last date on which a systematic transaction was processed

Example:2023-01-01

optedNextProgramDatestring(date)

A user-selected or modified next payment date, different from the scheduled one

Example:2023-01-01

nextProgramDatestring(date)

The date on which the next payment is scheduled

Example:2023-01-01

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

amountnumber(double)

A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program

Example:600

partyarray[object]

Note -Use systematicProgram.parties field instead of systematicProgram.party

Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired

The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program

Example:arrangementid123

get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms
 
application/json

Systematic Programs for External Transaction Id

get
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}

Query Parameters

referenceIdstring
referenceTypestring

Allowed values:PartyIdBankIdAddressId

Path Parameters

planCodestringrequired
policyNumberstringrequired
externalIdstringrequired
externalIdTypestringrequired

Allowed values:ExternalTransactionIdReferenceNumberExternalArrangementId

Response

application/json

OK

arrangementTypestring

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

arrangementIdstring

The unique payment number for payments by the party

Example:Arr_1

allocationOptionTypestring

Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY

reasonstring

Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION

numberOfOccurrencenumber(int32)

Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program

Example:12

disbursementTypestring

Allowed values:GROSSNETNETNET

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

frequencystring

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

requestedDatestring(date)

The date on which the request for the systematic program was submitted

Example:2023-01-01

startDatestring(date)

The date when the systematic program begins executing payments or transfers (entered by user)

Example:2023-01-01

endDatestring(date)

The date Special Program ends (Entered by user or determined by LPS based on Account Value)

Example:2023-01-01

previousProgramDatestring(date)

The last date on which a systematic transaction was processed

Example:2023-01-01

optedNextProgramDatestring(date)

A user-selected or modified next payment date, different from the scheduled one

Example:2023-01-01

nextProgramDatestring(date)

The date on which the next payment is scheduled

Example:2023-01-01

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

amountnumber(double)

A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program

Example:600

partyarray[object]

Note -Use systematicProgram.parties field instead of systematicProgram.party

Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired

The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program

Example:arrangementid123

get/policy/v1/policies/{planCode}/{policyNumber}/systematicPrograms/{externalIdType}/{externalId}
 
application/json