Skip to main content

Product settings

Defines the profit computation settings for a deposit product

balanceEligibility object

The balance eligibility conditions of the product settings

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]

creationDatedate-time

The creation time of the product settings

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

The effective date of the product settings

Example: 1987-04-26
idint64

The identifier of the product settings

lastModifiedDatedate-time

The last modified time of the product settings

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

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]

profit object

The customer profit configuration parameters

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 [
    • creationDatedate-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

    idint64

    The identifier of the customer share tier

    lastModifiedDatedate-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

    productSettingsIdint64

    The identifier of the associated product settings

  • ]
    • profitApplicationPointstringrequired

    Profit application point

    Possible values: [PAYMENT_CYCLE_END_DATE, NEXT_DAY_AFTER_PAYMENT_CYCLE_END_DATE]

    withholdingTaxEnabledboolean

    Indicates whether withholding tax is enabled for the IPS product

    withholdingTaxSourceKeystring

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

    Product settings
    {
      "balanceEligibility": {
        "minimumEligible": 0,
        "type": "END_OF_THE_DAY_BALANCE"
      },
      "creationDate": "2016-09-06T13:37:50+03:00",
      "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
          }
        ]
      },
      "profitApplicationPoint": "PAYMENT_CYCLE_END_DATE",
      "withholdingTaxEnabled": true,
      "withholdingTaxSourceKey": "string"
    }