API Documentation > Contract API > Compensatie

Interest rate compensation proposal

Introduction

In the interest rate compensation proposal process customers are being compensated if they have paid too much interest on their contracts in the past.

Flow

  1. In batches information about available compensation proposals are read into the Alfam Backoffice system (Centrac). This information is provided by the Wally Datawarehouse (WDWH)

  2. The information read into Centrac is delivered to the Alfam Frontoffice (Consumer Credit API's) and notifications are send about each individual compensation.

  3. The compensation proposal can be retrieved from the Frontoffice using the Contract API and can be proposed to the customer.

  4. The customer can decide to agree to the proposal and sign it. This decision can be send to the Contract API to inform Alfam.

  5. The information on the customer decision is delivered to Centrac, where the process for the compensation is started.

  6. Once the payment for the compensation is started the information in the Frontoffice will be updated and a notifcation is send containing this information.

Retrieving the compensation proposal information

In order to retrieve the compensation proposal information the Get compensation proposal operation from ContractAPI needs to be used. A bearer token and a subscription key are required to authenticate.

Posting the customers decision

In order to post the customers decision the Accept/Reject compensatie voorstel operation from ContractAPI needs to be used. A bearer token and a subscription key are required to authenticate.

Notifications

The CompensatieBeschikbaarInCache notification is send whenever a new compensation proposal has become available in the Frontoffice.

{
    "ReferentieId":"695013200",
    "GebeurtenisType":"CompensatieBeschikbaarInCache",
    "Datum":"2021-09-23 10:50:30.050"
}

The CompensatieUitbetalingOntvangen notification is send whenever the Frontoffice has been notified that the payment of the compensation has been started.

{
    "ReferentieId":"695013200",
    "GebeurtenisType":"CompensatieUitbetalingOntvangen",
    "Datum":"2021-09-23 10:50:30.050"
}

For both notification bodies the ReferentieId field represents the contractnummer of the contract flagged for compensation. The Datum field represents the date and time on which the event occured and GebeurtenisType represents the type of event that occured.