planCodestringrequired
policyNumberstringrequired
Submit Systematic Program Transaction
post
Path Parameters
Body
application/json
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
authorizationManualboolean
Indicates manual authorization handling may apply for this submission
contactMFAobject
Contact channels for multi-factor authentication on systematic program transactions
Show Child Parameters
agentobject
Named participant (e.g. servicing agent or policy holder context on the request)
Show Child Parameters
policyHolderobject
Named participant (e.g. servicing agent or policy holder context on the request)
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundAllocationobject
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
featureTransactionProductobject
Product-level transaction classification accompanying the systematic program request
Show Child Parameters
submittedDatestring(date-time)
When the transaction was submitted (ISO-8601)
Example:2026-02-27T11:55:17Z
currencystring
ISO 4217 currency code
Example:USD
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
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
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/systematicprograms
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"systematicProgram": {
"paymentForm": "DTCC",
"arrangementType": "PAYMENT"
}
}
application/json
Eligibility Check Systematic Program Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
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/eligibilitycheck
Authentication
Path Parameters
application/json
Validate loan Repayment One Time Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
LoanRepaymentOneTimeRequest
correlationIdstring
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
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime/validation
Authentication
Path Parameters
Body
{}
application/json
Submit loan Repayment OneTime Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
LoanRepaymentOneTimeRequest
correlationIdstring
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
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
pdfIdstring
Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.
Example:DOC-10004567
post/policy/v1/transactions/{planCode}/{policyNumber}/loanrepaymentonetime
Authentication
Path Parameters
Body
{}
application/json
EligibilityCheck Loan Repayment OneTime Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
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}/loanrepaymentonetime/eligibilitycheck
Authentication
Path Parameters
application/json