Settlement API

Introduction

This document describes the ClaimShop Settlement Data API. This API can be used to get settlement data (of specific revision) from Scalepoint ClaimShop solution.

Main consumer of this API is insurance company.

Overview

The process of obtaining settlement data can be divided into two steps:

• Authentication
• Get settlement data

Authentication

You need an access_token in order to send data to the Settlement Data Endpoint. This access token can be obtained from the Authentication Endpoint. Please refer to the documentation about details of authentication process.

API caller should request platform-case:read scope from Authentication Endpoint.

Endpoints

Settlement Data API main endpoint

The endpoint which allows to obtain any settlement revision by its token is in the following format:`

```https://www.scalepoint.com/webapp/ScalePoint/%country%/case/%tenant%/revision/%revisionToken>%``

Here %revisionToken% is a settlement revision token which uniquely identifies settlement revision of the ClaimShop case.

The actual format of this will depend on the insurance company, the country in which it operates and the version of the API.

Assuming the following:

• Country: Denmark
• Tenant: ABC Insurance

The endpoint could look something like this:

https://www.scalepoint.com/webapp/ScalePoint/dk/case/abcinsurance/revision/d1a72df4-f7d5-402c-a495-cc31b8b39a59

For testing purposes, you will be given access to a Sandbox server and the hostname-part of the endpoint would change accordingly:

https://sandbox.scalepoint.com/webapp/ScalePoint/dk/case/abcinsurance/revision/d1a72df4-f7d5-402c-a495-cc31b8b39a59

Settlement Data

Get Settlement Data Request

Settlement data GET request contains request parameters as a part of endpoint URL (see above) and authorization and accept headers.

Authorization header has name 'Authorization'. It has value built from access_token in following format:

Bearer access_token

Note the important space character between Bearer and access_token value.

Accept header contains API version (v3 in the example below)

Accept: application/vnd.scalepoint.content.settlement.v3+json

Request example

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Accept: application/vnd.scalepoint.content.settlement.v3+json

Get Settlement Data Response

Settlement data GET response contains settlement fields in JSON format in case of success (HTTP status code 200). Fields are described in Appendix A.

Simplest successful response example:

{
   "case":{
      "token":"CA1214A9-0A45-4A13-82D7-9A6F19C88E6E",
      "number":"855235641",
      "policyNumber":"8235403022"
   },
   "settlementDetails":{
      "policyDeductible":0.00,
      "appliedDeductible":0.00,
      "depreciation":740.50,
      "revisionToken":"CCA0877E-31E3-42E8-AD81-6075E62423E7",
      "status":"SETTLED",
      "approvedBy":"shd",
      "timestamp":"2018-01-12T16:44:12.620+0200",
      "settlementType":"SETTLED_FOR_REPLACEMENT",
      "repairAmount":0.00,
      "subTotalAmount":740.50,
      "cashCompensation":740.50,
      "overallManualReduction":0.00,
      "appliedManualReduction":0.00,
      "items":[
         {
            "category":"Telefoni",
            "subCategory":"Mobiltelefoner",
            "subCategoryToken": "64B5E7A9-F1EE-4F3B-916A-44D278022DB2",
            "description":"Samsung Galaxy J3 (2017) J330F Black, 5.0 , PLS, 720 x 1280 pixels, Exynos 7570, Internal RAM 2 GB, 16 GB, microSD, Dual SIM, Nano-SIM, 3G, 4G, Main camera 13 MP, Second camera 5 MP, Android, 7.0, 2400 mAh, Warranty 24 month(s)",
            "itemId":"87DFC63C-5837-47C6-9BD8-036D1757FF1D",
            "depreciationPercentage":50.00,
            "depreciationAmount":740.50,
            "quantity":1,
            "replacementAmount":740.50,
            "ageMonths":36,
            "basePrice":1481.00,
            "product":{
               "brand":"Samsung",
               "catalogCategory":"Mobiltelefoner",
               "productCode":"4143775",
               "retailPrice":1481.00,
               "scalepointPrice":1480.00
            },
            "status":"SETTLED"
         }
      ],
      "groups":[

      ]
   }
}

In case of error response JSON can be ignored - instead HTTP status code should be used to determine error type.

Appendix A - settlement data elements description

Appendix A - settlement data elements description

Root

Case

SettlementDetails

Items[]

Groups[]