RefundEstimate
Modified on: 2026-05-21 17:42
TABLE OF CONTENTS
The RefundEstimate interface is used to retrieve an estimated refund amount for a ticketed order before formally submitting the refund request. This allows sellers to inform customers of the expected refund amount based on the airline's refund policies and applicable fees.
| Version | Date | Description of Edit |
|---|---|---|
| V1.0 | 2026/04/23 | Initial Commit |
| Request Details | ||
|---|---|---|
| Path | v1.0 | /api/flight/connectivity/order/refundEstimate |
Request Payload Example
{
"order": {
"supplierOrderId": "BKOCXCB",
"gdnOrderId": "10001202605150305010000015180544"
},
"refund": {
"refundReason": 9,
"refundType": 1,
"refundRequest": {
"paxList": [
{
"paxIndex": "1"
}
],
"refundTrip": {
"journeySequences": [
1
]
}
},
"refundTo": "originalFop"
}
}'Request Payload Structure
| Key | Parent | Type | Mandatory/ Optional | Description |
|---|---|---|---|---|
| order | root | Object | M | |
| supplierOrderId | order | String | M | |
| gdnOrderId | order | String | O | |
| refund | root | Object | M | Container for refund requests |
| refundReason | refund | Integer | M | Type of refund reasons: 0: personal reason 1: illness reason 2: schedule change reason 3: visa refusal 4: double payment 5: duplicate booking 6: korea voluntary cancellation 7: indonesia domestic voluntary cancellation 8: united states voluntary cancellation 9: flight cancellation 10: deceased guest Note: for the specific refund reasons supported by each airline, please refer to the 'Refund' section in the Order Servicing Process part. |
| refundType | refund | Integer | M | Type of refund: 0 = Voluntary, 1 = Involuntary |
| refundRequest | refund | Object | M | |
| paxList | refundRequest | Array | M | |
| paxIndex | paxList | String | M | Passengers who you want to refund |
| refundTrip | refundRequest | Object | M | Trip details for refund. |
| journeySequences | refundTrip | Array | M | Journey sequences to refund 1: outbound trip 2: inbound trip |
| refundTo | refund | String | M | Specifies the destination method for the refund. This field indicates how the refund amount should be returned to the seller. The available refund methods are strictly dependent on the supplier's or airline's supported refund options. The value provided in this field must be one of the specific methods supported by the relevant carrier for this particular ticket and fare type. originalFop Voucher points |
| pointsRecipient | refund | Object | O | Container for loyalty program recipient information. This node is only required when refundTo is set to points |
| paxIndex | pointsRecipient | String | M | |
| loyaltyProgramAccount | paxList | Object | O | |
| accountNumber | loyaltyProgramAccount | String | O | |
| carrier | loyaltyProgramAccount | String | O | |
| programName | loyaltyProgramAccount | String | O | |
| programCode | loyaltyProgramAccount | String | O | |
| refundRemark | refund | String | O | Additional comments or notes for the refund |
| documentId | refund | Array | O | Associates supporting documents with the request, field available, but upload interface not yet released |
| duplicatedWith | refund | String | O | References the original booking PNR for duplicate case |
Response
Key | Parent | Type | Mandatory/Optional | Description |
refundEstimationInfo | root | Object | O | |
totalPrice | refundEstimationInfo | Number | M | The original total price of the booking |
totalEstimateAmount | refundEstimationInfo | Number | M | The estimated refundable amount after deductions and fees |
isRefundable | refundEstimationInfo | Boolean | M | Indicates whether the booking is eligible for refund |
currency | refundEstimationInfo | String | M | Currency code |
refundEstimationId | refundEstimationInfo | String | M | Unique identifier for this refund estimation. This ID can be referenced in subsequent orderChange requests for refund processing |
refundEstimatetExpirationDateTime | root | String | O | Validity period (in minutes) of this refund estimate. After this period, a new estimate should be requested |
Did you find it helpful? Yes No
Send feedback