Sign in

v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
GDS Exchanges

Document Refund Quote

Send one or more ticket numbers for a Refund Quote to determine what, if any, refund value may be available on the ticket(s). You can send multiple tickets only if all tickets sent in the request belong to the same PNR and use the same filed fare. The response includes a detailed refund quote with refundable amounts, penalties, tax breakdowns, and related details. Use the following endpoint. The information returned in the response payload is similar whether the request was by a record locator or by a ticket number. Refund Quote price details are provided in the following objects. All objects provide a total amount and a breakdown by base fare, price, and taxes as applicable: - Price - Amount paid for the ticket. - ModifyPrice - Any amount eligible for refund. - SupplierRetainedPrice - Any amount forfeited.

post/air/book/airoffer/offers/documentrefundquote

Request body

@typestring required

Example request

{
  "@type": "OfferQueryDocumentRefundQuote",
  "DocumentRefundQuote": [
    {
      "@type": "DocumentRefundQuote",
      "DocumentNumber": [
        {
          "value": "1259900123456",
          "documentIssuer": "BA",
          "documentType": "Ticket",
          "passengerTypeCode": "ADT"
        }
      ]
    }
  ]
}

Response

OK - Successful Response - 200

Example response

{
  "OfferListResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}