Refund Quotation

POST

/refundQuotation.do

Refund Quotation

Request

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Accept-Encoding

string

required

Default:

gzip

x-atlas-client-id

string

required

Default:

<YOUR_CLIENT_ID>

x-atlas-client-secret

string

required

Default:

<YOUR_CLIENT_SECRET>

Body Params application/json

orderNo

string | null

required

Atlas original order number. You can choose to request either orderNo or both airlinePNR and carrier. If you use orderNo, the airlinePNR and carrier fields may be null.

airlinePNR

string | null

required

The record locator of the airline. You can choose to request either orderNo or both airlinePNR and carrier. If you use airlinePNR and carrier, the orderNo field may be null.

carrier

string | null

required

2 character IATA airline code. you can choose to request either orderNo or both airlinePNR and carrier. If you use airlinePNR and carrier, the orderNo field may be null.

displayCurrency

string

optional

The alternative currency in which the fare and taxes amount needs to be displayed. The 3-letter currency code should be entered.

refundRequestList

array[object (RefundPaxSegments) {4}]

required

lastName

string

required

Last name of the passenger requesting a refund.

firstName

string

required

First name of the passenger requesting a refund.

segments

array[object (RefundSegment) {4}]

required

refundReason

enum<string>

required

Code representing the reason for the refund request.

Allowed values:

014

Examples

Refund Quotation Using orderNoVoluntary Refund Quotation Using airlinePNR and carrierInvoluntary Refund Quotation Using airlinePNR and carrier

{
    "orderNo": "TESTA20250512100600259",
    "airlinePNR": null,
    "carrier": null,
    "displayCurrency": "EUR",
    "refundRequestList": [
        {
            "lastName": "ZHAO",
            "firstName": "YIER",
            "segments": [
                {
                    "depDate": "20250513",
                    "flightNo": "U22437",
                    "depAirport": "LTN",
                    "arrAirport": "CDG"
                }
            ],
            "refundReason": "1"
        },
        {
            "lastName": "QIAN",
            "firstName": "ERER",
            "segments": [
                {
                    "depDate": "20250513",
                    "flightNo": "U22437",
                    "depAirport": "LTN",
                    "arrAirport": "CDG"
                }
            ],
            "refundReason": "1"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Refund Quotation Using orderNoVoluntary Refund Quotation Using airlinePNR and carrierInvoluntary Refund Quotation Using airlinePNR and carrier

curl --location --request POST 'https://sandbox.atriptech.com/refundQuotation.do' \
--header 'Accept;' \
--header 'Accept-Encoding;' \
--header 'x-atlas-client-id;' \
--header 'x-atlas-client-secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderNo": "TESTA20250512100600259",
    "airlinePNR": null,
    "carrier": null,
    "displayCurrency": "EUR",
    "refundRequestList": [
        {
            "lastName": "ZHAO",
            "firstName": "YIER",
            "segments": [
                {
                    "depDate": "20250513",
                    "flightNo": "U22437",
                    "depAirport": "LTN",
                    "arrAirport": "CDG"
                }
            ],
            "refundReason": "1"
        },
        {
            "lastName": "QIAN",
            "firstName": "ERER",
            "segments": [
                {
                    "depDate": "20250513",
                    "flightNo": "U22437",
                    "depAirport": "LTN",
                    "arrAirport": "CDG"
                }
            ],
            "refundReason": "1"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

status

enum<integer>

required

Status code. 0 for Success, 2 for System error.

Allowed values:

msg

string | null

optional

Error message
The ‘msg’ element is for description of the results. Please do not use this field to check the success or failure of the request. Only use the ‘status’ code to check the result.

displayCurrency

string | null

optional

The alternative currency in which the fare and taxes amount needs to be displayed. The 3-letter currency code should be entered.

fastConfirmation

enum<integer>

required

Fast confirmation depends on whether the airline supports auto fulfillment.
0 for False, 1 for True.

Allowed values:

expectedConfirmationDate

string

required

Expected date of getting airline refund confirmation. The format is yyyyMMdd.

Example:

20241217

expectedRefundDate

string

required

Expected date of getting refund. The format is yyyyMMdd.

refundQuoteType

enum<string>

required

Type of refund quote:
AccurateQuote：quotation based on the calculated amount.
CannotQuote: quotation is unknown and will be according to the airline's rates
NonRefundable: the ticket is non refundable

Allowed values:

AccurateQuoteCannotQuote

refundOfferId

string

required

Refund offer id for this quotation which can be used for the coming refund call.

refundMethod

enum<string>

required

Refund method: CashBackToOriginalPayment or Voucher

Allowed values:

CashBackToOriginalPaymentVoucher

refundTickets

array[object (RefundTicket) {3}]

required

The refund calculation for each of the passengers whose refund quote has been requested

lastName

string

required

Last name of the passenger who wants to refund.

firstName

string

required

First name of the passenger who wants to refund.

ticketNo

string

required

The PNR received from the airline in the retrieve PNR response.

refundFareAmount

optional

If refundMethod is CashBackToOriginalPayment, the refundFareAmount field is not null.

Any of

RefundFareAmount

null

currency

string

required

The refund calculation for flight fare and inflow ancillaries.
3-letter ISO currency code.

originalFareAmount

number

required

Original fare of the flight.

estimatedRefundAmount

number

required

Estimated amount which can be got back for this refund of flight.

displayOriginalFareAmount

number | null

optional

Original Fare Amount in display currency.

displayEstimatedRefundAmount

number | null

optional

EstimatedRefundAmount in display currency.

refundPostTicketingServiceAmounts

optional

The refund calculation for Post-ticketing Servrice, including baggage etc. Each post-ticketing order will be present as an object.

Any of

RefundPostTicketingServiceAmount

null

The refund calculation for Post-ticketing Servrice, including baggage

postTicketingOrderNo

string

required

Unique order number for the post-ticketing service.

currency

string

required

Currency used for post-ticketing service calculations.
3-letter ISO currency code.

originalPostTicketingServiceAmount

number

required

The original amount charged for the post-ticketing service.

estimatedRefundAmount

number

required

Estimated amount which can be got back for this refund of Ancillaries.

displayPostTicketingServiceAmount

number | null

optional

The original post-ticketing service amount in the display currency.

displayEstimatedRefundAmount

number | null

optional

The estimated refund amount displayed in the display currency.

refundVouchers

array[object (RefundVoucher) {11}] | null

optional

If refundMethod is Voucher, the refundVouchers is not null.

voucherId

string | null

optional

A unique identifier of Atlas used to distinguish different vouchers.

voucherCode

string | null

optional

The voucherCode airline returned.

eligiblePassengers

array [object {1}]

optional

The passenger information eligible to use this voucher.

airline

string | null

optional

The airline from which the voucher originates.

estimatedRefundAmount

number

required

The amount value of the voucher.

currency

string

required

The currency type of the voucher.

voucherStartDate

string | null

optional

The date on which the voucher can begin to be used. Defaults to the date when the refund status is set to "Refunded". The format is yyyyMMdd.

voucherEndDate

string | null

optional

The expiry date of the voucher. The format is yyyyMMdd.

travelStartDate

string | null

optional

The actual travel start date. The format is yyyyMMdd.

travelEndDate

string | null

optional

The actual travel end date. The format is yyyyMMdd.

note

string | null

optional

A brief description or usage rule explanation for the voucher.

serviceFee

object (ServiceFee)

required

Service fee of refund.

currency

string

required

Currency used for the service fee.
3-letter ISO currency code.

transactionFee

number

required

Transaction Fee of refund.

displayTransactionFee

number | null

optional

TransactionFee in display currency.

refundRules

array[object (RefundRule) {13}]

optional

The refund rules for the fare whose refund quote has been requested.

airline

string

required

Airline code for which the refund rule applies.
2-letter IATA airline code.

ruleType

enum<string>

required

Rule type.
0: Involuntary Refund
1: Voluntary Refund
2: Tax Refund
3: Special Refund
4: Void Refund

Allowed values:

01234

passengerType

enum<string>

optional

Passenger type for which the refund rule applies.
Can be ADT (Adult), CHD (Child), INF (Infant).

Allowed values:

ADTCHDINF

penaltyAmount

string

optional

The penalty amount charged for the refund.
Monetary value with currency code.

penaltyPercent

number

optional

The percentage of the fare charged as penalty.

penaltyPercentBase

enum<string>

optional

The calculation on which the penalty percentage is based.
Can be fare, fare+tax.

Allowed values:

farefare+tax

airlineFee

string

optional

Additional airline fee for processing the refund.
Monetary value with currency code.

taxRefundable

boolean

optional

Indicates whether the tax is refundable is available.
true or false

fareRefundable

boolean

optional

Indicates whether the ticket is refundable.
true or false.

refundableAncillaries

array[string]

optional

List of refundable ancillary services, if any.

Allowed values:

StandardCheckInBaggageCabinBaggageCabinBaggageUnderSeatCabinBaggageOverheadLocker

startMinute

integer

optional

Starting time of rule application.
Positive numbers represent XXX minutes before departure.
Negative numbers represent XXX minutes after departure.

endMinute

integer

optional

Ending time of rule application.
Positive numbers represent XXX minutes before departure.
Negative numbers represent XXX minutes after departure.

refundMethod

enum<string>

optional

Refund method:
CashBackToOriginalPayment or Voucher

Allowed values:

CashBackToOriginalPaymentVoucher

orderNo

string

required

Original order number

isRefundable

boolean

required

True : Refundable False: Non-Refundable
true or false

Examples

Voluntary Refund QuotationInvoluntary Refund Quotation

{
    "displayCurrency": "EUR",
    "fastConfirmation": 0,
    "expectedConfirmationDate": "20250522",
    "expectedRefundDate": "20250701",
    "refundQuoteType": "CannotQuote",
    "refundOfferId": "q_b893711fcfae4e9d949e9965576bfd3a",
    "refundMethod": "CashBackToOriginalPayment",
    "isRefundable": false,
    "refundTickets": [
        {
            "name": "QIAN/ERER",
            "lastName": "QIAN",
            "firstName": "ERER",
            "ticketNo": "S87579"
        },
        {
            "name": "ZHAO/YIER",
            "lastName": "ZHAO",
            "firstName": "YIER",
            "ticketNo": "S87579"
        }
    ],
    "refundFareAmount": {
        "currency": "USD",
        "originalFareAmount": 165.48,
        "estimatedRefundAmount": 0,
        "displayOriginalFareAmount": 153.46,
        "displayEstimatedRefundAmount": 0
    },
    "refundPostTicketingServiceAmounts": [],
    "refundVouchers": null,
    "serviceFee": {
        "currency": "USD",
        "transactionFee": 2,
        "displayTransactionFee": 1.85
    },
    "refundRules": [
        {
            "airline": "U2",
            "ruleType": "1",
            "passengerType": null,
            "penaltyAmount": null,
            "penaltyPercent": null,
            "penaltyPercentBase": null,
            "airlineFee": null,
            "taxRefundable": false,
            "fareRefundable": false,
            "refundableAncillaries": null,
            "startMinute": 525600,
            "endMinute": -525600,
            "refundMethod": "CashBackToOriginalPayment"
        }
    ],
    "orderNo": "TESTA20250512100600259",
    "status": 0,
    "msg": null
}

Modified at 2025-07-18 06:59:28

Incident List

Make a Refund