Refund

Refund Quotation

post

Refund Quotation

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredDefault: gzipExample: gzip

x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>

Body

orderNostring | nullableRequired

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.

airlinePNRstring | nullableRequired

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.

carrierstring | nullableRequired

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.

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /refundQuotation.do HTTP/1.1
Host: 
Accept: text
Content-Type: application/json
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Length: 419

{
  "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"
    }
  ]
}

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

200Success

{
  "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
}

Make a Refund

post

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredDefault: gzipExample: gzip

x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>

Body

orderNostring | nullableRequired

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.

airlinePNRstring | nullableRequired

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.

carrierstring | nullableRequired

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.

displayCurrencystring | nullableOptional

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

refundOfferIdstring | nullableRequired

Get this from the refund quotation response. You can request with refundOfferId or refundRequestList. If you use refundRequestList, the field refundOfferId is null.

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /refund.do HTTP/1.1
Host: 
Accept: text
Content-Type: application/json
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Length: 171

{
  "orderNo": "TESTA20240725164512131",
  "airlinePNR": null,
  "carrier": null,
  "displayCurrency": "EUR",
  "refundOfferId": "q_a86cd9c605c04f9cb3890ca3b037b254",
  "refundRequestList": null
}

Involuntary Refund Apply Using orderNo with refundOfferIdInvoluntary Refund Apply Using airlinePNR and carrier with refundOfferIdInvoluntary Refund Apply Using airlinePNR and carrier without refundOfferId

200Success

{
  "refundStatus": 0,
  "refundCode": "202505-0012",
  "cancelReason": "",
  "refundReason": "0",
  "displayCurrency": "EUR",
  "fastConfirmation": null,
  "expectedConfirmationDate": "20250522",
  "expectedRefundDate": "20250701",
  "refundQuoteType": "CannotQuote",
  "refundOfferId": "q_a86cd9c605c04f9cb3890ca3b037b254",
  "refundMethod": "CashBackToOriginalPayment",
  "isRefundable": true,
  "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": [
    {
      "airline": "U2",
      "ruleType": "0",
      "passengerType": null,
      "penaltyAmount": "0.00 USD",
      "penaltyPercent": 0,
      "penaltyPercentBase": "fare+tax",
      "airlineFee": "0.00 USD",
      "taxRefundable": true,
      "fareRefundable": true,
      "refundableAncillaries": [
        "ALL"
      ],
      "startMinute": 525600,
      "endMinute": -525600,
      "refundMethod": "CashBackToOriginalPayment"
    }
  ],
  "orderNo": "TESTA20250512100600259",
  "status": 0,
  "msg": null
}

Query Refund Status

post

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredDefault: gzipExample: gzip

x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>

Body

refundCodestringRequired

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

orderNostring | nullableRequired

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.

airlinePNRstring | nullableRequired

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.

carrierstring | nullableRequired

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.

displayCurrencystring | nullableOptional

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

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /queryRefundOrders.do HTTP/1.1
Host: 
Accept: text
Content-Type: application/json
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Length: 120

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

Query Refund Status Using orderNoQuery Refund Status Using airlinePNR and carrier

200Success

{
  "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
}