planCodestringrequired
policyNumberstringrequired
Submit loan Repayment OneTime Transaction
post
Path Parameters
Body
application/json
Body
application/json
LoanRepaymentOneTimeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)
Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
payorobject
Show Child Parameters
caseIdstring
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}/loanrepaymentonetime
Authentication
Path Parameters
Body
{}
application/json
EligibilityCheck Loan Repayment OneTime Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
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}/loanrepaymentonetime/eligibilitycheck
Authentication
Path Parameters
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/policy/v1/transactions/{planCode}/{policyNumber}/reverserecreate
Authentication
Path Parameters
Body
{}
application/json
Eligibility Check For Initial Premium
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/initialpremium/eligibilitycheck
Authentication
Path Parameters
application/json
Validation Check For Initial Premium
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
InitialPremiumRequest
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
effectiveDatestring(date)
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
transactionReasonstring
Optional Reason for this transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICE
transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
exchangeobject
Show Child Parameters
taxBasisobject
Show Child Parameters
payorobject
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}/initialpremium/validation
Authentication
Path Parameters
Body
{}
application/json