Cancellation Status API

The Cancellation Status API allows you to check the current status of a flight cancellation request. This endpoint helps you track whether your cancellation request has been processed, is pending, or requires further action.

API Endpoint

POST /flight/cancellation_status

Request Structure

The API requires the following parameters in the request body:

{
    "request_id": "320073",
    "client_referenceId": "WQGH376271"
}

Request Parameters

Parameter	Type	Required	Description
`request_id`	String	Yes	The unique identifier for the cancellation request. This ID is returned when you initiate a cancellation request.
`client_referenceId`	String	Yes	Your unique client reference ID used to track the transaction on your end.

Response Structure

Upon successful execution, the API returns the following response:

{
    "status": "SUCCESS",
    "status_code": "200",
    "message": "Cancellation Status retrieved successfully.",
    "data": {
        "trace_id": "ef55669b-a8ab-4771-b057-94ac9b7452a8",
        "result": {
            "request_id": 320073,
            "ticket_id": 2263870,
            "request_status": "Unassigned"
        }
    }
}

Response Parameters

Parameter	Type	Description
`status`	String	Overall status of the API call (`SUCCESS` or `FAILED`)
`status_code`	String	HTTP status code of the response
`message`	String	Descriptive message about the API response
`data`	Object	Contains the main response data
`data.trace_id`	String	Unique trace identifier for tracking purposes
`data.result`	Object	Contains the cancellation request details
`data.result.request_id`	Integer	The cancellation request ID
`data.result.ticket_id`	Integer	The associated ticket ID for the booking
`data.result.request_status`	String	Current status of the cancellation request

Request Status Values

The request_status field can have the following values:

Unassigned: The cancellation request has been received but not yet assigned for processing
In Progress: The cancellation request is currently being processed
Completed: The cancellation has been successfully processed
Failed: The cancellation request could not be processed
Cancelled: The cancellation request itself has been cancelled

Usage Notes

Use this API to periodically check the status of your cancellation requests
The request_id is essential for tracking and should be stored after initiating a cancellation
Response times may vary depending on airline processing times
Consider implementing appropriate retry logic with reasonable delays between status checks

Error Handling

If the API encounters an error, it will return appropriate error codes and messages. Common scenarios include:

Invalid request_id
Request not found
System unavailable

Always check the status field in the response to determine if the API call was successful before processing the data.