Event Name
calculateInterestRate.interestRateCalculated
Domain
enterprise
Description

Event is triggered to communicate information on interest rate associated with a contract.

Properties
{
    "baseContractDetails": {
        "type": "array",
        "description": "Indicates the identifier for base details in which system reference, base contract reference, event name, effective date and other contract related details are defined for a contract from enterprise product pricing system",
        "items": {
            "id": "urn:jsonschema:BaseContractDetails",
            "properties": {
                "contractReference": {
                    "type": "string",
                    "description": "Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract/account in the system."
                },
                "systemReference": {
                    "type": "string",
                    "description": "Contains the identifier for the system in which the event originated from. For ex, ‘Hogan’ or ‘TransactAccounts’ etc"
                },
                "companyReference": {
                    "type": "string",
                    "description": "Contains the identifier of the underlying Entity or Company or Branch"
                },
                "eventName": {
                    "type": "string",
                    "description": "Indicates the name of the event that is understood by the Enterprise product pricing system."
                },
                "baseEventIdentifier": {
                    "type": "string",
                    "description": "Indicates the name of the event that is happening in the core system"
                },
                "effectiveDate": {
                    "type": "string",
                    "description": "Contains the identifier for the transaction date. Dates are expected in ‘YYYYMMDD’ format"
                },
                "bookingDate": {
                    "type": "string",
                    "description": "Indicates the date on which this business activity is booked in the underlying system. The effective date and booking date could be different if systems allow forward/backdating business transactions. Dates are expected in YYYYMMDD format. If Booking date is not passed, effective date would be assumed as booking date."
                },
                "contractCurrency": {
                    "type": "string",
                    "description": "Indicates the currency associated with the contract"
                },
                "channel": {
                    "type": "string",
                    "description": "Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"
                },
                "branch": {
                    "type": "string",
                    "description": "Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"
                },
                "lineOfBusiness": {
                    "type": "string",
                    "description": "Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"
                },
                "transactionReference": {
                    "type": "string",
                    "description": "Contains the identifier for the transaction in the core system"
                },
                "reversalIndicator": {
                    "type": "boolean",
                    "description": "Indicates whether the underlying transaction is reversed so that the details of the same could be removed from Enterprise product pricing system"
                },
                "variation": {
                    "type": "array",
                    "description": "Additional product specification based on particular criteria for example the account was opened on-line and attracted a higher interest rate. Drop down list to select appropriate variation or applied automatically",
                    "items": {
                        "type": "string"
                    }
                },
                "party": {
                    "type": "array",
                    "description": "Identifier of individuals in terms of Customers or Person or Entities with reference to the bank",
                    "items": {
                        "id": "urn:jsonschema:PartyDetails",
                        "properties": {
                            "party": {
                                "type": "string",
                                "description": "Identifier of individuals in terms of Customers or Person or Entities with reference to the bank"
                            },
                            "partyRole": {
                                "type": "string",
                                "description": "Contains the identifier used for the role played by the party or customer in the contract or account"
                            }
                        }
                    }
                },
                "eligibility": {
                    "type": "array",
                    "description": "Contains the details of rules associated with the customer, rule results, action and variation.",
                    "items": {
                        "id": "urn:jsonschema:Eligibility",
                        "properties": {
                            "variation": {
                                "type": "string",
                                "description": "Additional product specification based on particular criteria for example the account was opened on-line and attracted a higher interest rate. Drop down list to select appropriate variation or applied automatically"
                            },
                            "actionContext": {
                                "type": "string",
                                "description": "It indicates the action to be performed based on the eligibility evaluation result."
                            },
                            "failureType": {
                                "type": "string",
                                "description": "The failure type for an eligibility rule can be either one of two values, error or override/warning."
                            },
                            "eligibilityRule": {
                                "type": "array",
                                "description": "Contains the eligibility rule details such as party role rule, party role rule expression and evaluation result.",
                                "items": {
                                    "id": "urn:jsonschema:EligibilityRule",
                                    "properties": {
                                        "ruleName": {
                                            "type": "string",
                                            "description": "Name of the validation rule to be checked against an online or periodic activity."
                                        },
                                        "customerRole": {
                                            "type": "string",
                                            "description": "Indicates role of a customer for an arrangement."
                                        },
                                        "roleRuleName": {
                                            "type": "string",
                                            "description": "It indicates the rule to be evaluated based on the customer role."
                                        },
                                        "failureAction": {
                                            "type": "string",
                                            "description": "During the close of business dependent on value set and change in customer static data, an action will occur. Standard set of values are change product, close or ignore."
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "rateProcessDetails": {
        "type": "array",
        "description": "Indicates the identifier for rate details in which rate name,rate description, original rate,adjusted rate, final rate, rate type, tier type , rate definition are defined for a contract in enterprise product pricing system",
        "items": {
            "id": "urn:jsonschema:RateProcessDetails",
            "properties": {
                "rateName": {
                    "type": "string",
                    "description": "Contains the identifier for the underlying interest rate component(s). Eg: Credit interest, Debit Interest, Penalty Interest etc"
                },
                "rateDescription": {
                    "type": "string",
                    "description": "Indicates the description of the rate name"
                },
                "originalRate": {
                    "type": "string",
                    "description": "Indicates the original rate or base rate before pricing evaluation. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "finalRate": {
                    "type": "string",
                    "description": "Indicates the final rate after pricing evaluation. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "rateAdjusted": {
                    "type": "string",
                    "description": "Indicates the adjusted rate which is calculated during pricing evaluation. Pricing Evaluation means fee or interest amount calculated based on the predefined rules applied for the contract. It will add or subtract the adjusted amount to the original fee or interest amount based on the predefined pricing operand and the rule value"
                },
                "rateType": {
                    "type": "string",
                    "description": "Indicates whether a debit or credit type of interest passed. Allowed values are DEBIT or CREDIT"
                },
                "rateDefinition": {
                    "type": "string",
                    "description": "Indicates the rate calculation method. For exmaple, Fixed, Floating or Periodic"
                },
                "tierType": {
                    "type": "string",
                    "description": "Type of the tier rate. Allowed values: - BAND: rates apply within each band - LEVEL: a common rate applies, determined by the highest level"
                },
                "tierDetails": {
                    "type": "array",
                    "description": "Indicates the identifier for the tier details in which tier rate, tier value and other details are defined.",
                    "items": {
                        "id": "urn:jsonschema:TierDetails",
                        "properties": {
                            "tierFinalRate": {
                                "type": "string",
                                "description": "Contains the final tier rate inclusive of all the pricing benefits. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts."
                            },
                            "tierValue": {
                                "type": "string",
                                "description": "Contains the threshold amount or percentage of the tier for the interest rates. Each tier is specified by defining the amount up to which the interest rate applies. There are three type of tiers such as Single, Level, and Banded."
                            }
                        }
                    }
                },
                "benefitDetails": {
                    "type": "array",
                    "description": "Indicates the identifier for pricing benefit details in which benefit program, benefit amount and benefit type are defined. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts",
                    "items": {
                        "id": "urn:jsonschema:BenefitDetails",
                        "properties": {
                            "benefitProgram": {
                                "type": "string",
                                "description": "Indicates the pricing program under which benefit was offered. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts"
                            },
                            "benefitType": {
                                "type": "string",
                                "description": "Indicates the nature of benefit. It can be adjust, override or waive"
                            },
                            "benefitAmount": {
                                "type": "string",
                                "description": "Indicates the quantum of benefit for the benefit type. Pricing benefit defines the benefits which applied for the calculated fee or interest amount which can be waived, adjusted or overrides their original amounts"
                            }
                        }
                    }
                }
            }
        }
    }
}