V 1.6.0 - Insurance API
Version 1.6.0
Last updated
Was this helpful?
Version 1.6.0
Last updated
Was this helpful?
The Insurance API is used to manage insurance items, quotations and subscriptions from the your website pages on behalf of the buyers. According the solution code your demand will be issued at the insurance instution side. At any time you can retrieve the status and details of your insurance susbcriptions. Once subscribed, you can cancel your subscription.
Change log:
Minor changes (from 1.3.8 -> 1.6):
Evolve the response of GET /subscriptions/{insuranceSubscriptions} and the request body of POST /subscriptions, POST/items with a new field isRefurbished.
Evolve the response of GET /subscriptions and GET /subscriptions/{insuranceSubscriptions} with a new field merchantCommission.
Updated definition format for CreateInsuranceSubscriptionRequest.buyer.contact.phoneNumber and CreateInsuranceSubscriptionRequest.buyer.contact.mobilePhoneNumber fields. The fields value must be in international format.
Add examples of error responses about the POST /subscriptions: Bad requests in case the phoneNumber and mobilePhoneNumber values didn't match the right format. The used Error code is BaasExceptionHttpResponse.errorCode. REQUEST_VALIDATION_ERROR.
Evolve the request body of POST /subscriptions, the response of GET /subscriptions/{insuranceSubscriptionId } and the response of GET /subscriptions. Adding a filter merchantGlobalOrderId to the GET /subscriptions.
Download OpenApi specs:
Retrieve eligible insurances solutions given a buyer country. As a result, you will obtain a list of insurances solutions codes with their related merchant kits. A merchant kit will allow you to display insurance visual name, label, description , logo and product terms to the customer. An empty json object is returned if no solution is eligible.
You can list all your subscriptions or filter only some ones by specifying a reference such as a basket id. the response will contain subscription Id, dates, times, status, your references, amount financed ... Main use case: Use this API to retrieve status a insurance subscription by refering a basket Id. Important: The list is paginated
ID of the order as a whole - as long as the items are not dispatched separately, with different orders ID.
340005489ID of the basket of the current transaction, as given by the merchant (thirdparty)
185462145The page number
1Example: 1The number of elements per page
20Example: 20You get all details of an insurance subscription. You will have to provide a insurance subscription Id previously obtained as listed or initiated.
The unique Insurance Subscription Id
Request and create an item by probing the Insurance institution. As the result, you will get an item Id required for any insurance quotation.
ID of the BaaS product used
CIFRWE-DXCOPattern: ^CI\w{4}-\w{4}$Item Stock Keeping Unit
ZG011AQAThe identifier of the item from merchant
8c6450c2-b142-11ed-afa1-0242ac120002Item brand
BeatsItem model
Beats Solo3Item title
Beats Solo3 Wireless On-Ear HeadphonesItem description
Headphone Chip, Class 1 Bluetooth, 40 Hours of Listening Time, Built-in Microphone - Black (Latest Model)Item characteristics
With up to 40 hours of battery life, Beats Solo3 wireless is your perfect everyday headphone...Item category
Headphones & EarbudsIf true, the item is refurbished otherwise it is a new item. If not specified, the default value is false.
falseExample: trueSearch for Insurance eligibility of the given item. As a result you will get a list of insurances options with their prices estimation and descriptions. So the buyer could pick one of the list for getting a quotation.
ID of the BaaS product used
CIFRWE-DXCOPattern: ^CI\w{4}-\w{4}$The identifier of the Item from producer moonshot
abe12340-b1f5-11ed-afa1-0242ac120002The item price
29.9Evaluate a quotation for the item and related price and a choosen insurance option by the buyer. As a result, you will get the insurance price confirmed. Important: a quotation will expire after a delay. Make sure the quotation is not expired before using it.
Insurance Quotation Request Object
ID of the BaaS product used
CIFRWE-DXCOPattern: ^CI\w{4}-\w{4}$item identifier
2343234567price of the item
100.25insurance identifier
ABCD002To initiate a insurance subscription you will have to complete the requested parameters from the context of your checkout page of which identity, address of the buyer, Insurance ID choosen, insurance items details ... You can refer your insurance susbsription with your order or basket id. As a result you will get a insurance subscription Id with status "subscribed"
Important: the "solutionCode" is the parameter that determine the Producer's solution such as warrenty extension choosen by the buyer in the checkout page
ID of the BaaS product used
CIFRWE-DXCOPattern: ^CI\w{4}-\w{4}$ID of the basket of the current transaction, as given by the merchant (third party)
647aeb24-a89c-11ed-afa1-0242ac120002ID of the buyer (final customer), as given by the merchant (third party)
44226c6c-aca7-11ed-afa1-0242ac120002Id of the merchant order.
OD456742Expiration date of the quote given before entering the subscription process
Price of the policy subscribed, as per the quotation
56.34Request a cancellation according to a specific insuranceSubscriptionId. As a response, you will get the confirmation of the cancellation.