Search
K
Policy Transactions

Create case for transaction

This operation must be invoked before submitting a transaction request. The service is responsible for creating a new case record, which becomes the prerequisite reference for all subsequent transaction activities.

post

Body

application/json

CreateCaseRequest

planCodestringrequired

Product code provided by the Zinnia system

Example:ABC001

policyNumberstring

In case of Post Issue Policy Number will be mandatory

Example:EVGL1234567

correlationIdstring

The correlationId associated with the case.

Example:218d8992-3783-42ac-b59a-66cbc36adaab

caseTypestringrequired

The type associated with the case.

Allowed values:ReinstatementNew Business

Example:Reinstatement

caseSubTypestringrequired

The type associated with the case.

Allowed values:ReinstatementLife Application

Example:Reinstatement

identifiersarray[object]required

An object representing an identifier and its corresponding value.

Show Child Parameters

Response

application/json

Case Created

CaseSuccessResponse

caseIdstring

Example:CA000000536

correlationIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

eappIdstring

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

policyNumberstring

Example:ABC37457845

post/policy/v1/transactions/case

Body

{ "planCode": "ABC001", "caseType": "Reinstatement", "caseSubType": "Reinstatement", "identifiers": [ {} ] }
 
application/json

Systematic Program Quote Request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

SystematicProgramQuoteRequest

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

arrangementIdstring

The unique ID for the systematic programs available in the policy

Example:arr_1

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/quote

Body

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

Cancel Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

CancelTransactionRequest

correlationIdstring

Example:657b717b7dcf554abf9ef067

transactionIdstringrequired

Example:377

reasonstringrequired

Reason for cancellation

Example:Entered Incorrect Email Id

externalTransactionIdstring

Transaction ID from external system

Example:A12345

caseIdstring

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}/canceltransaction

Body

{ "transactionId": "377", "reason": "Entered Incorrect Email Id" }
 
application/json

Ref-Data

Ref-Data

Get PPFA Reference Data by Policy

Fetches PPFA integrated reference data filtered by policy. Includes VI restriction filtering for transaction subtypes and disbursement types.

get

Query Parameters

transactionTypestring

Optional transaction type filter

Allowed values:OneTimeWithdrawalSystematicWithdrawalAssetRebalancing

Example:OneTimeWithdrawal

Path Parameters

planCodestringrequired

Plan code

Example:534222609

policyNumberstringrequired

Policy number

Example:959343323

Response

application/json

Successful response

idstring

Unique identifier

Example:678f1a2b3c4d5e6f7890abcd

planNamestring

Name of the plan

Example:Variable Annuity Premier Growth Plan

policyProductTypeobject

Generic code/displayName object

Show Child Parameters
featureMappingobject

Generic code/displayName object

Show Child Parameters
featureCodestring

Feature code

Example:PARTIAL_WD_001

arrangementTypeobject

Generic code/displayName object

Show Child Parameters
arrangementSubTypeobject

Generic code/displayName object

Show Child Parameters
transactionTypearray[object]

Generic code/displayName object

Show Child Parameters
transactionSubtypesarray[object]

Complete transaction subtype with all arrangement and fund details, enriched with VI 21209 real-time amounts

Show Child Parameters
paymentModeobject

Generic code/displayName object

Show Child Parameters
paymentMethodarray[object]

Generic code/displayName object

Show Child Parameters
fundDisbursementTypearray[object]

Generic code/displayName object

Show Child Parameters
disbursementTypesarray[string]

Applicable disbursement types from VI

Example:Gross, Net

sourceTransferAmtTypearray[object]

Generic code/displayName object

Show Child Parameters
amountQualifierarray[object]

Generic code/displayName object

Show Child Parameters
taxRateBasedOnobject

Generic code/displayName object

Show Child Parameters
taxWithholdingCollectobject

Generic code/displayName object

Show Child Parameters
taxWithholdingPlaceobject

Generic code/displayName object

Show Child Parameters
withholdStateIfFederalIndobject

Generic code/displayName object

Show Child Parameters
taxJurisdictionobject

Generic code/displayName object

Show Child Parameters
taxMinPercentagestring

Minimum tax percentage

Example:0

taxMaxPercentagestring

Maximum tax percentage

Example:100

taxTransferAmtTypestring

Tax transfer amount type

Example:PERCENT

jurisdictionobject

Generic code/displayName object

Show Child Parameters
effectiveDateDurationobject

Effective date duration with min/max values in days

Show Child Parameters
featureMaxNumInstancesnumber

Maximum feature instances

Example:12

minContractAmtnumber

Minimum contract amount

Example:1000

maxNumSourceInvestProdnumber

Maximum source investment products

Example:10

minNumSourceInvestmentsnumber

Minimum source investments

Example:1

featureProductCodeobject

Generic code/displayName object

Show Child Parameters
featureProductInfoarray[object]

Feature product information

actionTypeAllowedarray[object]

Generic code/displayName object

Show Child Parameters
planCodestring

Plan code

Example:534222609

viAmountsobject

VI-derived amount values for withdrawal rule evaluation.
Contains real-time policy values from VI 21209 response.

Show Child Parameters
viFundsarray[object]

VI-derived fund information with withdrawal eligibility

Show Child Parameters
get/bpm/v1/policies/{planCode}/{policyNumber}/refdata
 
application/json