Refund

Refund Quotation

post

Dependency No preceding function needs to be carried out.

Introduction

The Refund section includes a series of steps required for refunds, including requesting a refund quote, submitting the refund, and returning the refund status and results. This service supports the submission of requests for cancellation that require Atlas to process or for refunds that need to be executed by Atlas. It also allows a variety of cancellation and refund types, including voluntary, involuntary and void, etc.

Features

• Refund reason: Voluntary, Involuntary, Void

• Service Level: ◦ Our refund quotations fall into three scenarios: a. We can obtain an accurate quotation from the airline and will quote it directly to you; b. We cannot obtain an accurate quotation through the airline. You can still submit the refund request, then we will process the refund, but the refund amount will be based on the actual amount refunded by the airline; c. Unrefundable ◦ Our refund service includes the below steps, a. Atlas submits the refund request to the airline: We provide a service time guarantee; b. Airline processes the refund request and responds with the result, and airline executes the refund. The duration for 2 steps depends on the airline's processing speed, and we will provide an estimated reference time based on our experience in handling such cases.

Please note the below while initiating a refund transaction.

1. Refund of either inbound or outbound sector: The full ticket needs to be refunded. Only outbound OR inbound sector cannot be refunded. Please contact the airline for the same.

2. Refund for a partially used itinerary: Partially used itinerary cannot be refunded. Please contact the airline for the same.

3. Refund for a specific passenger: We support the refund of a specific passenger in an itinerary. For example, if there are 3 passengers and only one of them is to be refunded, please send us your refund request.

4. Apart from voluntary, involuntary and void, we currently do not support other types of refunds, such as medical or death refunds. Please contact customer service for manual assistance.

5. The customer is responsible to check whether the traveler has already made ancillary purchase in the transaction.

6. No email notifications will be sent for refunds rejected by Atlas.

Endpoint: https://sandbox.atriptech.com/refundQuotation.do

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

application/json

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

statusinteger · enumRequired

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

Possible values:

msgstring · nullableOptional

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.

fastConfirmationinteger · enumRequired

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

Possible values:

expectedConfirmationDatestringRequired

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

Example: 20241217

expectedRefundDatestringRequired

Expected date of getting refund. The format is yyyyMMdd.

refundQuoteTypestring · enumRequired

Type of refund quote:

• AccurateQuote：quotation based on the calculated amount.
• CannotQuote: quotation is unknown and will be according to the airline's rates

Possible values:

refundOfferIdstringRequired

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

refundMethodstring · enumRequired

Refund method: CashBackToOriginalPayment or Voucher.

• CashBackToOriginalPayment: Refund cash back to the original form of payment.
• Voucher: Refund in the form of a voucher.

Possible values:

orderNostringRequired

Original order number

isRefundablebooleanRequired

True : Refundable False: Non-Refundable true or false

post

/refundQuotation.do

HTTPcURLJavaScriptPython

POST /refundQuotation.do HTTP/1.1
Accept: text
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Type: application/json
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

Dependency Refund quotation function should be called in prior of this call

Endpoint: https://sandbox.atriptech.com/refund.do

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

application/json

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

statusinteger · enumRequired

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

Possible values:

msgstring · nullableOptional

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.

displayCurrencystring · nullableOptional

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

fastConfirmationinteger · enumRequired

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

Possible values:

expectedConfirmationDatestringRequired

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

Example: 20241217

expectedRefundDatestringRequired

Expected date of getting refund. The format is yyyyMMdd.

refundQuoteTypestring · enumRequired

Type of refund quote:

• AccurateQuote：quotation based on the calculated amount.
• CannotQuote: quotation is unknown and will be according to the airline's rates

Possible values:

refundOfferIdstringRequired

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

refundMethodstring · enumRequired

Refund method: CashBackToOriginalPayment or Voucher.

• CashBackToOriginalPayment: Refund cash back to the original form of payment.
• Voucher: Refund in the form of a voucher.

Possible values:

orderNostringRequired

Original order number

isRefundablebooleanRequired

True : Refundable False: Non-Refundable true or false

refundStatusintegerRequired

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

refundCodestringRequired

Refund order number generated for this refund request

cancelReasonstring · nullableOptional

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. Please 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.

refundReasonstring · enum · nullableOptional

Refund reason 0: Involuntary 1: Voluntary 4: Void

Possible values:

post

/refund.do

HTTPcURLJavaScriptPython

POST /refund.do HTTP/1.1
Accept: text
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Type: application/json
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

Dependency No preceding function needs to be carried out.

Endpoint: https://sandbox.atriptech.com/queryRefundOrders.do

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

application/json

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

statusintegerRequired

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

msgstring · nullableOptional

Error message

post

/queryRefundOrders.do

HTTPcURLJavaScriptPython

POST /queryRefundOrders.do HTTP/1.1
Accept: text
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Type: application/json
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
}