Confirm Offer

post

The Confirm Offer endpoint is used to finalize the purchase of products from a previously created Offer. This endpoint converts the selected Offer into a confirmed booking after payment has been successfully collected.

Idempotency

This endpoint supports idempotency keys via the x-idempotency-key header to prevent duplicate transactions. Provide a unique operation identifier (e.g., UUID) to ensure safe retries. Duplicate requests return:

409 Conflict: The request was already processed; response contains the cached original result (handle as success)
423 Locked: The original request is still processing; retry after a short delay

Authorizations

AuthorizationstringRequired

Composite Authentication Scheme (Client Key, Date, and Signature)

This scheme requires the client to provide three mandatory headers in every request:

1. X-Api-Key (Client Key)

Purpose: Public identifier for the API consumer.
Example: X-Api-Key: a1b2c3d4e5f6g7h8

2. Date (Timestamp)

Purpose: Timestamp used for generating the signature and preventing replay attacks.
Format: RFC 7231 format (e.g., in GMT).
Example: Date: Sun, 09 Nov 2025 04:04:00 GMT

3. Authorization (Computed Signature)

Purpose: The cryptographic signature that verifies the request's authenticity and integrity.
Format: SIGNATURE [authHeader]

Signature Generation Logic: The authHeader value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the Date header), signed with the private Client Secret.

Path parameters

partner_codestringRequired

Partner code identifier. Client Solutions Engineer (CSE) should provide this value.

offer_idstringRequired

The offer ID returned from the Create Offer endpoint.

Header parameters

x-idempotency-keystring · uuidOptional

A unique identifier to ensure idempotent request processing. If a request with the same idempotency key and body has already been processed, the cached response is returned with a 409 Conflict status code (which can be treated as successful). Keys are stored for 48 hours.

Example: 550e8400-e29b-41d4-a716-446655440000

Body

Responses

200

application/json

idstringOptional

Booking ID

statusstringOptional

Booking status

currencystringOptional

total_pricenumberOptional

total_price_formattedstringOptional

partner_transaction_idstring · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

pds_urlstring · uriOptional

security_tokenstringOptional

total_taxnumberOptional

total_tax_formattedstringOptional

total_premiumnumberOptional

total_premium_formattedstringOptional

fnol_linkstring · uriOptional

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict - Duplicate Request (Idempotent)

application/json

422

Unprocessable Entity

application/json

423

Locked - Request In Progress

application/json

post/partners/{partner_code}/offers/{offer_id}/confirm/

POST /x/partners/{partner_code}/offers/{offer_id}/confirm/ HTTP/1.1
Host: api.xcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 463

{
  "quotes": [
    {
      "id": "755100f6-d7a2-4a8f-a8b8-e054c747a375",
      "insured": [
        {
          "first_name": "d41d8cd98f00b204e9800998ecf8427e",
          "last_name": "d41d8cd98f00b204e9800998ecf8427e",
          "age": 34,
          "email": "[email protected]",
          "birth_date": "1987-02-24"
        }
      ]
    }
  ],
  "policyholder": {
    "first_name": "d41d8cd98f00b204e9800998ecf8427e",
    "last_name": "d41d8cd98f00b204e9800998ecf8427e",
    "email": "[email protected]",
    "address1": "4715 Odie Field",
    "city": "West Paytonstad",
    "country": "AU"
  }
}

{
  "id": "CJTE3-PFJF7-INS",
  "status": "CONFIRMED",
  "currency": "AUD",
  "total_price": 454.92,
  "total_price_formatted": "A$454.92",
  "partner_transaction_id": null,
  "created_at": "2026-01-15T22:22:32.851000Z",
  "updated_at": "2026-01-15T22:22:32.900000Z",
  "pds_url": "https://www.xcover.com/en/pds/CJTE3-PFJF7-INS",
  "security_token": "0rRaJ-WzAoa-oHjBK-14f6M",
  "quotes": [
    {
      "id": "755100f6-d7a2-4a8f-a8b8-e054c747a375",
      "policy_start_date": "2026-01-15T22:22:32.851000+00:00",
      "policy_end_date": "2026-02-13T22:22:32.851000+00:00",
      "status": "CONFIRMED",
      "price": 454.92,
      "price_formatted": "A$454.92",
      "policy": {
        "policy_type": "comprehensive_travel_insurance",
        "policy_type_version": "1",
        "policy_type_slug": "comprehensive_travel_insurance_v1",
        "policy_type_group_name": "travel",
        "policy_name": "Comprehensive Travel Protection (AU)",
        "policy_code": "BKCTPAU0",
        "policy_version": "7933ab1a-b00a-45fa-bfe6-16adba0a4765",
        "category": "comprehensive_travel_insurance",
        "policy_currency": "AUD"
      },
      "insured": [
        {
          "id": "8de4531a-4f56-4797-8b5b-b451fcbe4e1a",
          "first_name": "d41d8cd98f00b204e9800998ecf8427e",
          "last_name": "d41d8cd98f00b204e9800998ecf8427e",
          "email": "[email protected]",
          "age": 34,
          "birth_date": "1987-02-24"
        }
      ],
      "tax": {
        "total_tax": 24.53,
        "total_amount_without_tax": 430.39,
        "taxes": [
          {
            "tax_amount": 0,
            "tax_code": "ESL",
            "tax_amount_formatted": "A$0.00"
          },
          {
            "tax_amount": 24.53,
            "tax_code": "GST",
            "tax_amount_formatted": "A$24.53"
          },
          {
            "tax_amount": 0,
            "tax_code": "SD",
            "tax_amount_formatted": "A$0.00"
          }
        ],
        "total_tax_formatted": "A$24.53",
        "total_amount_without_tax_formatted": "A$430.39"
      },
      "duration": "29 00:00:00",
      "benefits": [
        {
          "benefit_content_id": "323084c2-c846-41c1-abd4-c42ab9966fbe",
          "description": "Flights",
          "limit": 1650,
          "limit_formatted": "A$1650.00",
          "excess": 0,
          "excess_formatted": "A$0.00"
        },
        {
          "benefit_content_id": "7ca1f290-108e-4a9a-b01a-e5eeca31caa5",
          "description": "Emergency and Accidental Medical Expenses",
          "limit": 2000000,
          "limit_formatted": "A$2000000.00",
          "excess": 75,
          "excess_formatted": "A$75.00"
        },
        {
          "benefit_content_id": "ff5a1288-5120-48ed-a9e8-b8faaa82438d",
          "description": "Personal Liability",
          "limit": 1000000,
          "limit_formatted": "A$1000000.00",
          "excess": 0,
          "excess_formatted": "A$0.00"
        }
      ],
      "commission": {
        "partner_commission": 206.59,
        "surcharge_commission": 0,
        "total_commission": 206.59,
        "partner_commission_formatted": "A$206.59",
        "surcharge_commission_formatted": "A$0.00",
        "total_commission_formatted": "A$206.59"
      },
      "created_at": "2026-01-15T22:22:32.851000Z",
      "confirmed_at": "2026-01-15T22:22:32.900000Z",
      "updated_at": "2026-01-15T22:22:32.900000Z",
      "cancelled_at": null,
      "cancelled_from": null,
      "is_renewable": false,
      "can_be_cancelled": true,
      "pds_url": "https://www.xcover.com/en/pds/CJTE3-PFJF7-INS?policy_type=comprehensive_travel_insurance_v1&quote_id=755100f6-d7a2-4a8f-a8b8-e054c747a375"
    }
  ],
  "coi": {
    "url": "https://www.xcover.com/en/coi/CJTE3-PFJF7-INS?security_token=0rRaJ-WzAoa-oHjBK-14f6M",
    "pdf": "https://www.xcover.com/en/coi/CJTE3-PFJF7-INS.pdf?security_token=0rRaJ-WzAoa-oHjBK-14f6M"
  },
  "account_url": "https://www.xcover.com/en/account?id=e78e37b6-efb5-4574-abcd-d8f8f599a6c1",
  "sign_up_url": "https://www.xcover.com/en/account?id=e78e37b6-efb5-4574-abcd-d8f8f599a6c1",
  "policyholder": {
    "first_name": "d41d8cd98f00b204e9800998ecf8427e",
    "last_name": "d41d8cd98f00b204e9800998ecf8427e",
    "email": "[email protected]",
    "phone": null,
    "address1": "4715 Odie Field",
    "city": "West Paytonstad",
    "region": "TAS",
    "country": "AU",
    "allow_updates": true
  },
  "total_tax": 24.53,
  "total_tax_formatted": "A$24.53",
  "total_premium": 430.39,
  "total_premium_formatted": "A$430.39",
  "fnol_link": "https://www.xcover.com/en/account/claims/fnol?bookingID=CJTE3-PFJF7-INS&security_token=0rRaJ-WzAoa-oHjBK-14f6M",
  "booking_agent": null
}

PreviousCreate Offer NextOpt Out Offer

Last updated 5 months ago

Was this helpful?