clientCodestringrequired
planCodestringrequired
transactionNamestringrequired
Allowed values:SystematicProgramSetupSystematicProgramUpdate
Get supported configurations for a transaction
get
Path Parameters
Response
application/json
Response
application/json
Success response
get/bpm/v1/policies/{clientCode}/{planCode}/{transactionName}/paymentforms
Authentication
Path Parameters
application/json
LoanRepaymentOneTimeRequest
objectcorrelationIdstring
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
Example
NewLoanRequest
objectcorrelationIdstring
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
Example
FullSurrenderRequest
objectcorrelationIdstring
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
overrideboolean
BPM will have to override the rules if this variable is marked as true
taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
transactionAmountsobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Example
PartialWithdrawalOneTimeRequest
objectcorrelationIdstring
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
Example