Search
K
Policy

IriDisbursementType

string

Type of amount for withdrawal such as Gross or Net.

Allowed values:GROSSNET

IriDisbursementPaymentForm

string

Transaction disbursement payment form. Uses the recurring disbursement vocabulary with EFT; EXCHANGE is intentionally excluded because it applies only to party-level exchange servicing.

Allowed values:DTCCEFTACHCHECKWIRE

IriTransactionAmounts

object
requestedAmountnumber

Required when amountType is AMOUNT. Must not be provided for PERCENTAGE, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or EARNINGSONLY.

>= 0<= 9999999999.99

Example:137547.78

requestedPercentagenumber

Required when amountType is PERCENTAGE. Must not be provided for AMOUNT, MAX, FREEWITHDRAWALAMOUNT, WITHDRAWALUNTILBASIS, or EARNINGSONLY.

>= 0<= 100

Example:10

amountTypestring

Indicates how the scheduled amount is defined for the systematic program, such as a fixed amount, percentage, maximum available amount, free withdrawal amount, withdrawal until basis, earnings only, pro rata amount, or modified earnings only.

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLY

disbursementTypestring

Type of amount for withdrawal such as Gross or Net.

Allowed values:GROSSNET

disbursementPaymentFormstring

Transaction disbursement payment form. Uses the recurring disbursement vocabulary with EFT; EXCHANGE is intentionally excluded because it applies only to party-level exchange servicing.

Allowed values:DTCCEFTACHCHECKWIRE

Example

IriTransactionChargeType

string

Type of charge applied to the transaction.

Allowed values:SERVICE_CHARGERIDER_CHARGEADMINISTRATIVE_CHARGESURRENDER_CHARGEMVATAXCOST_OF_INSURANCEEXPENSE_CHARGEUNIT_EXPENSE_CHARGEWITHDRAWAL_CHARGEOTHER

IriTransactionCharge

object
chargeTypestring

Type of charge applied to the transaction.

Allowed values:SERVICE_CHARGERIDER_CHARGEADMINISTRATIVE_CHARGESURRENDER_CHARGEMVATAXCOST_OF_INSURANCEEXPENSE_CHARGEUNIT_EXPENSE_CHARGEWITHDRAWAL_CHARGEOTHER

isChargeWaivedboolean

Whether the charge was waived.

chargeWaiverReasonstring

Reason the charge was waived.

Example:WITHIN_FREE_WITHDRAWAL

chargeAmountnumber

Charge amount applied for this transaction.

>= 0<= 9999999999.99

Example:374.75

chargeAppliedRatenumber

Rate (%) used to calculate the charge.

>= 0<= 9999999999.99

Example:0.27

Example