Search
K
Policy Transactions

NewLoan Eligibility Check endpoint

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

New Loan Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/newloan/eligibilitycheck
 
application/json

Fullsurrender Validation Endpoint

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

NewLoanRequest

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

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]required
Show Child Parameters
partiesarray[object]required
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

Response

application/json

Partial Withdrawal Success Response.yaml

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "requestedAmount": 100, "amountType": "AMOUNT", "disbursementType": "GROSS", "disbursementPaymentForm": "DTCC", "loanType": "PREFERRED", "loanInterestType": "FIXED" }, "fundAllocation": { "allocationOption": "PRORATA" }, "taxWithholdingInstructions": [ { "partyId": "Party_PI_1", "taxWithholdingType": "FEDERAL", "taxRateToUse": "NOWITHHOLDINGELECTED" } ], "parties": [ { "partyId": "Party_PI_1", "paymentForm": "DTCC", "allocationPercentage": 100 } ] }
 
application/json

Submit New Loan Request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

NewLoanRequest

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

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]required
Show Child Parameters
partiesarray[object]required
Show Child Parameters
caseIdstring

Zinnia Live Case ID

Example:CA0000007389

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

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "requestedAmount": 100, "amountType": "AMOUNT", "disbursementType": "GROSS", "disbursementPaymentForm": "DTCC", "loanType": "PREFERRED", "loanInterestType": "FIXED" }, "fundAllocation": { "allocationOption": "PRORATA" }, "taxWithholdingInstructions": [ { "partyId": "Party_PI_1", "taxWithholdingType": "FEDERAL", "taxRateToUse": "NOWITHHOLDINGELECTED" } ], "parties": [ { "partyId": "Party_PI_1", "paymentForm": "DTCC", "allocationPercentage": 100 } ] }
 
application/json

Validate 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

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

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

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