Cancellation | ReceiveCancellationNotify

After processing the cancellation, the result notification is sent to the customer.

Notice:
Product Scope ：FareMarket

POST

url that provided by customer

Parameter

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

Request_Example:

{
    "action": "ReceiveCancellationNotify",
    "timestamp": 1633036800,
    "version": "3.2.0",
    "request": {
        "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"
    }
}

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 Aerohub

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

Error-Response

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