Cancellation | ConfirmCancellation

Confirm whether the cancellation result is accepted. On the condition that the applyType parameter is set to QUOTATION, the SubmitCancellation API call is successful, and the cancellationStatus in the result retrieved from the GetCancellationDetail API is VALID_QUOTE.

Notice:
Product Scope :FareMarket

POST

/flight/cancellation

Parameter

Field Mandatory Type Scope Description
action required String ConfirmCancellation
key required String API security key applied from AeroHub
signature required String Refer to Guideline to generate.
timestamp required Int The ‘timestamp’ field should be a 10-digit Unix timestamp in seconds, used for encryption and data verification.
version optional String API version information, e.g. 3.2.0
request required Object
  cancellationNum required String Cancellation number generated by SubmitCancellation

Request_Example:

{
  "action": "ConfirmCancellation",
  "key": "mkk5VmNZYKiGEO26",
  "signature": "uaQb6MG71EAPTdmUoKpP+mlSh//2GRB8zOxCAzWok2w=",
  "timestamp": "1685116516",
  "request": {
    "cancellationNum": "R20240409152629973"
  }
}

Response

Field Type Description
status Int 0 for success, others for failure, refer to status error appendix for details
msg String Return message, maximum 64 char
cancellationNum String Cancellation number generated by SubmitCancellation

Success-Response:

{
  "status": 0,
  "msg": "Success",
  "cancellationNum": "R20240409152629973"
}

Status Code

Name Description
1000 General system error
1001 Request parameters or part of parameters missing
1002 Invalid Action
1003 API request timeout, please request again
1004 Invalid request parameter
1005 Service system error
1101 Authentication fail, wrong signature
1102 Account disabled, please contact with account administrator
3201 The cancellation id does not exist
3202 The current status does not allow submit
3203 Cancellation ID {refund_id} refund has been submitted, please do not reapply

Error-Response

{
    "status": 1000,
    "msg": "General system error"
}
Author:AeroHub  Create time:2024-05-10 18:44
Last editor:AeroHub  Update time:2024-09-10 16:26