UpdateRefund

  • Purpose: Used for suppliers to notify AeroHub of the progress of refunds, including in process, awaiting refund after ticket returned, completed refund, and refusal of refund.
  • Request Method: POST
  • Interface Encryption: No
  • FareMarket Address: /supplier/v1/api/update_refund

Request

Parameter Name Type Required Description
apiKey string ✅ Unique apiKey for each supplier, used to identify the supplier’s identity. Provided by AeroHub to the supplier before interface testing.
requestId string ✅ Unique request ID for each call in the ticket issuance process, 32 characters in length.
refundOrderNo string ✅ AeroHub’s refund order number.
purchaseOrderNo string ✅ AeroHub’s order number.
refundStatus string ✅ Refund order status: QUOTE_COMPLETED: quoted, QUOTE_REJECTED: quote rejected, PROCESSING: refund in process, REFUNDED_PENDING: refund completed pending reimbursement, REFUNDED: reimbursement completed, CLOSED: closed (refund rejected)
rejectReason int ⬜️ Reason for refund rejection: 1 - not yet refundable, 2 - neither voluntary nor involuntary refund allowed, 3 - involuntary refund not allowed, voluntary refund allowed, 4 - refund request period expired, 5 - refund requires passport, passport not provided within the specified time, 6 - refundable amount less than the fee, 7 - passenger has traveled or taken an alternative flight, 8 - ticket already refunded, 9 - passenger card already refunded
refundDate string ⬜️ Date when refund can be requested. If the rejection is due to not reaching the airline’s specified refund time, this field needs to be filled in to inform AeroHub when the request can be made. Format: ISO 8601.
refundableAmount float ⬜️ Must be provided if rejectReason is 6. The refundable amount
flightNumber string ⬜️ Must be provided if rejectReason is 7. Flight number of the flight the passenger has taken or the alternative flight taken
isDocumentation int ⬜️ Is documentation required: 1 - no documentation needed, 2 - documentation needed but not provided
refundAmount array/refundAmount Element ⬜️ Refund amount, must be returned when refund status is: 4 Refund Completed
refundFeePricing array/RefundFeePricing Element ⬜️ Refund pricing information. Must be provided when refund status is QUOTE_ACCEPTED

array/refundAmount Element

Parameter Name Type Required Description
refundCost float ⬜️ Amount refunded by the supplier to AeroHub. Note: This amount’s currency should be consistent with the currency settled between the supplier and AeroHub. This field can be omitted if not refunded.
refundVoucher float ⬜️ Amount of vouchers refunded by the supplier to AeroHub, consistent with the amount refunded by the airline to the supplier. This field can be omitted if not refunded.
voucherCurrency string ⬜️ Currency of the vouchers, consistent with the currency refunded by the airline to the supplier. This field can be omitted if not refunded.
voucherNote string ⬜️ Voucher details such as validity period and usage rules. This field can be omitted if not refunded.

array/refundFeePricing Element

Parameter Name Type Required Description
amount string ⬜️ Total refundable amount
isRefundVoucher int ⬜️ Whether it’s a voucher refund, 0 Yes, 1 No
voucherCurrency string ⬜️ Currency of the voucher, should match the currency returned by the airline to the supplier
refundPolicyDetail object ⬜️ Refund fee details
object/refundPolicyDetail
Parameter Name Type Required Description
ageType int ✅ Passenger type: 0 Adult, 1 Child, 2 Infant
refundFeePolicy float ✅ Fee for this passenger type

Sample Request:


{
  "apiKey": "PcrNq8964iFUkE0CyVV4bhgXXX",
  "requestId": "B2B171eAv8YTQ",
  "refundOrderNo": "FBRF2403112526",
  "purchaseOrderNo": "F1745553257834618888",
  "refundStatus": "REFUNDED",
  "rejectReason": null,
  "refundDate": "2024-04-15T12:00:00Z",
  "refundableAmount": null,
  "flightNumber": null,
  "isDocumentation": 1,
  "documentationNote": "Please provide necessary documentation.",
  "refundAmount": [
    {
      "refundCost": 250.00,
      "refundVoucher": 50.00,
      "voucherCurrency": "USD",
      "voucherNote": "Expired on January 31, 2025, for personal use only."
    }
  ],
  "refundFeePricing": [
    {
      "amount": 300.00,
      "isRefundVoucher": 0,
      "voucherCurrency": "USD",
      "refundPolicyDetail": [
        {
          "ageType": 0,
          "refundFeePolicy": 100.00
        },
        {
          "ageType": 1,
          "refundFeePolicy": 150.00
        },
        {
          "ageType": 2,
          "refundFeePolicy": 50.00
        }
      ]
    }
  ]
}

Response

Parameter Name Type Required Description
code int ✅ AeroHub status code. Refer to Market Errors in the common instructions.
msg string ✅ AeroHub error description. Refer to Market Errors in the common instructions.

Success-Response:

{
    "code": 200,
    "msg": "Successful"
}

Error-Response
`
{
“code”: 400,
“msg”: “Failed”
}

Author：AeroHub  Create time：2024-03-15 09:57
Last editor：AeroHub  Update time：2025-07-29 17:21