Search
K
Policy Transactions

EligibleTransactionsResponse

object
cusipstring

Example:123456789

productCodestring

Example:ADDAARP

eligibleTransactionTypesarray[object]

List of eligible transaction types

Show Child Parameters
Example

LoanRepaymentOneTimeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
payorobject
Show Child Parameters
caseIdstring

Example:CA0000007389

Example

NewLoanRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]required
Show Child Parameters
partiesarray[object]required
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

Example

FullSurrenderRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

overrideboolean

BPM will have to override the rules if this variable is marked as true

taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
transactionAmountsobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

Example

PartialWithdrawalOneTimeRequest

object

Partial withdrawal one-time transaction request including transaction amounts, fund allocation, parties, tax withholding, and signatures.

correlationIdstring

The unique ID to track transaction request across all systems

Example:test-112132141

effectiveDatestring(date)required

Date when the transaction was originally scheduled or expected to happen. It can be a non-business day

Example:2026-03-17

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

selfServeFlowboolean

Whether the request originated from a self-serve flow

transactionTypestring

Transaction type for partial withdrawal one-time requests

Allowed values:PARTIAL_WITHDRAWAL

Example:PARTIAL_WITHDRAWAL

externalIdentifiersobject
Show Child Parameters
transactionReasonstring

Reason for the partial withdrawal one-time transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCENOTRANSACTIONREASONSTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTAMOUNTGWBRIDERDISBURSEMENTGWBPHASECHANGEFREQUENCYPREMIUMLOANPAYMENTDUEDATE

Example:ONETIMEPREMIUM

transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
suppressionarray[object]
Show Child Parameters
signaturesarray[object]
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

overrideboolean

BPM will have to override the rules if this variable is marked as true

Example