Cancellation | GetCancellationDetail

Query cancellation details

Notice:
Product Scope ：FareMarket

POST

/flight/cancellation

Parameter

Field Mandatory Type Scope Description
action required String GetCancellationDetail
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": "GetCancellationDetail",
  "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
cancellationCategory String For more details visit: Cancellation Category
cancellationStatus String For more details visit: Cancellation Status
endTime String The time when the operation is completed, the review completion time/cancellation success time/cancellation rejection time, format: YYYYMMDDHHMMSS
uneligibleDetail String the detail of the uneligible cancellation
currency String currency for refund
amount Float total cost for booking
refundAmount Float refund amount from airline
serviceFee Float service charge from Aerohub
refundCategory String For more details visit: Refund Category
creditVoucher Object[] the credit voucher
  currency String the currency of credit voucher
  amount Float Amount of credit voucher
  detail String Credit voucher details（No.，Introduction to use, etc.）
passengers Object[] Ticket Information for Cancellation
  firstName String FirstName，in case of middle name, format is firstName middleName
  lastName String LastName
  birthday String Birthday, format: YYYYMMDD
  pnr String pnr from airline
  ticketNumber String Ticket Number from airline
  amount Float Order payment amount
  refundAmount Float refund amount from airline
  serviceFee Float service charge from Aerohub
customerRemark String Customer remarks
aeroHubRemark String AeroHub Remarks

Success-Response:

{
    "status": 0,
    "msg": "success",
    "cancellationNum": "R20240409152629973",
    "cancellationCategory": "VOLUNTARY_CANCELLATION",
    "cancellationStatus": "REFUNDED",
    "endTime": "20240101123045",
    "uneligibleDetail": "the detail of the unapproved cancellation",
    "currency": "USD",
    "amount": 500.0,
    "refundAmount": 494.0,
    "serviceFee": 6.0,
    "refundCategory": "ORIGINAL_PAYMENT",
    "creditVoucher": [{
        "currency": "USD",
        "amount": 100.0,
        "detail": "Voucher No.12345, valid for 1 year"
    }],
    "passengers": [
        {
            "firstName": "John",
            "lastName": "Doe",
            "birthday": "19900101",
            "pnr": "ABC123",
            "ticketNumber": "1234567890",
            "amount": 250.0,
            "refundAmount": 247.0,
            "serviceFee": 3.0
        },
        {
            "firstName": "Jane",
            "lastName": "Smith",
            "birthday": "19850515",
            "pnr": "XYZ456",
            "ticketNumber": "0987654321",
            "amount": 250.0,
            "refundAmount": 247.0,
            "serviceFee": 3.0
        }
    ],
    "customerRemark": "Requesting full refund due to cancellation",
    "aeroHubRemark": "Processed as per customer request"
}

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
3201 The cancellation id does not exist

Error-Response

{
    "status": 1000,
    "msg": "General system error"
}
Author：AeroHub  Create time：2024-01-25 14:13
Last editor：AeroHub  Update time：2024-09-10 17:16