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

caseTypestring

The type associated with the case.

Allowed values:ReinstatementNew Business

Example:Reinstatement

caseSubTypestring

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", "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

Receives policyholder authorization status from MPV and updates the status

put

Path Parameters

planCodestringrequired

The plan code for the policy number

Example:planCode

policyNumberstringrequired

Policy Number

Example:policyNumber

Body

application/json

Policyholder Authorization request

AuthorizationStatusRequest

recordIdstringrequired

Unique record ID (maps to transactionID)

Example:546bed32-a8b6-43dc-8772-cefb1d469b1d

correlationIdstringrequired

Correlation ID linking BPM - MPV transaction

Example:468cd184-fb43-4a20-aa8c-23df99c0a353

caseIdstringrequired

Case identifier within BPM

Example:CA0000487609

policyNumberstringrequired

Policy Number associated with the transaction

Example:FM00000001

authorizationStatusstringrequired

Policy Holder Authorization Status

Allowed values:APPROVEDDENIED

Example:APPROVED

actionTakenBystring

Name of Policy Holder

Example:Flora Anderson

actionTimestampstring(date-time)required

Generated at Time

Example:2025-06-02T10:45:00Z

sourcestring

Source system sending the callback

Default:MPV

Example:My Policy View

Response

application/json

OK - Callback processed successfully

AuthorizationStatusResponse

statusinteger

Example:200

put/bpm/v1/policies/{planCode}/{policyNumber}/authorization/status

Body

{ "recordId": "546bed32-a8b6-43dc-8772-cefb1d469b1d", "correlationId": "468cd184-fb43-4a20-aa8c-23df99c0a353", "caseId": "CA0000487609", "policyNumber": "FM00000001", "authorizationStatus": "APPROVED", "actionTimestamp": "2025-06-02T10:45:00Z" }
 
application/json

Secure API to get TransactionData by transactionId

get

Path Parameters

transactionIdstringrequired

Response

application/json

Transaction Model success

TransactionModelResponse

Model for a transaction with detailed information.

recordIdstring

Unique identifier for the transaction record.

correlationIdstring

Correlation ID associated with the transaction.

transactionTypestring

Type of transaction.

carrierstring

Carrier associated with the transaction.

sourcestring

Source of the transaction.

entityTypestring

Type of the entity involved.

entityIdstring

Unique identifier for the entity.

entityobject

Actual entity information as JSON Object.

expireTsstring(date-time)

Expiration timestamp for the transaction.

createdTsstring(date-time)

Timestamp when the transaction was created.

updatedTsstring(date-time)

Timestamp when the transaction was last updated.

createdBystring

User or system that created the transaction.

updatedBystring

User or system that last updated the transaction.

identifiersarray[object]

Identifier model with key-value pair.

Show Child Parameters
get/bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}
 
application/json