Search
K
Policy Transactions

Submit Systematic Program Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

SystematicProgramSubmitRequest

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

externalArrangementIdstring

Arrangement ID from external system

Example:B45678

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}/systematicprograms

Body

{ "effectiveDate": "effectiveDate", "systematicProgram": { "paymentForm": "DTCC", "arrangementType": "PAYMENT" } }
 
application/json

Eligibility Check Systematic Program Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

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/eligibilitycheck
 
application/json

Validate loan Repayment One Time Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

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

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/validation

Body

{}
 
application/json

Submit loan Repayment OneTime Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

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

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

Body

{}
 
application/json

EligibilityCheck Loan Repayment OneTime Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

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
 
application/json