Cancel booking

The Cancel Booking API endpoint allows partners to cancel bookings associated with their partner account. This endpoint requires a valid access token obtained from the Authentication.

DELETE /api/partners/{partner_id}/bookings/{booking_id}

This endpoint supports the cancellation of individual bookings identified by their unique booking ID. Partners can provide optional information about the policies related to the booking being cancelled, including reasons for cancellation.

Path parameters

Parameter
Type
Description

partner_id

string

The partner identifier provided during onboarding

booking_id

string

Unique identifier of the booking. Available from the create booking API response.

Headers

Name
Value

Accept

application/json

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

reason

string, optional

The reason for cancellation

policies

array, optional

Array of policies included in the booking. Required only when you need to cancel individual policies.

policies[id]

string

Unique identifier of the policy

policies[reason]

string

Reason for the policy cancellation

preview

boolean, optional

Optional field to enable the preview mode. Default: false

{
    "reason": "The ticket has been transferred to another owner.",
    "policies": [
        {
            "id": "{policy_id}",
            "reason": "The ticket has been transferred to another owner."
        }
    ],
    "preview": false
}

Response

{
    "data": {
        "provider_reference": "WXT34-MZ34Q-INS",
        "language": "en",
        "provider_customer_id": null,
        "status": "Cancelled",
        "currency": "AUD",
        "price": 5.39,
        "security_token": "HTWhU-gDbG8-w5nRl-meRnQ",
        "created_at": "2024-03-06T23:49:53.000000Z",
        "updated_at": "2024-03-06T23:50:27.000000Z",
        "is_instant_booking": false,
        "policies": [
            {
                "status": "Cancelled",
                "policy_start_date": "2024-03-06T00:00:00.000000Z",
                "policy_end_date": "2024-04-05T00: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/WXT34-MZ34Q-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/WXT34-MZ34Q-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-06T23:49:53.000000Z",
                "cancelled_at": "2024-03-06T23:50:27.000000Z",
                "created_at": "2024-03-06T23:49:53.000000Z",
                "updated_at": "2024-03-06T23:50:27.000000Z",
                "id": "3128539b-d5fb-4b76-b89d-2976fc0f1e28"
            }
        ],
        "cancellations": [
            {
                "provider_reference": "Ew0pR-hEyKD-YbXPc-CCL",
                "created_at": "2024-04-28T10:50:16.000000Z",
                "updated_at": "2024-04-28T10:50:16.000000Z",
                "confirmed_at": null,
                "deleted_at": null,
                "id": "667b4408-191f-42d2-8582-00fe11930831",
                "total_refund": 5.39,
                "total_refund_formatted": "A$5.39",
                "policies": [
                    {
                        "id": "3128539b-d5fb-4b76-b89d-2976fc0f1e28",
                        "refund_value": 5.39,
                        "adjustment_fee": 0
                    }
                ]
            }
        ],
        "id": "4f6491a9-2cff-47cf-8b67-a053a701f0b2"
    }
}

Preview Mode

The Booking Cancellation API supports a preview mode feature to allow partners to preview the result of a cancellation request without actually cancelling the booking. Partners can enable this feature by including an additional boolean field preview in the request body.

The preview mode allows partners to assess the potential outcome of the cancellation before making any permanent changes. To confirm cancellation using a preview, please see Confirm cancellation preview.

PreviousAccommodation cancelationNextConfirm cancellation preview

Last updated