Download OpenAPI specification:Download
Report conversion of the main product without ancillary insurance products
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
partner_metadata | object (Partner metadata) This field takes partner-specific fields. The keys represent field names and can be any arbitrary string.The values must be one of the simple JSON types: string, boolean, number or null. It’s impossible to use complex types i.e. objects and arrays. |
Request Succeeded
Unknown partner or booking, or booking does not belong to the partner
Duplicated request
Resource is locked
{- "partner_metadata": { }
}
{- "type": "string",
- "message": "string",
- "code": "string",
- "href": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Create a quote with provided parameters
partner_id required | string |
fast_quote | boolean Fast quote calculation.Quote will be calculated, but results won't be stored. |
active_only | boolean Select only active policies if testing API key is used. |
include_extra_fields | boolean Include extra_fields in Fast quote response. Shall be used in conjunction with "fast_quote" |
currency required | string (Currency) Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BDT" "BGN" "BHD" "BRL" "BSD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "EGP" "EUR" "FJD" "GBP" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JOD" "JPY" "KHR" "KRW" "KWD" "KZT" "LAK" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "THB" "TRY" "TWD" "UAH" "USD" "UYU" "UZS" "VND" "XPF" "ZAR" |
request required | Array of objects (PolicyRequest) |
customer_country required | string (Customer country) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" |
customer_region | string (Customer region) <= 64 characters Nullable Country subdivision where the customer resides (as defined by ISO-3166-2, e.g. "AU-NSW", "FR-20R", "IS-1", "JP-13", "SE-T", "SI-099", "US-NY") |
customer_language | string (Customer language) [ 1 .. 8 ] characters Customer's language |
customer_email | string <email> (Customer email) <= 254 characters Nullable Email address of the customer (bq_policy_pii) |
customer_ip | string (Customer ip) non-empty Nullable |
customer_postcode | string (Customer postcode) <= 32 characters Nullable |
customer_id | string <uuid> (Customer id) |
partner_subsidiary | string (Partner subsidiary) <= 128 characters Nullable Subsidiary of the Partner if applicable |
partner_transaction_id | string (Partner transaction id) <= 1024 characters Nullable A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores. |
partner_customer_id | string (Partner customer id) <= 1024 characters Nullable Partner's customer ID for this transaction |
partner_metadata | object (Partner metadata) This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed. |
policyholder | object (Policyholder) Nullable Policyholder information (bq_policy_pii) |
opt_out | boolean (Opt out) Default: false Should the created quote be automatically opted out (no booking can be made) |
Fast Quote
Quote
Unknown partner
Quote params are incorrect or quote cannot be processed.
{- "currency": "AED",
- "request": [
- {
- "plan": "string",
- "class": "string",
- "flights": [
- {
- "legs": [
- {
- "flight_number": "string",
- "arrival_airport": "string",
- "arrival_country": "string",
- "arrival_datetime": "string",
- "departure_airport": "string",
- "departure_country": "string",
- "departure_datetime": "string",
- "marketing_airline_iata_code": "string",
- "marketing_airline_icao_code": "string",
- "operating_airline_iata_code": "string",
- "operating_airline_icao_code": "string"
}
], - "price": 0,
- "arrival_city": "string",
- "departure_city": "string",
- "arrival_country": "string",
- "arrival_datetime": "string",
- "departure_country": "string",
- "departure_datetime": "string",
- "airline_reservation_number": "string"
}
], - "resident_id": "string",
- "tours_price": 0,
- "baggage_count": 0,
- "flights_price": 0,
- "is_standalone": true,
- "trip_end_date": "string",
- "flexible_ticket": true,
- "trip_start_date": "string",
- "number_of_adults": 0,
- "departure_country": "string",
- "number_of_infants": 0,
- "accomodation_price": 0,
- "number_of_children": 0,
- "reservation_number": "string",
- "destination_country": "string",
- "total_tickets_price": 1,
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:35Z",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "policy_end_date": "2024-03-29T06:15:35Z",
- "tier": "gold",
- "benefits": [
- {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}
], - "trip_desc": "oneWay",
- "provider_id": "string",
- "family_policy": true,
- "kayak_click_id": "string",
- "number_of_teens": 0,
- "renewal_end_date": "string",
- "destination_region": "string",
- "renewal_start_date": "string",
- "policy_type_version": 25,
- "policy_type": "comprehensive_travel_insurance"
}
], - "customer_country": "AF",
- "customer_region": "string",
- "customer_language": "string",
- "customer_ip": "string",
- "customer_postcode": "string",
- "customer_id": "string",
- "partner_subsidiary": "string",
- "partner_transaction_id": "string",
- "partner_customer_id": "string",
- "partner_metadata": { },
- "policyholder": { },
- "opt_out": false
}
{- "currency": "str",
- "quotes": {
- "property1": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}
}, - "pds_url": "string",
- "files": "string",
- "extra_fields": "string"
}, - "property2": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}
}, - "pds_url": "string",
- "files": "string",
- "extra_fields": "string"
}
}, - "errors": {
- "property1": "string",
- "property2": "string"
}, - "fast_quote_id": "string"
}
Get a specific quote information
partner_id required | string |
quote_package_id required | string |
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": {
- "property1": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}, - "property2": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}
}, - "bundle_code": "string",
- "bundle_price": 0,
- "bundle_content": {
- "title": "string",
- "description": "string",
- "optout_msg": "string",
- "disclaimer": "string"
}, - "bundle_price_formatted": "string",
- "bundle_discount_percent": 0,
- "bundle_discount_amount": 0,
- "bundle_discount_amount_formatted": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Update an existing Quote in a Quote Package.
For addition or modification of specific field types(lists or objects) in the "request" field, send the new data appended to the existing data for that particular field type.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
currency required | string (Currency) Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BDT" "BGN" "BHD" "BRL" "BSD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "EGP" "EUR" "FJD" "GBP" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JOD" "JPY" "KHR" "KRW" "KWD" "KZT" "LAK" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "THB" "TRY" "TWD" "UAH" "USD" "UYU" "UZS" "VND" "XPF" "ZAR" |
request | Array of objects Nullable |
customer_country required | string (Customer country) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" |
customer_region | string (Customer region) <= 64 characters Nullable Country subdivision where the customer resides (as defined by ISO-3166-2, e.g. "AU-NSW", "FR-20R", "IS-1", "JP-13", "SE-T", "SI-099", "US-NY") |
customer_language | string (Customer language) [ 1 .. 8 ] characters Customer's language |
customer_email | string <email> (Customer email) <= 254 characters Nullable Email address of the customer (bq_policy_pii) |
customer_ip | string (Customer ip) non-empty Nullable |
customer_postcode | string (Customer postcode) <= 32 characters Nullable |
customer_id | string <uuid> (Customer id) |
partner_subsidiary | string (Partner subsidiary) <= 128 characters Nullable Subsidiary of the Partner if applicable |
partner_transaction_id | string (Partner transaction id) <= 1024 characters Nullable A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores. |
partner_customer_id | string (Partner customer id) <= 1024 characters Nullable Partner's customer ID for this transaction |
partner_metadata | object (Partner metadata) This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed. |
policyholder | object (Policyholder) Nullable Policyholder information (bq_policy_pii) |
preview | boolean (Preview) Default: false When preview is True, the update will only be displayed but not saved. |
Unknown partner
Duplicated request
Quote params are incorrect or quote cannot be processed.
Resource is locked
{- "currency": "AED",
- "request": [
- {
- "property1": "string",
- "property2": "string"
}
], - "customer_country": "AF",
- "customer_region": "string",
- "customer_language": "string",
- "customer_ip": "string",
- "customer_postcode": "string",
- "customer_id": "string",
- "partner_subsidiary": "string",
- "partner_transaction_id": "string",
- "partner_customer_id": "string",
- "partner_metadata": { },
- "policyholder": { },
- "preview": false
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": {
- "property1": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}, - "property2": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}
}, - "bundle_code": "string",
- "bundle_price": 0,
- "bundle_content": {
- "title": "string",
- "description": "string",
- "optout_msg": "string",
- "disclaimer": "string"
}, - "bundle_price_formatted": "string",
- "bundle_discount_percent": 0,
- "bundle_discount_amount": 0,
- "bundle_discount_amount_formatted": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Add quotes to existing package
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
request required | Array of objects |
Quote added
Unknown partner or package id
Duplicated request
Request params are incorrect or quote cannot be added
Resource is locked
{- "request": [
- {
- "property1": "string",
- "property2": "string"
}
]
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": {
- "property1": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}, - "property2": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}
}, - "bundle_code": "string",
- "bundle_price": 0,
- "bundle_content": {
- "title": "string",
- "description": "string",
- "optout_msg": "string",
- "disclaimer": "string"
}, - "bundle_price_formatted": "string",
- "bundle_discount_percent": 0,
- "bundle_discount_amount": 0,
- "bundle_discount_amount_formatted": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Delete quotes from existing package
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes required | Array of objects (QuoteID) |
Quote deleted
Unknown partner or quote package
Duplicated request
Request params are incorrect or quote cannot be deleted
Resource is locked
{- "quotes": [
- {
- "id": "string"
}
]
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": {
- "property1": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}, - "property2": {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
]
}
}, - "bundle_code": "string",
- "bundle_price": 0,
- "bundle_content": {
- "title": "string",
- "description": "string",
- "optout_msg": "string",
- "disclaimer": "string"
}, - "bundle_price_formatted": "string",
- "bundle_discount_percent": 0,
- "bundle_discount_amount": 0,
- "bundle_discount_amount_formatted": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Lists all partner bookings filtered by the query parameters. Datetime fields need to use url-encoded ISO 8601 date format.
partner_id required | string |
id | string |
customer__email | string |
customer__email__startswith | string |
customer__phone | string |
customer__phone__startswith | string |
created_at__date__lte | string |
created_at__date__gte | string |
updated_at__date__lte | string |
updated_at__date__gte | string |
status | string |
updated_before | string ISO8601 format datetime. YYYY-MM-DDThh:mm:ss[.SSS]+|-hh:mm |
updated_after | string ISO8601 format datetime. YYYY-MM-DDThh:mm:ss[.SSS]+|-hh:mm |
created_before | string ISO8601 format datetime. YYYY-MM-DDThh:mm:ss[.SSS]+|-hh:mm |
created_after | string ISO8601 format datetime. YYYY-MM-DDThh:mm:ss[.SSS]+|-hh:mm |
force_policyholder_update | string |
limit | integer Number of results to return per page. |
offset | integer The initial index from which to return the results. |
Unknown partner.
{- "count": 0,
- "results": [
- {
- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:35Z",
- "notification_date": "2024-03-29T06:15:35Z",
- "due_date": "2024-03-29T06:15:35Z",
- "expiry_date": "2024-03-29T06:15:35Z",
- "cancelled_on": "2024-03-29T06:15:35Z",
- "paid_on": "2024-03-29T06:15:35Z",
- "created_at": "2024-03-29T06:15:35Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string"
}
]
}
Get booking details for the provided quote package id or partner_transaction_id.
partner_id required | string |
quote_package_id required | string Booking |
Successful request
Unknown partner or booking
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:35Z",
- "notification_date": "2024-03-29T06:15:35Z",
- "due_date": "2024-03-29T06:15:35Z",
- "expiry_date": "2024-03-29T06:15:35Z",
- "cancelled_on": "2024-03-29T06:15:35Z",
- "paid_on": "2024-03-29T06:15:35Z",
- "created_at": "2024-03-29T06:15:35Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string",
- "partner": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
- "updated_at": "2024-03-29T06:15:35Z",
- "xpay_payment_enabled": true,
- "xpay_refund_enabled": true,
- "automatic_refund_by_xcore": true,
- "allow_policy_modifications_on_xcover": true,
- "emails": [
- {
- "id": "string",
- "from_email": "string",
- "email_slug": "string",
- "email_version": -2147483648,
- "event_name": 0,
- "include_partner_in_context": true,
- "attach_coi": true,
- "send_linked_sms": true,
- "auto_send": true,
- "enable_expression": "string"
}
], - "attributes": { },
- "signup_method_on_xcover": "phone",
- "use_standard_region": true,
- "allow_payout_customer": true,
- "subsidiary": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
}
}, - "partner_metadata": { },
- "customer_language": "string"
}
Convert a specific quote to booking
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes required | Array of objects (BookingRequestQuote) |
policyholder required | object (Policyholder) |
require_payment_confirmation | boolean (Require payment confirmation) |
partner_transaction_id | string (Partner transaction id) non-empty |
xpay_charge_id | string (Xpay charge id) non-empty Deprecated. Please use the payment_details. |
xpay_customer_token_id | string (Xpay customer token id) non-empty Deprecated. Please use the payment_details. |
payment_details | object (PaymentDetails) |
Successful booking
Request format is invalid
Unknown partner
Duplicated request
Request data is invalid
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "instalment_plan": "string",
- "resident_id": "string",
- "reservation_number": "string",
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:35Z"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string"
}, - "require_payment_confirmation": true,
- "partner_transaction_id": "string",
- "xpay_charge_id": "string",
- "xpay_customer_token_id": "string",
- "payment_details": {
- "provider": "string",
- "xpay_charge_id": "string",
- "xpay_customer_id": "string",
- "transaction_id": "string",
- "customer_token_id": "string"
}
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:35Z",
- "notification_date": "2024-03-29T06:15:35Z",
- "due_date": "2024-03-29T06:15:35Z",
- "expiry_date": "2024-03-29T06:15:35Z",
- "cancelled_on": "2024-03-29T06:15:35Z",
- "paid_on": "2024-03-29T06:15:35Z",
- "created_at": "2024-03-29T06:15:35Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string"
}
Change the owner of a booking to another user.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
first_name required | string (First name) [ 1 .. 255 ] characters First name |
last_name required | string (Last name) <= 255 characters Nullable Last name |
string (Email) Nullable Email address | |
phone | string (Phone) Nullable Phone number |
address1 | string (Address1) <= 256 characters Nullable Address line 1 |
address2 | string (Address2) <= 256 characters Nullable Address line 2 |
postcode | string (Postcode) <= 32 characters Nullable Postcode |
company | string (Company) <= 256 characters Nullable Company name |
company_reg_id | string (Company reg id) <= 64 characters Nullable Company registration ID |
middle_name | string (Middle name) <= 256 characters Nullable |
country required | string (Country) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GO" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "XK" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "KP" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "KR" "SS" "ES" "LK" "SD" "SR" "SJ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "UM" "US" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" Country of residence |
age | integer (Age) Nullable Age |
city | string (City) <= 128 characters Nullable City of residence |
region | string (Region) <= 64 characters Nullable Region |
secondary_email | string (Secondary email) non-empty Nullable Secondary email address |
birth_date | string <date> (Birth date) Nullable Date of birth |
tax_payer_id | string (Tax payer id) <= 32 characters Nullable Tax payer ID |
Successful request
Duplicated request
Resource is locked
{- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string"
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:35Z",
- "notification_date": "2024-03-29T06:15:35Z",
- "due_date": "2024-03-29T06:15:35Z",
- "expiry_date": "2024-03-29T06:15:35Z",
- "cancelled_on": "2024-03-29T06:15:35Z",
- "paid_on": "2024-03-29T06:15:35Z",
- "created_at": "2024-03-29T06:15:35Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string",
- "partner": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
- "updated_at": "2024-03-29T06:15:35Z",
- "xpay_payment_enabled": true,
- "xpay_refund_enabled": true,
- "automatic_refund_by_xcore": true,
- "allow_policy_modifications_on_xcover": true,
- "emails": [
- {
- "id": "string",
- "from_email": "string",
- "email_slug": "string",
- "email_version": -2147483648,
- "event_name": 0,
- "include_partner_in_context": true,
- "attach_coi": true,
- "send_linked_sms": true,
- "auto_send": true,
- "enable_expression": "string"
}
], - "attributes": { },
- "signup_method_on_xcover": "phone",
- "use_standard_region": true,
- "allow_payout_customer": true,
- "subsidiary": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
}
}, - "partner_metadata": { },
- "customer_language": "string"
}
Confirms booking in two-step booking scenario. In this case require_payment_confirmation
flag in the Create booking
request needs to be set.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
payment_details | object (PaymentDetails) |
xpay_charge_id | string (Xpay charge id) non-empty Deprecated, moved into payment_details. |
Duplicated request
Resource is locked
{- "payment_details": {
- "provider": "string",
- "xpay_charge_id": "string",
- "xpay_customer_id": "string",
- "transaction_id": "string",
- "customer_token_id": "string"
}, - "xpay_charge_id": "string"
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:35Z",
- "policy_end_date": "2024-03-29T06:15:35Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:35Z",
- "confirmed_at": "2024-03-29T06:15:35Z",
- "updated_at": "2024-03-29T06:15:35Z",
- "cancelled_at": "2024-03-29T06:15:35Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:35Z",
- "notification_date": "2024-03-29T06:15:35Z",
- "due_date": "2024-03-29T06:15:35Z",
- "expiry_date": "2024-03-29T06:15:35Z",
- "cancelled_on": "2024-03-29T06:15:35Z",
- "paid_on": "2024-03-29T06:15:35Z",
- "created_at": "2024-03-29T06:15:35Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string"
}
Manually triggers policy lifecycle email to be sent to the customer
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
string (Email) Nullable Email address | |
event | string (Event) Nullable Enum: "BOOKING_CREATED" "BOOKING_CANCELLED" Defines what email to trigger |
Email queued successfully
Unknown partner or booking, or booking does not belong to the partner
Duplicated request
Resource is locked
{- "email": "string",
- "event": "BOOKING_CREATED"
}
{- "type": "string",
- "message": "string",
- "code": "string",
- "href": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Convert a fast quote to booking
fast_quote_id required | string |
partner_id required | string |
x-idempotency-key | string Idempotency key |
quotes required | Array of objects (BookingRequestQuote) |
policyholder required | object (Policyholder) |
require_payment_confirmation | boolean (Require payment confirmation) |
partner_transaction_id | string (Partner transaction id) non-empty |
xpay_charge_id | string (Xpay charge id) non-empty Deprecated. Please use the payment_details. |
xpay_customer_token_id | string (Xpay customer token id) non-empty Deprecated. Please use the payment_details. |
payment_details | object (PaymentDetails) |
Successful booking
Request format is invalid
Unknown partner
Duplicated request
Request data is invalid
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "instalment_plan": "string",
- "resident_id": "string",
- "reservation_number": "string",
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:36Z"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string"
}, - "require_payment_confirmation": true,
- "partner_transaction_id": "string",
- "xpay_charge_id": "string",
- "xpay_customer_token_id": "string",
- "payment_details": {
- "provider": "string",
- "xpay_charge_id": "string",
- "xpay_customer_id": "string",
- "transaction_id": "string",
- "customer_token_id": "string"
}
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:36Z",
- "notification_date": "2024-03-29T06:15:36Z",
- "due_date": "2024-03-29T06:15:36Z",
- "expiry_date": "2024-03-29T06:15:36Z",
- "cancelled_on": "2024-03-29T06:15:36Z",
- "paid_on": "2024-03-29T06:15:36Z",
- "created_at": "2024-03-29T06:15:36Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string"
}
Make quote and booking in a single step
partner_id required | string |
active_only | boolean Select only active policies if testing API key is used. |
x-idempotency-key | string Idempotency key |
customer_ip | string (Customer ip) non-empty Nullable |
partner_metadata | object (Partner metadata) This field can be used to pass custom information along with the quote request. The value of this field should be a JSON object representing key-value pairs with a string, boolean or number as a value. Complex data types like objects or array are not allowed. |
policyholder required | object (Policyholder) |
customer_id | string <uuid> (Customer id) |
partner_customer_id | string (Partner customer id) <= 1024 characters Nullable Partner's customer ID for this transaction |
request required | Array of objects (BookingPolicyRequest) |
partner_subsidiary | string (Partner subsidiary) <= 128 characters Nullable Subsidiary of the Partner if applicable |
customer_language | string (Customer language) [ 1 .. 8 ] characters Customer's language |
fast_quote_id | string <uuid> (Fast quote id) |
partner_transaction_id | string (Partner transaction id) <= 1024 characters Nullable A unique id of the transaction record (booking, order, etc) on the partner side. It can be used in get booking endpoint, but only if characters are limited to alphanumeric symbols, hyphens and underscores. |
payment_details | object (PaymentDetails) |
xpay_charge_id | string (Xpay charge id) non-empty Deprecated, moved into payment_details. |
currency required | string (Currency) Enum: "AED" "AFN" "ARS" "AUD" "AZN" "BDT" "BGN" "BHD" "BRL" "BSD" "CAD" "CHF" "CLP" "CNY" "COP" "CRC" "CZK" "DKK" "EGP" "EUR" "FJD" "GBP" "GTQ" "HKD" "HNL" "HRK" "HUF" "IDR" "ILS" "INR" "ISK" "JOD" "JPY" "KHR" "KRW" "KWD" "KZT" "LAK" "LKR" "MAD" "MKD" "MUR" "MVR" "MXN" "MYR" "NGN" "NOK" "NZD" "OMR" "PEN" "PHP" "PKR" "PLN" "QAR" "RON" "RSD" "RUB" "SAR" "SEK" "SGD" "THB" "TRY" "TWD" "UAH" "USD" "UYU" "UZS" "VND" "XPF" "ZAR" |
Successful booking
Request format is invalid
Unknown partner
Duplicated request
Request data is invalid
Resource is locked
{- "customer_ip": "string",
- "partner_metadata": { },
- "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string"
}, - "customer_id": "string",
- "partner_customer_id": "string",
- "request": [
- {
- "plan": "string",
- "class": "string",
- "flights": [
- {
- "legs": [
- {
- "flight_number": "string",
- "arrival_airport": "string",
- "arrival_country": "string",
- "arrival_datetime": "string",
- "departure_airport": "string",
- "departure_country": "string",
- "departure_datetime": "string",
- "marketing_airline_iata_code": "string",
- "marketing_airline_icao_code": "string",
- "operating_airline_iata_code": "string",
- "operating_airline_icao_code": "string"
}
], - "price": 0,
- "arrival_city": "string",
- "departure_city": "string",
- "arrival_country": "string",
- "arrival_datetime": "string",
- "departure_country": "string",
- "departure_datetime": "string",
- "airline_reservation_number": "string"
}
], - "resident_id": "string",
- "tours_price": 0,
- "baggage_count": 0,
- "flights_price": 0,
- "is_standalone": true,
- "trip_end_date": "string",
- "flexible_ticket": true,
- "trip_start_date": "string",
- "number_of_adults": 0,
- "departure_country": "string",
- "number_of_infants": 0,
- "accomodation_price": 0,
- "number_of_children": 0,
- "reservation_number": "string",
- "destination_country": "string",
- "total_tickets_price": 1,
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:36Z",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "policy_end_date": "2024-03-29T06:15:36Z",
- "tier": "gold",
- "benefits": [
- {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}, - {
- "benefit_type": "Trip Cancellation"
}
], - "trip_desc": "oneWay",
- "provider_id": "string",
- "family_policy": true,
- "kayak_click_id": "string",
- "number_of_teens": 0,
- "renewal_end_date": "string",
- "destination_region": "string",
- "renewal_start_date": "string",
- "policy_type_version": 25,
- "policy_type": "comprehensive_travel_insurance",
- "partner_price": 0
}
], - "partner_subsidiary": "string",
- "customer_language": "string",
- "fast_quote_id": "string",
- "partner_transaction_id": "string",
- "payment_details": {
- "provider": "string",
- "xpay_charge_id": "string",
- "xpay_customer_id": "string",
- "transaction_id": "string",
- "customer_token_id": "string"
}, - "xpay_charge_id": "string",
- "currency": "AED"
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:36Z",
- "notification_date": "2024-03-29T06:15:36Z",
- "due_date": "2024-03-29T06:15:36Z",
- "expiry_date": "2024-03-29T06:15:36Z",
- "cancelled_on": "2024-03-29T06:15:36Z",
- "paid_on": "2024-03-29T06:15:36Z",
- "created_at": "2024-03-29T06:15:36Z"
}, - "can_be_cancelled": true,
- "errors": [
- "string"
], - "third_party_admins": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
], - "ombudsman_list": [
- {
- "name": "string",
- "phone": "string",
- "email": "string"
}
]
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string"
}
Modifies booking. This endpoint can potentially trigger premium change.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes | Array of objects (UpdateBookingRequestQuote) non-empty |
xpay_charge_id | string (Xpay charge id) non-empty |
policyholder | object (PolicyholderUpdate) |
skip_xpay_transaction | boolean (Skip xpay transaction) Default: false |
Duplicated request
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "update_fields": {
- "resident_id": "string",
- "tours_price": 0,
- "flights_price": 0,
- "trip_end_date": "string",
- "trip_start_date": "string",
- "number_of_adults": 0,
- "departure_country": "string",
- "number_of_infants": 0,
- "accomodation_price": 0,
- "number_of_children": 0,
- "total_tickets_price": 1,
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:36Z",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "policy_end_date": "2024-03-29T06:15:36Z",
- "tier": "gold",
- "number_of_teens": 0
}, - "modification_id": "string",
- "modification_fields": { }
}
], - "xpay_charge_id": "string",
- "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string"
}, - "skip_xpay_transaction": false
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "can_be_cancelled": true,
- "coolingoff_end_date": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:36Z",
- "notification_date": "2024-03-29T06:15:36Z",
- "due_date": "2024-03-29T06:15:36Z",
- "expiry_date": "2024-03-29T06:15:36Z",
- "cancelled_on": "2024-03-29T06:15:36Z",
- "paid_on": "2024-03-29T06:15:36Z",
- "created_at": "2024-03-29T06:15:36Z"
}, - "cancellation_info": { },
- "price_diff": 0,
- "price_diff_formatted": "string"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string",
- "total_price_diff": 0,
- "total_price_diff_formatted": "string"
}
Confirms booking modification and set parameters as provided in the previous " modification" request
partner_id required | string |
quote_package_id required | string |
update_id required | string |
x-idempotency-key | string Idempotency key |
xpay_charge_id | string (Xpay charge id) non-empty |
Duplicated request
Resource is locked
{- "xpay_charge_id": "string"
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "can_be_cancelled": true,
- "coolingoff_end_date": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:36Z",
- "notification_date": "2024-03-29T06:15:36Z",
- "due_date": "2024-03-29T06:15:36Z",
- "expiry_date": "2024-03-29T06:15:36Z",
- "cancelled_on": "2024-03-29T06:15:36Z",
- "paid_on": "2024-03-29T06:15:36Z",
- "created_at": "2024-03-29T06:15:36Z"
}, - "cancellation_info": { },
- "price_diff": 0,
- "price_diff_formatted": "string"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string",
- "total_price_diff": 0,
- "total_price_diff_formatted": "string"
}
Generates a quote for booking modification. The modification then needs to be confirmed using the update_id parameter provided in the response.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes | Array of objects (UpdateBookingRequestQuote) non-empty |
xpay_charge_id | string (Xpay charge id) non-empty |
policyholder | object (PolicyholderUpdate) |
skip_xpay_transaction | boolean (Skip xpay transaction) Default: false |
Duplicated request
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "update_fields": {
- "resident_id": "string",
- "tours_price": 0,
- "flights_price": 0,
- "trip_end_date": "string",
- "trip_start_date": "string",
- "number_of_adults": 0,
- "departure_country": "string",
- "number_of_infants": 0,
- "accomodation_price": 0,
- "number_of_children": 0,
- "total_tickets_price": 1,
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:36Z",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "policy_end_date": "2024-03-29T06:15:36Z",
- "tier": "gold",
- "number_of_teens": 0
}, - "modification_id": "string",
- "modification_fields": { }
}
], - "xpay_charge_id": "string",
- "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string"
}, - "skip_xpay_transaction": false
}
{- "id": "string",
- "status": "string",
- "currency": "str",
- "total_price": 0,
- "total_price_formatted": "string",
- "partner_transaction_id": "string",
- "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "security_token": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "attributes": {
- "property1": "string",
- "property2": "string"
}, - "can_be_cancelled": true,
- "coolingoff_end_date": "string",
- "next_renewal": {
- "id": "string",
- "package_id": "string",
- "quote_id": "string",
- "status": "string",
- "start_date": "2024-03-29T06:15:36Z",
- "notification_date": "2024-03-29T06:15:36Z",
- "due_date": "2024-03-29T06:15:36Z",
- "expiry_date": "2024-03-29T06:15:36Z",
- "cancelled_on": "2024-03-29T06:15:36Z",
- "paid_on": "2024-03-29T06:15:36Z",
- "created_at": "2024-03-29T06:15:36Z"
}, - "cancellation_info": { },
- "price_diff": 0,
- "price_diff_formatted": "string"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "fnol_link": "string",
- "total_price_diff": 0,
- "total_price_diff_formatted": "string",
- "update_id": "string",
- "payment_methods": [
- {
- "number": 0,
- "variant": "string",
- "expiry_year": 0,
- "holder_name": "string",
- "expiry_month": 0,
- "payment_method": "string"
}
]
}
Cancel a specific booking.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
preview | boolean (Preview) Default: false |
refund_required | boolean (Refund required) Default: true Deprecated. Refund will be created on a best-effort basis |
quotes | Array of objects (CancelBookingRequestQuote) |
If "preview" is False: successfully cancelled or partially cancelled. If "preview" is True: the cancellation can be successfully made
Unknown partner or booking, or booking does not belong to the partner
Duplicated request
Unsuccessful cancellation. Potential reasons include: booking has no policies which can be cancelled, booking was cancelled before, booking was not purchased.
Resource is locked
{- "preview": false,
- "refund_required": true,
- "quotes": [
- {
- "id": "string",
- "reason_for_cancellation": "string"
}
]
}
{- "id": "string",
- "status": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "policy_cancellation_date": "2024-03-29T06:15:36Z",
- "policy_coolingoff_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "refund_value": 0,
- "adjustment_fee": 0,
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "commission": "string"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "total_price": 0,
- "total_price_formatted": "string",
- "total_refund": 0,
- "total_refund_formatted": "string",
- "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "currency": "str",
- "cancellation_id": "string",
- "confirm_before": "2024-03-29T06:15:36Z",
- "partner": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
- "updated_at": "2024-03-29T06:15:36Z",
- "xpay_payment_enabled": true,
- "xpay_refund_enabled": true,
- "automatic_refund_by_xcore": true,
- "allow_policy_modifications_on_xcover": true,
- "emails": [
- {
- "id": "string",
- "from_email": "string",
- "email_slug": "string",
- "email_version": -2147483648,
- "event_name": 0,
- "include_partner_in_context": true,
- "attach_coi": true,
- "send_linked_sms": true,
- "auto_send": true,
- "enable_expression": "string"
}
], - "attributes": { },
- "signup_method_on_xcover": "phone",
- "use_standard_region": true,
- "allow_payout_customer": true,
- "subsidiary": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
}
}, - "refund_amount": 0,
- "refund_amount_formatted": "string",
- "cancellation_payout_url": "string"
}
Confirm the cancellation that is created by booking cancellation preview
cancellation_id required | string |
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
reason_for_cancellation | string (Reason for cancellation) <= 1000 characters Nullable |
Successfully cancelled or partially cancelled
Unknown partner or booking, or booking does not belong to the partner
Duplicated request
Unsuccessful cancellation. Potential reasons include: the cancellation_id does not exist, new cancellation preview has been made so that thecancellation_id is obsolete, the cancellation preview has expired
Resource is locked
{- "reason_for_cancellation": "string"
}
{- "id": "string",
- "status": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "policy_cancellation_date": "2024-03-29T06:15:36Z",
- "policy_coolingoff_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "refund_value": 0,
- "adjustment_fee": 0,
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string"
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "commission": "string"
}
], - "policyholder": {
- "first_name": "string",
- "last_name": "string",
- "email": "string",
- "phone": "string",
- "address1": "string",
- "address2": "string",
- "postcode": "string",
- "company": "string",
- "company_reg_id": "string",
- "middle_name": "string",
- "country": "AF",
- "age": 0,
- "city": "string",
- "region": "string",
- "secondary_email": "string",
- "birth_date": "2024-03-29",
- "tax_payer_id": "string",
- "allow_updates": false,
- "fields_allowed_to_update": [
- "string"
]
}, - "created_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "total_price": 0,
- "total_price_formatted": "string",
- "total_refund": 0,
- "total_refund_formatted": "string",
- "total_tax": 0,
- "total_tax_formatted": "string",
- "total_premium": 0,
- "total_premium_formatted": "string",
- "currency": "str",
- "cancellation_id": "string",
- "confirm_before": "2024-03-29T06:15:36Z",
- "partner": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
- "updated_at": "2024-03-29T06:15:36Z",
- "xpay_payment_enabled": true,
- "xpay_refund_enabled": true,
- "automatic_refund_by_xcore": true,
- "allow_policy_modifications_on_xcover": true,
- "emails": [
- {
- "id": "string",
- "from_email": "string",
- "email_slug": "string",
- "email_version": -2147483648,
- "event_name": 0,
- "include_partner_in_context": true,
- "attach_coi": true,
- "send_linked_sms": true,
- "auto_send": true,
- "enable_expression": "string"
}
], - "attributes": { },
- "signup_method_on_xcover": "phone",
- "use_standard_region": true,
- "allow_payout_customer": true,
- "subsidiary": {
- "id": "string",
- "slug": "string",
- "name": "string",
- "title": "string",
}
}, - "refund_amount": 0,
- "refund_amount_formatted": "string",
- "cancellation_payout_url": "string"
}
Creates a renewal with parameters provided in the previous "Quote for renewal" request
partner_id required | string |
pending_renewal_id required | string |
quote_package_id required | string |
return_booking_detail | boolean Return booking details in response |
x-idempotency-key | string Idempotency key |
quotes required | Array of objects (BookingRequestQuote) |
Renewal confirmation is accepted
Request parameters are incorrect
Unknown partner or quote does not belong to the partner
Duplicated request
Request parameters are incorrect
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "insured": [
- {
- "id": "string",
- "first_name": "string",
- "last_name": "string",
- "country": "string",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": { },
- "company": "string"
}
], - "instalment_plan": "string",
- "resident_id": "string",
- "reservation_number": "string",
- "frequent_flyer_details": [
- {
- "frequent_flyer_number": "string"
}
], - "policy_start_date": "2024-03-29T06:15:36Z"
}
]
}
{- "renewal_id": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string",
- "show_benefits": true,
- "metadata": { }
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string",
- "show_benefit": "string",
- "claim_types": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
], - "attributes": { },
- "underwriting_fee": 0
}
]
}
Calling this endpoint indicates that customer is not intended to renew the policyinsurance products
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes | Array of objects (RenewalOptoutRequestQuote) |
Request Succeeded
Unknown partner or booking, or booking does not belong to the partner
Duplicated request
Resource is locked
{- "quotes": [
- {
- "id": "string"
}
]
}
{- "type": "string",
- "message": "string",
- "code": "string",
- "href": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
Generates a Quote for renewal as specified in the request which can then be confirmed using the endpoint specified in the Response or through auto_confirm flag in the Request.
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
auto_confirm | boolean (Auto confirm) Default: false Should the created renewal be automatically confirmed |
use_newest_policy | boolean (Use newest policy) Default: false Use newest policy on renewal |
due_date_within | integer (Due date within) Only renew quotes whose due dates are within the specified number of days from when the request is sent. If not provided, all quotes that are eligible for renewal will be renewed. Accepts non-positive values as well. |
Duplicated request
Resource is locked
{- "auto_confirm": false,
- "use_newest_policy": false,
- "due_date_within": 0
}
{- "renewal_id": "string",
- "quotes": [
- {
- "id": "string",
- "policy_start_date": "2024-03-29T06:15:36Z",
- "policy_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "price": 0,
- "price_formatted": "string",
- "policy": {
- "policy_type": "string",
- "policy_type_version": "string",
- "policy_type_slug": "string",
- "policy_type_group_name": "string",
- "policy_name": "string",
- "policy_code": "string",
- "policy_version": "string",
- "category": "string",
- "content": {
- "title": "string",
- "header": "string",
- "description": "string",
- "optout_msg": "string",
- "inclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "exclusions": [
- {
- "title": "string",
- "description": "string"
}
], - "disclaimer": "string",
- "disclaimer_html": "string",
- "payment_disclaimer": "string",
- "in_path_disclaimer": "string",
- "extra_content": {
- "property1": "string",
- "property2": "string"
}
}, - "underwriter": {
- "disclaimer": "string",
- "name": "string"
}, - "claim_selector_id": "string",
- "show_benefits": true,
- "metadata": { }
}, - "insured": [
- {
- "id": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "email": "string",
- "country": "AF",
- "address1": "string",
- "address2": "string",
- "city": "string",
- "postcode": "string",
- "region": "string",
- "phone": "string",
- "age": 0,
- "birth_date": "2024-03-29",
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "company": "string"
}
], - "tax": {
- "total_tax": 0,
- "total_amount_without_tax": 0,
- "total_tax_formatted": "string",
- "total_amount_without_tax_formatted": "string",
- "taxes": [
- {
- "tax_amount": 0,
- "tax_code": "string",
- "tax_amount_formatted": "string"
}
]
}, - "duration": "string",
- "benefits": [
- {
- "benefit_content_id": "string",
- "description": "string",
- "extra_content": "string",
- "parent_benefit_content_id": "string",
- "parent_description": "string",
- "limit_description": "string",
- "limit": 0,
- "limit_policy_currency": 0,
- "limit_formatted": "string",
- "limit_policy_currency_formatted": "string",
- "limit_per_unit": 0,
- "limit_per_unit_policy_currency": 0,
- "limit_per_unit_formatted": "string",
- "limit_per_unit_policy_currency_formatted": "string",
- "excess_description": "string",
- "excess": 0,
- "excess_policy_currency": 0,
- "excess_formatted": "string",
- "excess_policy_currency_formatted": "string",
- "minimum_claim_amount": 0,
- "minimum_claim_amount_policy_currency": 0,
- "minimum_claim_amount_formatted": "string",
- "minimum_claim_amount_policy_currency_formatted": "string",
- "waiting_period": 0,
- "maximum_claims": 0,
- "benefit_code": "string",
- "show_benefit": "string",
- "claim_types": "string"
}
], - "commission": {
- "partner_commission": 0,
- "partner_commission_formatted": "string",
- "surcharge_commission": 0,
- "surcharge_commission_formatted": "string",
- "total_commission": 0,
- "total_commission_formatted": "string"
}, - "created_at": "2024-03-29T06:15:36Z",
- "confirmed_at": "2024-03-29T06:15:36Z",
- "updated_at": "2024-03-29T06:15:36Z",
- "cancelled_at": "2024-03-29T06:15:36Z",
- "is_renewable": true,
- "is_pricebeat_enabled": "string",
- "cover_amount": 0,
- "cover_amount_formatted": "string",
- "attachments": "string",
- "files": "string",
- "custom_documents": { },
- "extra_fields": {
- "property1": "string",
- "property2": "string"
}, - "surcharge": {
- "total_amount": 0,
- "total_amount_formatted": "string",
- "surcharges": [
- {
- "amount": 0,
- "amount_formatted": "string",
- "code": "string",
- "label": "string"
}
]
}, - "parent_quote_status": "string",
- "discount_price": 0,
- "discount_price_formatted": "string",
- "discount_amount": 0,
- "discount_amount_formatted": "string",
- "instalment_plans": [
- {
- "name": "string",
- "label": "string",
- "amount": 0,
- "first_instalment_amount": 0
}
], - "attributes": { },
- "underwriting_fee": 0
}
]
}
Get instalments details for the provided quote package id.
partner_id required | string |
quote_package_id required | string Booking |
Successful request
Unknown partner or quote package
{- "quotes": [
- {
- "id": "string",
- "next_payment": {
- "id": "string",
- "number": -32768,
- "quote": "string",
- "period_start_date": "2024-03-29T06:15:36Z",
- "period_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "commission": 0,
- "total_amount": 0,
- "tax": { },
- "surcharges": { },
- "payment_failures": { }
}, - "paid_until": "2024-03-29T06:15:36Z",
- "is_payment_overdue": true,
- "payment_schedule": [
- {
- "id": "string",
- "number": -32768,
- "quote": "string",
- "period_start_date": "2024-03-29T06:15:36Z",
- "period_end_date": "2024-03-29T06:15:36Z",
- "status": "string",
- "commission": 0,
- "total_amount": 0,
- "tax": { },
- "surcharges": { },
- "payment_failures": { }
}
], - "total_amount_paid": 0,
- "total_amount_due": 0,
- "partner_comission_paid": 0,
- "partner_comission_due": 0
}
], - "currency": "string"
}
Update instalment payment status
partner_id required | string |
quote_package_id required | string |
x-idempotency-key | string Idempotency key |
quotes required | Array of objects (QuoteInstalment) |
Successful update
Request format is invalid
Unknown partner
Duplicated request
Request data is invalid
Resource is locked
{- "quotes": [
- {
- "id": "string",
- "instalment_id": "string",
- "instalment_number": 0,
- "payment_attempted_date": "2024-03-29T06:15:36Z",
- "payment_status": "PAID",
- "payment_failures": { }
}
]
}
{- "type": "string",
- "message": "string",
- "code": "string",
- "href": "string",
- "errors": {
- "property1": "string",
- "property2": "string"
}
}
List tables.
partner_id required | string |
ordering | string Which field to use when ordering the results. |
limit | integer Number of results to return per page. |
offset | integer The initial index from which to return the results. |
{- "count": 0,
- "results": [
- {
- "id": "string",
- "table_id": "string",
- "slug": "string",
- "version": 0,
- "file": "string",
- "active_from": "2024-03-29T06:15:36Z",
- "template": {
- "id": "string",
- "name": "string",
- "columns": [
- {
- "id": "string",
- "name": "string",
- "data_type": "TEXT",
- "is_nullable": true,
- "is_unique": true,
- "create_index": true
}
]
}
}
]
}
{- "id": "string",
- "table_id": "string",
- "slug": "string",
- "version": 0,
- "file": {
- "name": "string",
- "contents": [
- [
- "string"
]
]
}, - "active_from": "2024-03-29T06:15:36Z",
- "template": {
- "id": "string",
- "name": "string",
- "columns": [
- {
- "id": "string",
- "name": "string",
- "data_type": "TEXT",
- "is_nullable": true,
- "is_unique": true,
- "create_index": true
}
]
}, - "data": { }
}