Booking process overview
The Booking endpoint is used to confirm the purchase of the insurance offering.
If a customer has chosen to purchase the insurance product(s) offered in the previous Quote step the customer must complete the checkout process with payment being successfully collected before proceeding with the following steps to confirm and distribute the policy.
After customers complete the booking process and insurance premiums are collected by the partner a request to the booking endpoint must be made.
Validations:
1. Given the initial status after the Quote Request is RECEIVED
, when a booking request is submitted, the expected status returned in response payload after a successful booking request is CONFIRMED
.
2. The price field should also be validated, to confirm the final price matches the quote stage price.
3. The presence of an "errors" object in response payload indicates an important logic error in booking, that should be noted.
A CONFIRMED
INS is considered booked, sold, provisioned, and will result in a policy confirmation being submitted to the user.
POST
https://api.xcover.com/x/partners/:partner_id/bookings/:quote_package_id
The booking endpoint accepts a JSON payload against the URI containing the quote package ID returned in the quote request. The payload consists of policyholder information (most likely the same as the customer) and a list of quotes selected for purchase. the most relevant policies available for distribution
The Instant Booking endpoint is available to partners who meet strict criteria outlined by Cover Genius. Please contact your assigned Client Solutions Engineer (CSE) to discuss use of the Instant Booking endpoint.
If a customer has chosen to purchase the insurance product(s) offered through your platform then a call to the Instant Booking endpoint should be issued after the insurance premium has been calculated and payment has been captured.
POST
https://api.xcover.com/x/partners/:partner_id/instant_booking/
The payload consists of information necessary to issue the policy (widely varying depending on policy type) and policyholder information
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|
Name | Type | Description |
---|
partner_id
string
Unique Partner Code
quote_package_id
string
Quote Package ID
Content-Type
string
application/json
Date
string
Current Datetime
Authorization
string
HMAC Signature
X-Api-Key
string
API Key
partner_id | string | Unique Partner Code |
Content-Type | string | application/json |
Date | string | Current Datetime |
Authorization | string | HMAC Signature |
X-Api-Key | string | API Key |