planCodestringrequired
policyNumberstringrequired
Cancel Transaction
post
Path Parameters
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
post/bpm/v1/policies/{planCode}/{policyNumber}/canceltransaction
Path Parameters
Body
{
"transactionId": "377",
"reason": "Entered Incorrect Email Id"
}
application/json
Eligibility Check Freelook Cancellation Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
FreeLookCancellationRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Freelook Cancellation Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/freelookcancellation/eligibilitycheck
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Validation Freelook Cancellation Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
FreeLookCancellationRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Freelook Cancellation Validation Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/freelookcancellation/validation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Freelook cancellation request
If freelook endDate is less than or equal to policy effective Date, cancel the policy based on the request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
FreeLookCancellationRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Success
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/bpm/v1/policies/{planCode}/{policyNumber}/freelookcancellation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"disbursementType": "GROSS",
"disbursementPaymentForm": "DTCC"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Request to reverse and recreate
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
ReverseRecreateRequest
correlationIdstring
The unique ID to track transaction request across all Systems
Example:657b717b7dcf554abf9ef067
correctionsarray[object]
Show Child Parameters
noRecreateTransactionsboolean
To recreate trnsaction again or not
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Success
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/bpm/v1/policies/{planCode}/{policyNumber}/reverserecreate
Path Parameters
Body
{}
application/json