planCodestringrequired
policyNumberstringrequired
Eligibility Check For Fund Transfer
post
Path Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/fundtransfer/eligibilitycheck
Path Parameters
application/json
Validation Check For Fund Transfer
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
FundTransferRequest
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
fundsobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/fundtransfer/validation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"amountType": "AMOUNT"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"funds": {
"transferFrom": [
{
"fundId": "fundId",
"requestedAmount": 124.124213
}
],
"transferTo": [
{
"fundId": "fundId",
"requestedAmount": 124.124213
}
]
}
}
application/json
Fund Transfer Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
FundTransferRequest
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
fundsobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/fundtransfer
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"amountType": "AMOUNT"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"funds": {
"transferFrom": [
{
"fundId": "fundId",
"requestedAmount": 124.124213
}
],
"transferTo": [
{
"fundId": "fundId",
"requestedAmount": 124.124213
}
]
}
}
application/json
Eligibility Check Email Address Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Response
application/json
Response
application/json
Email Address Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/emailaddress/eligibilitycheck
Path Parameters
application/json
Add new Email Address based on request
Validates email address change requests for policy parties including ADD, UPDATE, and DELETE operations
post
Query Parameters
operationstringrequired
validate business rule for provided operation
Allowed values:ADDUPDATEDELETE
Example:ADD
bankIdstring
bank id
Example:1
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Body
application/json
Body
application/json
EmailChangeRequest
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})
emailobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA00000022023
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
Response
application/json
Request accepted successfully and is being processed.
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}/emailaddress/{partyId}/validation
Path Parameters
Query Parameters
Body
{
"effectiveDate": "effectiveDate",
"email": {
"startDate": "startDate",
"emailType": "PERSONAL",
"emailAddress": "will.smith@gmail.com"
}
}
application/json