Sign in

v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
GDS Exchanges

Refund Commit from Document Refund Quote

Issues the refund based on a previously generated refund quote. Reference the OfferListIdentifiers returned in Document Refun Quote to select the refund you wish to complete.

post/air/receipt/receipts/documentrefundfromofferlist

Request body

@typestring required

Discriminator. No child classes.

Example request

{
  "@type": "ReceiptQueryDocumentRefundFromOfferList",
  "BuildFromOfferList": [
    {
      "@type": "BuildFromOfferList",
      "OfferListIdentifier": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "OfferIdentifier": [
        {
          "id": "offer_1",
          "offerRef": "offer_1",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "ProductIdentifier": [
        {
          "id": "product_1",
          "productRef": "product_1",
          "Identifier": {
            "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
            "authority": "TVPT"
          }
        }
      ],
      "SegmentSequence": 1,
      "WaiverCode": {
        "reasonCode": 2,
        "waiverType": "ChangePenalty"
      }
    }
  ]
}

Response

OK - Successful Response - 200

Example response

{
  "ReceiptListResponse": {
    "@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
    }
  }
}