Search
K
Policy Transactions

Submit OneTime Premium Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

OneTimePremiumRequest

correlationIdstring

The unique ID to track transaction request across all systems

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

transactionAmountsobjectrequired
Show Child Parameters
payorAny Of
required
Variant 1object
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

overrideboolean

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

Response

application/json

Submit Transaction Successful

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

post/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium

Body

{ "effectiveDate": "2023-01-01", "transactionAmounts": { "requestedAmount": 0 }, "payor": { "bankId": "bankId" } }
 
application/json

Eligibility Check OneTime Premium Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

OneTime Premium Success Response

TransactionResponse

statusstring

Allowed values:successfailure

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

Eligibility Check Reinstatement Request

Draft Specifications (Subject to Change Upon Review)

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

ReinstatementQuoteRequest

correlationIdstringrequired

The unique ID to track transaction request across all systems

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

Default:false

externalIdentifiersobject
Show Child Parameters
policyobjectrequired
Show Child Parameters

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

{ "correlationId": "657b717b7dcf554abf9ef067", "effectiveDate": "2023-01-01", "policy": { "policyFeatures": [ { "featureType": "REINSTATEMENT" } ] } }
 
application/json

Submit Reinstatement Transaction Request

Draft Specifications (Subject to Change Upon Review)

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

ReinstatementRequest

correlationIdstringrequired

The unique ID to track transaction request across all systems

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

Default:false

policyobjectrequired
Show Child Parameters
transactionAmountsobjectrequired
Show Child Parameters
systematicProgramobjectrequired
Show Child Parameters
caseIdstringrequired

Zinnia Live Case ID

Example:CA0000007389

Response

application/json

Submit Transaction Successful

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

post/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement

Body

{ "correlationId": "657b717b7dcf554abf9ef067", "effectiveDate": "2023-01-01", "policy": { "policyFeatures": [ { "featureType": "REINSTATEMENT", "approvalDate": "2025-08-26", "effectiveDate": "2025-08-26", "underwritingDecision": "APPROVED" } ] }, "transactionAmounts": { "requestedAmount": 0, "appliedAmount": 0, "netPaymentAmount": 0 }, "systematicProgram": { "paymentForm": "DTCC", "arrangementType": "PAYMENT", "amountType": "AMOUNT", "frequency": "DAILY" }, "caseId": "CA0000007389" }
 
application/json

Validate Systematic Program Update Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired
arrangementIdstringrequired

arrangementId is the unique id for the systematic programs available in the policy

Example:Arr_1

Body

application/json

SystematicProgramUpdateRequest

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

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

reverseInitiatorboolean

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

systematicProgramobjectrequired
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

externalTransactionIdstring

Transaction ID from external system

Example:A12345

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

{ "effectiveDate": "effectiveDate", "systematicProgram": { "paymentForm": "DTCC", "arrangementType": "PAYMENT" } }
 
application/json