Search
K
Policy Transactions

Eligibility Check For Fund Transfer

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

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

Validation Check For Fund Transfer

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

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

Success

TransactionResponse

statusstring

Allowed values:successfailure

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

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

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

Success

TransactionResponse

statusstring

Allowed values:successfailure

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

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "amountType": "AMOUNT" }, "fundAllocation": { "allocationOption": "PRORATA" }, "funds": { "transferFrom": [ { "fundId": "fundId", "requestedAmount": 124.124213 } ], "transferTo": [ { "fundId": "fundId", "requestedAmount": 124.124213 } ] } }
 
application/json

Non Financial Transactions

Non Financial Transactions

Eligibility Check For Non-Financial Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

transactionTypestringrequired

Transaction Type

Allowed values:addressemailaddressphonebankaccountcommunicationpreference

Response

application/json

Non Financial Eligibility Success Response

TransactionResponse

statusstring

Allowed values:successfailure

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