Search
K
Policy Transactions

Eligibility Check Systematic Program Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

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

systematicProgramobjectrequired
Show Child Parameters

Response

application/json

Eligibility Check Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/systematicprograms/eligibilitycheck

Body

{ "effectiveDate": "effectiveDate", "systematicProgram": { "arrangementType": "PAYMENT" } }
 
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/bpm/v1/policies/{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/bpm/v1/policies/{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/bpm/v1/policies/{planCode}/{policyNumber}/loanrepaymentonetime/eligibilitycheck
 
application/json

Eligibility Check Freelook Cancellation Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

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

Freelook Cancellation Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/freelookcancellation/eligibilitycheck

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "disbursementType": "GROSS", "disbursementPaymentForm": "DTCC" }, "parties": [ { "partyId": "Party_PI_1", "paymentForm": "DTCC", "allocationPercentage": 100 } ] }
 
application/json