planCodestringrequired
policyNumberstringrequired
arrangementIdstringrequired
arrangementId is the unique id for the systematic programs available in the policy
Example:Arr_1
Validate Systematic Program Update Transaction
post
Path Parameters
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
Authentication
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}
Authentication
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
Authentication
Path Parameters
application/json
Eligibility Check Partial Withdrawal One Time
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
PartialWithdrawalOneTimeRequest
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
overrideboolean
BPM will have to override the rules if this variable is marked as true
Response
application/json
Response
application/json
Parital Withdrawal Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/partialwithdrawalonetime/eligibilitycheck
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"requestedAmount": 0,
"amountType": "AMOUNT",
"disbursementType": "GROSS"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Eligibility Check Partial Withdrawal One Time
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
PartialWithdrawalOneTimeRequest
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
overrideboolean
BPM will have to override the rules if this variable is marked as true
Response
application/json
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}/partialwithdrawalonetime/validation
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"requestedAmount": 0,
"amountType": "AMOUNT",
"disbursementType": "GROSS"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json