Search
K
Policy

AmountType

string

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

Party

object
partyRolestring

Note -Use systematicProgram.parties.partyRole field instead of systematicProgram.party.partyRole

Allowed values:PAYORPAYEE

Example:PAYOR

partyIdstring

Note -Use systematicProgram.parties.partyId field instead of systematicProgram.party.partyId

Example:Party_PI_1

percentagenumber(double)

Note -Use systematicProgram.parties.percentage field instead of systematicProgram.party.percentage

Example:10

bankIdstring

Note -Use systematicProgram.parties.bankId field instead of systematicProgram.party.bankId

Example:Bank_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

Example

SystematicProgramParties

object
partyRolestring

Role the program is tied to ( for example for money-in ,I could be owner or payor & for money-out it could be payee or beneficiary)

Allowed values:PAYORPAYEE

Example:PAYOR

partyIdstring

Role ID of the party

Example:Party_PI_1

percentagenumber(double)

The party percentage for this program

Example:10

bankIdstring

Bank Account Tied to the Party

Example:Bank_1

addressIdstring

Address Tied to the Party ID. In case of payment method Check , this field is required

Example:1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

forBenefitOfOrForFurtherCreditstring

FBO - For Benefit Of FFC - For Further Credit(to notate a second beneficiary or to designate a person or organization when funds are disbursed out)

Example:TBD

Example

SystematicProgram

object
arrangementTypestring

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

arrangementIdstring

The unique payment number for payments by the party

Example:Arr_1

allocationOptionTypestring

Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY

reasonstring

Allowed values:PREMIUMLOANREPAYMENTFREEWITHDRAWALAMOUNTWITHDRAWALANNUITYPAYOUTREQUIREDMINIMUMDISTRIBUTION

numberOfOccurrencenumber(int32)

Specifies how many times the SSW special program will run. This number will decrease each time the SSW runs. If there is no specific duration, this field will remain at 0 and will not automatically end the SSW special program

Example:12

disbursementTypestring

Allowed values:GROSSNETNETNET

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

frequencystring

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

requestedDatestring(date)

The date on which the request for the systematic program was submitted

Example:2023-01-01

startDatestring(date)

The date when the systematic program begins executing payments or transfers (entered by user)

Example:2023-01-01

endDatestring(date)

The date Special Program ends (Entered by user or determined by LPS based on Account Value)

Example:2023-01-01

previousProgramDatestring(date)

The last date on which a systematic transaction was processed

Example:2023-01-01

optedNextProgramDatestring(date)

A user-selected or modified next payment date, different from the scheduled one

Example:2023-01-01

nextProgramDatestring(date)

The date on which the next payment is scheduled

Example:2023-01-01

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

amountnumber(double)

A specified value - predetermined fixed amount or percentage used for financial transactions within a systematic program

Example:600

partyarray[object]

Note -Use systematicProgram.parties field instead of systematicProgram.party

Show Child Parameters
partiesarray[object]
Show Child Parameters
externalArrangementIdstringrequired

The unique ID sent by carriers to identify the special programs.Carrier-side identifier for the systematic program

Example:arrangementid123

Example

FeatureType

string

Allowed values:FREELOOKLAPSEASSESSMENTLAPSEPROTECTIONREINSTATEMENTRATELOCKANNUITIZATIONNONFORFEITUREOPTIONCONVERSIONDISCOUNTBILLINGCUSTOMFEATURE