planCodestringrequired
The plan code for the policy
Example:planCode
policyNumberstringrequired
The policy number
Example:policyNumber
Submit reinstatement transaction request
Submits a policy reinstatement transaction request
post
Path Parameters
Body
application/json
Body
application/json
ReinstatementSubmitRequest
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
Policy information
Show Child Parameters
transactionAmountsobjectrequired
Transaction amounts information
Show Child Parameters
systematicProgramobjectrequired
Systematic program information
Show Child Parameters
caseIdstringrequired
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/policy/v1/transactions/{planCode}/{policyNumber}/reinstatement
Path Parameters
Body
{
"correlationId": "657b717b7dcf554abf9ef067",
"effectiveDate": "2023-01-01",
"policy": {
"policyFeatures": [
{}
]
},
"transactionAmounts": {},
"systematicProgram": {},
"caseId": "CA0000007389"
}
application/json
Validate Systematic Program Update Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
arrangementIdstringrequired
arrangementId is the unique id for the systematic programs available in the policy
Example:Arr_1
Body
application/json
Body
application/json
SystematicProgramUpdateRequest
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
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/{arrangementId}/validation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"systematicProgram": {
"paymentForm": "DTCC",
"arrangementType": "PAYMENT"
}
}
application/json
Submit Systematic Program Update Transaction
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
arrangementIdstringrequired
arrangementId is the unique id for the systematic programs available in the policy
Example:Arr_1
Body
application/json
Body
application/json
SystematicProgramUpdateRequest
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
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
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
put/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"systematicProgram": {
"paymentForm": "DTCC",
"arrangementType": "PAYMENT"
}
}
application/json
EligibilityCheck Systematic Program Update Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
arrangementIdstringrequired
arrangementId is the unique id for the systematic programs available in the policy
Example:Arr_1
Response
application/json
Response
application/json
Eligibility Check Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms/{arrangementId}/eligibilitycheck
Path Parameters
application/json
Eligibility Check Email Address Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Response
application/json
Response
application/json
Email Address Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/emailaddress/eligibilitycheck
Path Parameters
application/json