BookingRefund

  • Purpose: Used to push refund orders to suppliers, including refund application information, itinerary, passenger details, etc.
  • Request Method: POST
  • Interface Encryption: No

Request

Parameter Name Type Required Description
requestId string ✅ Unique request ID for each call during ticketing. 32 characters in length.
refundOrderNo string ✅ AeroHub’s refund order number.
isRefundConfirm int ✅ Confirmation of refund ticket after price verification: 0 Submit refund after price verification (when 0, the refund ticket has been successfully created, and the status of the original refund ticket needs to be updated to the corresponding state in refundStatus), 1 Other submissions
purchaseOrderNo string ✅ AeroHub’s order number.
refundType string ✅ INVOLUNTARY: involuntary, VOLUNTARY: voluntary, Other: other.
refundReason string ✅ Reason for refund: VOLUNTARY_CANCELLATION: voluntary cancellation, VOID_TICKET: void ticket, OTHER: other, FLIGHT_CHANGE: flight change, FLIGHT_CANCEL: flight cancellation, CANCELLATION_DUE_TO_ILLNESS: cancellation due to illness, CANCELLATION_DUE_TO_DEATH: cancellation due to death.
refundNote string ⬜️ Remarks for the refund.
refundStatus string ✅ Refund order status: PENDING_QUOTE: pending quote, PENDING: pending refund, WITHDRAWN: withdrawn
isDocumentationRequired int ✅ Is documentation required: 1 - no documentation required, 3 - documentation provided
documentation array/documentation Element ⬜️ URL to obtain proof documents, such as ID photos, hospital certificates, etc.
refundFee float ✅ Refund service fee paid by AeroHub to the supplier.
passengers array/passenger Element ✅ Passenger information.
segments array/segments Element ✅ Itinerary information.

array/passenger Element

Parameter Name Type Required Description
passengerNo int ✅ Passenger’s sequence number, starting from 0.
name string ✅ Passenger’s name, with the last name and first name separated by a slash (/), LastName/FirstName MiddleName.
birthday string ✅ Date of birth, format: YYYYMMDD.
cardNo string ✅ ID card number, maximum of 15 characters.

array/segments Element

Parameter Name Type Required Description
segmentNo int ✅ Sequence of the segment: 1 for outbound, 2 for return.
sequence int ✅ Segment sequence within the itinerary, starting from 1. Note: For round-trip, both segments start from 1.
flightNumber string ✅ Flight number, e.g., CA123.
depAirport string ✅ Departure airport code, using IATA three-letter code as the standard.
arrAirport string ✅ Arrival airport code, using IATA three-letter code as the standard.

array/documentation Element

Parameter Name Type Required Description
url string ⬜ URL to obtain proof documents, such as ID photos, hospital certificates, etc.

Sample Request


{
    "requestId": "PcrNq8964iFUkE0CyVV4bhgXXX",
    "refundOrderNo": "FBRF2403112526",
    "isRefundConfirm": 0,
    "purchaseOrderNo": "F1745527321051406356",
    "refundType": 1,
    "refundReason": "VOLUNTARY_CANCELLATION",
    "refundNote": "Passenger decided to cancel the trip.",
    "refundStatus": "PENDING_QUOTE",
    "isDocumentationRequired": 1,
    "documentation":[
          {
            "url": "https://cdn.aerohub.com/upload/2024031218/998a7d64775f9bfe6ffdf7c3583b26aa1.png"
        },
        {
            "url": "https://cdn.aerohub.com/upload/2024031218/5f43518a76129749e8830960379ed2716.pdf"
        }],
    "refundFee": 50.00,
    "passengers": [
        {
        "passengerNo": 0,
        "name": "Doe/John",
        "birthday": "19900101",
        "cardNo": "ABC123456789"
        },
        {
        "passengerNo": 1,
        "name": "Doe/Jane",
        "birthday": "19910101",
        "cardNo": "XYZ987654321"
        }
        ],
    "segments": [
        {
        "segmentNo": 1,
        "sequence": 1,
        "flightNumber": "CA123",
        "depAirport": "PEK",
      "arrAirport": "SFO"
      }
    ]
}

Response

Parameter Name Type Required Description
marketErrorCode int ✅ Error code from the supplier’s system, used to assist AeroHub and the supplier in troubleshooting. Should be returned truthfully to indicate the actual error.
marketErrorMsg string ✅ Description of the error from the supplier’s system. Should be returned truthfully and be less than 300 characters.

Success-Response:

{
    "marketErrorCode": 200,
    "marketErrorMsg": "Successful"
}
Author：AeroHub  Create time：2024-03-15 09:57
Last editor：AeroHub  Update time：2025-07-29 17:21