Policy Transactions
Cancel a case
Cancels an existing case based on eligibility rules. The API validates that the case exists and that the associated BPM process has not yet started. If eligible, the case is transitioned to a CANCELLED status, cancellation metadata is persisted, and a NES cancellation event is emitted. Only cases in NOT_STARTED BPM state can be cancelled.
put
Path Parameters
caseIdstringrequired
The unique identifier of the case to cancel
Example:CA0000007516
Body
application/json
Body
application/json
CaseCancellationRequest
correlationIdstringrequired
Unique identifier to trace the request across systems
Example:218d8992-3783-42ac-b59a-66cbc36adaa2
planCodestringrequired
Product code provided by the Zinnia system
Example:TL0101
policyNumberstringrequired
The policy number associated with the case
Example:FIUL463340020
reasonstringrequired
The reason for cancelling the case
Example:User requested cancellation
requestedBystring
The entity requesting cancellation. Derived from the authenticated token.
Example:CLIENT
typestringrequired
The transaction type associated with the case
Example:Reinstatement
subTypestring
The transaction sub-type associated with the case
Example:Reinstatement
Response
application/json
Response
application/json
Cancellation accepted and BPM process triggered
CaseCancellationResponse
caseIdstring
The unique identifier of the cancelled case
Example:CA0000007516
correlationIdstring
Unique identifier to trace the request across systems
Example:218d8992-3783-42ac-b59a-66cbc36adaa2
caseStatusstring
The updated status of the case
Example:CANCELLED
messagestring
Confirmation message
Example:Case cancellation initiated successfully
put/policy/v1/cases/{caseId}/cancel
Authentication
Path Parameters
Body
{
"correlationId": "218d8992-3783-42ac-b59a-66cbc36adaa2",
"planCode": "TL0101",
"policyNumber": "FIUL463340020",
"reason": "User requested cancellation",
"requestedBy": "CLIENT",
"type": "Reinstatement",
"subType": "Reinstatement"
}
application/json
Systematic Program Quote Request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/quote
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"systematicProgram": {
"paymentForm": "DTCC",
"arrangementType": "PAYMENT"
}
}
application/json
Cancel Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
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
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/canceltransaction
Authentication
Path Parameters
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
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
Authentication
Path Parameters
Query Parameters
application/json