Query Refund Status - Atlas API-Sabre

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

refundCode

string

required

The code of the refund transaction received in the refund.do response.

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 | null

optional

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

Examples

Query Refund Status Using orderNoQuery Refund Status Using airlinePNR and carrier

{
    "refundCode": "202505-0013",
    "orderNo": "TESTA20250512100600259",
    "airlinePNR": null,
    "carrier": null,
    "displayCurrency": "EUR"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

refundOrders

array[object (RefundOrder) {16}]

required

orderNo

string

required

Original order number

refundCode

string

required

Refund order number generated for this refund request

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.

expectedConfirmationDate

string

required

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

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

Allowed values:

AccurateQuoteCannotQuote

refundTickets

array[object (RefundTicket) {3}]

required

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

refundFareAmount

optional

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

refundPostTicketingServiceAmounts

array[object (RefundPostTicketingServiceAmount) {6}] | null

optional

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

refundVouchers

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

optional

If refundMethod is Voucher, the refundVouchers field is not null.

serviceFee

object (ServiceFee)

required

Service fee of refund.

refundRules

array[object (RefundRule) {13}]

required

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

refundStatus

enum<integer>

required

The present status of the refund.
The options are:
0: Atlas Processing
1: Airline Processing (Submitted to airline by Atlas)
2: Refunded
3: Airline Refunding
4: Rejected
5: Fullfillment Done
6: Withdrew
If the ticket is paid by deposit: the status can be 0,1,2,3,4
If the ticket is paid by VCC pass through: the status can be 0,1,4,5,6
Withdrew is only in the refund claim

Allowed values:

0123456

cancelReason

string | null

optional

The reason why the refund was cancelled.
The refund reasons are:
Does not match airline policy.
There is no schedule change from the airline side. \nPlease refer the ticket Fare Rules available in ATRIP flight deck for cancellation charges.
Voluntary Cancellation - Non-Refundable
As per airline policy, only voucher refund is available for the ticket
Refund request cancelled by the user
Travel has been completed by the passenger.
Refund not yet received from the airline. Please try again later.
The order is paid by your VCC. please refund by yourself
It's issued via your B2B account, please refund by yourself
Refund is availalbe through airline's B2C website. Please refund by yourself.
The refund claim voucher is invalid.
Duplicate Refund Record
Need to provide more materials that meet airline requirements
Actual refund amount less than service fee. Will reject it.

refundOfferId

string

required

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

refundMethod

string

required

Refund method: CashBackToOriginalPayment or Voucher

status

integer

required

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

msg

string | null

optional

Error message

Examples

Query Refund Status Using orderNoQuery Refund Status Using airlinePNR and carrier

{
    "refundOrders": [
        {
            "orderNo": "TESTA20250512100600259",
            "refundCode": "202505-0013",
            "displayCurrency": "EUR",
            "expectedConfirmationDate": null,
            "expectedRefundDate": null,
            "refundQuoteType": "CannotQuote",
            "refundTickets": [
                {
                    "lastName": "ZHAO",
                    "firstName": "YIER",
                    "ticketNo": "S87579"
                },
                {
                    "lastName": "QIAN",
                    "firstName": "ERER",
                    "ticketNo": "S87579"
                }
            ],
            "refundFareAmount": {
                "currency": "USD",
                "originalFareAmount": 165.48,
                "estimatedRefundAmount": 165.48,
                "displayOriginalFareAmount": 153.46,
                "displayEstimatedRefundAmount": 153.46
            },
            "refundPostTicketingServiceAmounts": [],
            "refundVouchers": null,
            "serviceFee": {
                "currency": "USD",
                "transactionFee": 3,
                "displayTransactionFee": 2.78
            },
            "refundRules": [],
            "refundStatus": 4,
            "cancelReason": "hahaha11111",
            "refundOfferId": "q_6f99d2a1ffc74486be67a98772fa159d",
            "refundMethod": "CashBackToOriginalPayment"
        }
    ],
    "status": 0,
    "msg": null
}