Productsettings

Defines the profit computation settings for a deposit product

accruedProfitAmountCalculationMethodstringrequired

Accrued profit amount calculation method

Possible values: [CUSTOMER_PROFIT_RATE_AFTER_ADJUSTMENT, CUSTOMER_PROFIT_RATE, CUSTOMER_PROFIT_RATE_WITH_CAPPED_RATE]

balanceEligibility object

Criteria for eligibility of account balances

minimumEligiblenumber

The minimum eligible balance to be included in the profit computation flow

typestring

The balance eligibility type

Possible values: [END_OF_THE_DAY_BALANCE, AVERAGE_BALANCE, MINIMUM_BALANCE]

creationDatestring<date-time>

The creation time of the product settings

Example: 2016-09-06T13:37:50+03:00

dayOfMonthinteger<int32>

Day of month

effectiveDatestring<date>required

The effective date of the product settings

Example: 1987-04-26

idinteger<int64>

The identifier of the product settings

lastModifiedDatestring<date-time>

The last modified time of the product settings

Example: 2016-09-06T13:37:50+03:00

poolIdinteger<int64>

The identifier of the associated pool from which a product will inherit parameters

productEncodedKeystringrequired

The encoded key of the linked deposit product

productPaymentPointstringrequired

Product payment point

Possible values: [MONTHLY, EVERY_CALENDAR_MONTH, ON_FIXED_DATES, ON_ACCOUNT_MATURITY]

profit object

Profit calculation configuration for accrual

cappedRatePercentagenumber

Upper threshold limit on the calculated customer profit rate

fixedRatePercentagenumber

A fixed percentage used to calculate the final profit amount

fixedRateRulestring

The type of fixed rate

Possible values: [ALWAYS_USE_FIXED_RATE, TREAT_AS_MIN, USE_CALCULATED_RATE]

tiers object[]

List of customer share tiers associated with product settings

Array [

creationDatestring<date-time>

The creation time of the customer share tier

Example: 2016-09-06T13:37:50+03:00

fromValuenumber

The starting value for the customer share tier

idinteger<int64>

The identifier of the customer share tier

lastModifiedDatestring<date-time>

The last modified time of the customer share tier

Example: 2016-09-06T13:37:50+03:00

percentagenumber

The percentage of the customer share tier

productSettingsIdinteger<int64>

The identifier of the associated product settings

]

profitAccrualPointstringrequired

Profit accrual point

Possible values: [NEXT_ACCRUAL_DATE, CURRENT_ACCRUAL_DATE]

profitApplicationPointstringrequired

Profit application point

Possible values: [PAYMENT_CYCLE_END_DATE, NEXT_DAY_AFTER_PAYMENT_CYCLE_END_DATE]

withholdingTaxSourceKeystring

The key reference for the withholding tax source associated with the IPS product settings

Productsettings

{
  "accruedProfitAmountCalculationMethod": "CUSTOMER_PROFIT_RATE_AFTER_ADJUSTMENT",
  "balanceEligibility": {
    "minimumEligible": 0,
    "type": "END_OF_THE_DAY_BALANCE"
  },
  "creationDate": "2016-09-06T13:37:50+03:00",
  "dayOfMonth": 0,
  "effectiveDate": "1987-04-26",
  "id": 0,
  "lastModifiedDate": "2016-09-06T13:37:50+03:00",
  "poolId": 0,
  "productEncodedKey": "string",
  "productPaymentPoint": "MONTHLY",
  "profit": {
    "cappedRatePercentage": 0,
    "fixedRatePercentage": 0,
    "fixedRateRule": "ALWAYS_USE_FIXED_RATE",
    "tiers": [
      {
        "creationDate": "2016-09-06T13:37:50+03:00",
        "fromValue": 0,
        "id": 0,
        "lastModifiedDate": "2016-09-06T13:37:50+03:00",
        "percentage": 0,
        "productSettingsId": 0
      }
    ]
  },
  "profitAccrualPoint": "NEXT_ACCRUAL_DATE",
  "profitApplicationPoint": "PAYMENT_CYCLE_END_DATE",
  "withholdingTaxSourceKey": "string"
}