Search
K
Policy Transactions

FeatureTransactionProduct

object

Product-level transaction classification accompanying the systematic program request

transactionTypestring

Example:ONETIMEWITHDRAWAL

transactionSubtypestring

Example:SPECIFIEDAMOUNT

Example

SystematicProgramUpdate

object
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
Example

SystematicProgramQuote

object
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

arrangementIdstring

The unique ID for the systematic programs available in the policy

Example:arr_1

systematicProgramobjectrequired
Show Child Parameters
Example

AdhocSystematicProgram

object
paymentFormstringrequired

Mode of payment

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT

arrangementTypestringrequired

The type of payment such as fixed or flexible

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

amountTypestring

Amount Type selected by user. Following is dropdown list 1. Amount – If selected user should be able to enter Amount for Transaction Amount field 2. Percent – If selected user should be able to enter Percentage for Transaction Amount field 3. Max – If selected user should NOT be able to enter Amount. Auto calculated using Maximum Withdrawal Amount. 4. Free Withdrawal Amount – If selected user should NOT be able to enter Amount. Auto calcualted using Free Withdrawal Amount. 5. Withdraw Until Basis ---- If selected user should NOT be able to enter Amount. Auto calcualted using Cost Basis.

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATA

amountnumber(double)

Requested amount value

Example:5

frequencystring

frequency

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALBIANNUALQUARTERLYANNUALSINGLEPAYMENTDEFAULT

startDatestring(date)

Date (with pattern “yyyy-mm-dd”)

endDatestring(date)

Date (with pattern “yyyy-mm-dd”)

previousProgramDatestring(date)

Date (with pattern “yyyy-mm-dd”)

nextProgramDatestring(date)

Date (with pattern “yyyy-mm-dd”)

disbursementTypestring

The type of amount for withdrawal such as Gross or Net

Allowed values:GROSSNETNETNET

partyobject
Show Child Parameters
partiesarray[object]
Show Child Parameters
Example

ReinstatementSystematicProgram

object
externalIdentifiersobject
Show Child Parameters
paymentFormstringrequired

Mode of payment

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT

arrangementTypestringrequired

The type of payment such as fixed or flexible

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

amountTypestringrequired

Amount Type selected by user. Following is dropdown list 1. Amount – If selected user should be able to enter Amount for Transaction Amount field 2. Percent – If selected user should be able to enter Percentage for Transaction Amount field 3. Max – If selected user should NOT be able to enter Amount. Auto calculated using Maximum Withdrawal Amount. 4. Free Withdrawal Amount – If selected user should NOT be able to enter Amount. Auto calcualted using Free Withdrawal Amount. 5. Withdraw Until Basis ---- If selected user should NOT be able to enter Amount. Auto calcualted using Cost Basis.

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATA

amountnumber(double)

Requested amount value

Example:5

frequencystringrequired

frequency

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALBIANNUALQUARTERLYANNUALSINGLEPAYMENTDEFAULT

startDatestring(date)

Date (with pattern “yyyy-mm-dd”)

endDatestring(date)

Date (with pattern “yyyy-mm-dd”)

previousProgramDatestring(date)

Date (with pattern “yyyy-mm-dd”)

nextProgramDatestring(date)

Date (with pattern “yyyy-mm-dd”)

partiesarray[object]
Show Child Parameters
Example