IriTransferAmountType
stringHow the destination transfer amount is defined.
Allowed values:AMOUNTPERCENTAGEPRO_RATASPECIFIED_FUNDSALL_FUNDSOTHER
IriArrangementSource
stringLegacy DD abbreviation retained; represents arrangement source.
Allowed values:TransferAmtTransferPct
IriSystematicPartyRole
stringRole of the party within the systematic program. Uses PascalCase values to align with the PartyRole filter vocabulary.
Allowed values:PayorPayee
IriSystematicProgramParty
objectRole of the party within the systematic program. Uses PascalCase values to align with the PartyRole filter vocabulary.
Allowed values:PayorPayee
Tax identification number for the party.
Match pattern:^[0-9]{9}$
>= 9 characters<= 9 characters
Example:123456789
The party percentage for this program.
>= 0<= 100
Example:100
Bank account tied to the party.
<= 100 characters
Example:Bank_1
Address tied to the party. Required by the IRI schema when the payment method is CHECK.
<= 100 characters
Example:ADDR001
Party-level payment form for the systematic program.
Allowed values:DTCCACHCHECKWIREEXCHANGE
IriSystematicProgram
objectType of systematic arrangement.
Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT
How the program allocates against the policy funds.
Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY
Recurring systematic-program payment form. EFT is valid here; EXCHANGE is intentionally excluded because exchange handling is party-specific rather than a recurring disbursement mode.
Allowed values:DTCCEFTACHCHECKWIRE
How often the systematic program runs.
Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT
The date when the systematic program begins executing payments or transfers (entered by user).
Example:2025-01-01
The date the special program ends (entered by user or determined by LPS based on account value).
Example:2030-12-31
The last date on which a systematic transaction was processed.
Example:2025-07-01
A user-selected or modified next payment date, different from the scheduled one.
Example:2025-08-15
The date on which the next payment is scheduled.
Example:2025-08-01
How the scheduled amount is defined for the program.
Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYMODIFIEDEARNINGSONLY
Required when amountType is ‘AMOUNT’. Mutually exclusive with requestedPercentage.
>= 0<= 9999999999.99
Example:500
Required when amountType is ‘PERCENTAGE’. Mutually exclusive with requestedAmount.
>= 0<= 100
Example:10
Carrier-side identifier for the systematic program.
<= 100 characters
Example:arrangementid123
Number of modal occurrences for the program.
>= 0<= 9999999999
Example:12
Legacy DD abbreviation retained; represents modal amount.
>= 0<= 9999999999.99
Example:500
Legacy DD abbreviation retained; represents modal percentage.
>= 0<= 100
Example:10
How the destination transfer amount is defined.
Allowed values:AMOUNTPERCENTAGEPRO_RATASPECIFIED_FUNDSALL_FUNDSOTHER
How the destination transfer amount is defined.
Allowed values:AMOUNTPERCENTAGEPRO_RATASPECIFIED_FUNDSALL_FUNDSOTHER
Legacy DD abbreviation retained; represents arrangement source.
Allowed values:TransferAmtTransferPct
Tax withholding instructions associated with the systematic program.
Show Child Parameters
Legacy DD abbreviation retained; represents arrangement subtype.
Match pattern:^[A-Za-z0-9_ -]{1,100}$
<= 100 characters
Example:SYSTEMATICWITHDRAWAL
Day of month for the scheduled arrangement.
Match pattern:^(?:[1-9]|[12][0-9]|3[01])$
Example:15
Product code associated with the arrangement.
Match pattern:^[A-Za-z0-9._-]{1,50}$
Example:FIAPRM01
Parties associated with the systematic program.