Confirm cancellation preview

The Confirm Cancellation Preview API allows partners to confirm the booking cancellation preview. This endpoint requires a valid access token obtained from the Authentication.

POST /api/partners/{partner_id}/bookings/{booking_id}/cancellations/{cancellation_id}

This endpoint supports the cancellation of individual bookings identified by the Booking Cancellation ID returned in thePreview Mode. Partners can provide optional reason of cancellation in the request body.

Path parameters

Parameter	Type	Description
partner_id	string	The partner identifier provided during onboarding
booking_id	string	Unique identifier of the booking to be cancelled
cancellation_id	string	Unique identifier of the cancellation object returned in the preview mode. data.cancellations[#].id

Headers

Name	Value
Accept	application/json
Content-Type	application/json
Authorization	Bearer <token>

Body

The request body of this endpoint is optional.

Name	Type	Description
reason	string	Reason for the booking cancellation

{
    "reason": "The ticket has been transferred to another owner."
}

Response

🟢 200

{
    "data": {
        "provider_reference": "EYYLD-F8LDV-INS",
        "language": "en",
        "provider_customer_id": null,
        "status": "Cancelled",
        "currency": "AUD",
        "price": 5.39,
        "security_token": "dXX3S-UglSd-ca604-swAO5",
        "created_at": "2024-03-13T09:24:44.000000Z",
        "updated_at": "2024-03-13T09:32:11.000000Z",
        "is_instant_booking": false,
        "policies": [
            {
                "status": "Cancelled",
                "policy_start_date": "2024-03-13T00:00:00.000000Z",
                "policy_end_date": "2024-04-12T00:00:00.000000Z",
                "price": 5.39,
                "tax": 0.49,
                "commission": 2.33,
                "cover_amount": null,
                "policy_type": "event_ticket_protection",
                "policy_code": "MECMTX01",
                "policy_version": "54a53de2-6da9-4f17-b9d0-f5f1f86c47b1",
                "policy_content": {
                    "title": "Missed Event Protection",
                    "header": null,
                    "description": "Ticket Protection",
                    "optout_msg": "",
                    "inclusions": [],
                    "exclusions": [],
                    "disclaimer": "By clicking the button you confirm that you have read and agreed to the Terms and Conditions. The Missed Event Protection plan is a service provided by XCover.com, a trading name of Booking Protect Ltd.",
                    "disclaimer_html": "<p data-block-key=\"qbt5v\">By clicking the button you confirm that you have read and agreed to the <a href=\"https://www.xcover.com/en/pds/EYYLD-F8LDV-INS?policy_type=event_ticket_protection_v3\" rel=\"noopener noreferrer\" target=\"_blank\">Terms and Conditions</a>. The Missed Event Protection plan is a service provided by XCover.com, a trading name of Booking Protect Ltd.</p>",
                    "payment_disclaimer": "",
                    "in_path_disclaimer": ""
                },
                "claim_selector_id": "a3cee99c-079a-44ff-a555-546223ad2863",
                "pds_url": "https://www.xcover.com/en/pds/EYYLD-F8LDV-INS?policy_type=event_ticket_protection_v3",
                "extra_fields": {
                    "retail_premium": "5.389999999999999930055949449",
                    "uw_fee": "1.259999999999999904798375638",
                    "get_tickets": [
                        {
                            "type": "Second Release",
                            "price": 35,
                            "scanned_at": null
                        },
                        {
                            "type": "Second Release",
                            "price": 35,
                            "scanned_at": null
                        }
                    ],
                    "cg_revenue": "1.310000000000000095201624362"
                },
                "confirmed_at": "2024-03-13T09:24:44.000000Z",
                "cancelled_at": "2024-03-13T09:32:11.000000Z",
                "created_at": "2024-03-13T09:24:44.000000Z",
                "updated_at": "2024-03-13T09:32:11.000000Z",
                "id": "7f5a55a7-9fa3-44a2-8fe8-9874de793751"
            }
        ],
        "cancellations": [
            {
                "provider_reference": "TrAvB-FgcWo-T8XxQ-CCL",
                "created_at": "2024-03-13T09:31:42.000000Z",
                "updated_at": "2024-03-13T09:32:11.000000Z",
                "confirmed_at": "2024-03-13T09:32:11.000000Z",
                "id": "71e75ee4-c408-42ac-9344-d19274929647"
            }
        ],
        "id": "7e108cab-57b1-40c7-a172-c3c4d06c6ced"
    }
}

🔴 401

{
    "message": "Unauthenticated."
}

🔴 404

{
    "message": "BookingCancellation not found."
}

🔴 422

{
    "message": "The request is invalid."
}