planCodestringrequired
policyNumberstringrequired
Policy Number
Validation OneTime Premium Transaction
post
Path Parameters
Body
application/json
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
payor
Any Ofrequired
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
Response
application/json
OneTime Premium Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/onetimepremium/validation
Authentication
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"transactionAmounts": {
"requestedAmount": 0
},
"payor": {
"bankId": "bankId"
}
}
application/json
Submit OneTime Premium Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
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
payor
Any Ofrequired
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
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
Authentication
Path Parameters
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
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
Authentication
Path Parameters
application/json
Eligibility Check Reinstatement Request
Draft Specifications (Subject to Change Upon Review)
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
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
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement/eligibilitycheck
Authentication
Path Parameters
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
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
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
Authentication
Path Parameters
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