Search
K
Policy Transactions

Initial Premium Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

InitialPremiumRequest

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

correlationIdstring

The unique ID to track transaction request across all systems

Example:864e43a0-2c2f-4a11-9d7f-69ed40115066

effectiveDatestring(date)

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

Example:2023-01-01

reverseInitiatorboolean

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

Default:false

transactionReasonstring

Optional Reason for this transaction

Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICE

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
exchangeobject
Show Child Parameters
taxBasisobject
Show Child Parameters
payorobject
Show Child Parameters

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/initialpremium

Body

{}
 
application/json

Eligibility Check For Fund Allocation

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations/eligibilitycheck
 
application/json

Validation Check For Fund Allocation

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

FundAllocationChangeRequest

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

correlationidstring

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

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

Example:2023-01-01

reverseInitiatorboolean

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

allocationobjectrequired
Show Child Parameters

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations/validation

Body

{ "effectiveDate": "2023-01-01", "allocation": { "investmentType": "INVESTMENTFUND", "fundAllocationsInvestments": [ { "fundId": "FundAccount1", "allocationPercentage": 100, "startDate": "2024-01-01" } ] } }
 
application/json

Fund Allocation Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

FundAllocationChangeRequest

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

correlationidstring

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

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

Example:2023-01-01

reverseInitiatorboolean

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

allocationobjectrequired
Show Child Parameters

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fundallocations

Body

{ "effectiveDate": "2023-01-01", "allocation": { "investmentType": "INVESTMENTFUND", "fundAllocationsInvestments": [ { "fundId": "FundAccount1", "allocationPercentage": 100, "startDate": "2024-01-01" } ] } }
 
application/json

Eligibility Check For Fund Transfer

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/fundtransfer/eligibilitycheck
 
application/json