{"items":[{"type":"link","label":"TripServices Pay","link":"/apis/pay","routeSlug":"/apis/pay","content":{"contentType":"overview","meta":{"name":"TripServices Pay"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/pay","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11/payment"},{"url":"https://api.travelport.net/11/payment"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"TripServices Pay (11.34.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The TripServices Pay v11 APIs allow online travel agencies to request credit card authorizations, card and address validations, and reversals against a specific merchant vendor."}],"sectionId":"/apis/pay"}],"sectionId":"/apis/pay"}]}]}},{"type":"group","label":"Payment Card Authorization","link":"/apis/pay/payment-card-authorization","routeSlug":"/apis/pay/payment-card-authorization","items":[{"label":"Payment Card Authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/pay/payment-card-authorization/create","routeSlug":"/apis/pay/payment-card-authorization/create","metadata":{"seo":{"title":"Payment Card Authorization","description":"Travelport’s NextGenAPI Payment Authorization Service allows the user to request credit card authorizations, address validations and reversals against a specific merchant vendor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Create","name":"Payment Card Authorization","isWebhook":false,"pointer":"/paths/~1paymentcardauthorizations~1{authType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Card Authorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travelport’s NextGenAPI Payment Authorization Service allows the user to request credit card authorizations, address validations and reversals against a specific merchant vendor."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authType","in":"path","schemaId":"schema_450","description":"Type of PaymentCardAuthorizationRequest - authorization, address verification, reversal","required":true}],"pointer":"/paths/~1paymentcardauthorizations~1{authType}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"travelportPlusSessionIdentifier","in":"header","schemaId":"schema_451","description":"travelportPlusSessionIdentifier used to maintain an established agency session"},{"name":"TraceId","in":"header","schemaId":"schema_452","description":"Identifier used to correlate Air API invocations across a multi-call business flows."},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","schemaId":"schema_453","description":"Identifies the Travelport access group with which the caller is associated"},{"name":"TVP-PCC-Core","in":"header","schemaId":"schema_454","description":"Allows user to pass PCC instead of Access Group ID"},{"name":"Accept-Encoding","in":"header","schemaId":"schema_455","description":"Comma-separated list of acceptable encodings like gzip and/or deflate","required":true}],"pointer":"/paths/~1paymentcardauthorizations~1{authType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentCardAuthorizationQueryRequest","exampleIds":["paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"]}},"schemaId":"components/schemas/PaymentCardAuthorizationQueryRequest","exampleIds":["paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"],"pointer":"/paths/~1paymentcardauthorizations~1{authType}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentcardauthorizations/{authType}","servers":[{"url":"/_mock/apis/pay","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11/payment"},{"url":"https://api.travelport.net/11/payment"}],"parameters":{"path":[{"name":"authType","in":"path","required":true,"schemaId":"schema_450"}],"query":[],"querystring":[],"header":[{"name":"travelportPlusSessionIdentifier","in":"header","required":false,"example":"49f58f5f-c443-43b4-9f5d-be405fd00a01","schemaId":"schema_451","style":"simple","explode":false},{"name":"TraceId","in":"header","required":false,"example":"TraceID_123456789","schemaId":"schema_452","style":"simple","explode":false},{"name":"XAUTH_TRAVELPORT_ACCESSGROUP","in":"header","required":false,"example":"19Y88702-C27A-4E5D-829A-89D7016688B1","schemaId":"schema_453","style":"simple","explode":false},{"name":"TVP-PCC-Core","in":"header","required":false,"example":"DU7_1G","schemaId":"schema_454","style":"simple","explode":false},{"name":"Accept-Encoding","in":"header","required":true,"example":"gzip, deflate","schemaId":"schema_455"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentCardAuthorizationQueryRequest","exampleIds":["paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"]}},"responseCodes":["200","400","401","402","403","404","500"],"pointer":"/paymentcardauthorizations/{authType}","href":"payment-card-authorization/create","openApiOperationId":"Create","summary":"Payment Card Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/pay","description":"Mock server","isMockServer":true},{"url":"https://api.pp.travelport.net/11/payment"},{"url":"https://api.travelport.net/11/payment"}],"schemaId":"components/schemas/PaymentCardAuthorizationQueryRequest","exampleIds":["paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentCardAuthorizationQueryRequest","exampleIds":["paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data","paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK - Successful Response - 200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentCardAuthorizationResponseWrapper"}},"schemaId":"components/schemas/PaymentCardAuthorizationResponseWrapper"},{"code":"400","description":"Bad Request - 400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"401","description":"Unauthorized - 401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"402","description":"Payment Required - 402","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"403","description":"Forbidden - 403","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"404","description":"Not Found - 404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"},{"code":"500","description":"Internal Server Error - 500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}},"schemaId":"components/schemas/ErrorResponseWrapper"}],"pointer":"/paths/~1paymentcardauthorizations~1{authType}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaymentCardAuthorizationResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaymentCardAuthorizationResponseWrapper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"402","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"403","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorResponseWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponseWrapper"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-card-authorization/create"}],"panels":[]}]},"httpPath":"/paymentcardauthorizations/{authType}"}],"content":{"contentType":"group","meta":{"name":"Payment Card Authorization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Card Authorization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/paymentcardauthorizations/{authType}","summary":"Payment Card Authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-card-authorization/create","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/PaymentCardAuthorizationQueryRequest":{"id":"components/schemas/PaymentCardAuthorizationQueryRequest","kind":"json-schema","title":"PaymentCardAuthorizationQueryRequest","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator class PaymentCardAuthorizationQueryRequest only","example":"PaymentCardAuthorizationQueryRequest"},"authType":{"$ref":"#/components/schemas/AuthorizationTypeEnum"},"PaymentCardRequest":{"$ref":"#/components/schemas/PaymentCardRequest"}}}},"components/schemas/AuthorizationTypeEnum":{"id":"components/schemas/AuthorizationTypeEnum","kind":"json-schema","title":"AuthorizationTypeEnum","data":{"type":"string","description":"This object  contains type of Authorization","example":"AUTH","enum":["AUTH","REVS","VALD","AAVS"]}},"components/schemas/PaymentCardRequest":{"id":"components/schemas/PaymentCardRequest","kind":"json-schema","title":"PaymentCardRequest","data":{"required":["AgencyPCCDetail","CurrencyAmount","PrimaryAccountNumber","PromotionCode","airlineMerchantCode","expireDate"],"properties":{"@type":{"type":"string","example":"PaymentCardRequest"},"paymentCardShortNumber":{"maxLength":4,"pattern":"([0-9]+)?","type":"string","description":"The payment card short number","example":"9596"},"airlineMerchantCode":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string","description":"The airline merchant code","example":"KL"},"extendedPaymentInstallments":{"maxLength":2,"pattern":"([0-9]+)?","type":"string","description":"The number of installment payments for this transaction to be charged","example":"6"},"expireDate":{"pattern":"(0[1-9]|1[0-2])[0-9][0-9]","type":"string","description":"The payment card expiry date MMYY","example":"1222"},"eCI":{"maxLength":32,"type":"string","description":"3D Secure eCI code","example":"5"},"cAVV":{"maxLength":64,"type":"string","description":"3D Secure cAVV value","example":"AAACBGESJIMBIFMBZhIkAAAAAAA="},"xID":{"maxLength":128,"type":"string","description":"3D Secure xID value","example":"MDAwMDAwMDAwMDEyMzQ2Njc4OTA="},"agentSignOn":{"maxLength":128,"type":"string","description":"The agent sign on ID","example":"ABC123/BZ"},"localDateTime":{"type":"string","description":"The local date time","example":"2018-06-08T09:45:00"},"approvalCode":{"maxLength":32,"type":"string","description":"The approval code to be reversed","example":"00187C"},"paymentCardSecurityCode":{"maxLength":11,"minLength":2,"pattern":"([0-9a-zA-Z]+)?","type":"string","description":"The payment card security code","example":"933"},"paymentCardCode":{"maxLength":2,"pattern":"([A-Z0-9]+)?","type":"string","description":"The payment card code","example":"VI"},"uCAFIndicator":{"maxLength":32,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Universal Card Authentication Field™ MasterCard only UCAF is the mechanism that is used to transmit the AAV from the merchant to issuer for authentication purposes during the authorization process"},"children":[]}]}]}],"example":"0"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"PrimaryAccountNumber":{"maxLength":19,"minLength":13,"pattern":"([0-9]+)?","type":"string","description":"The unencrypted credit card number","example":"4010000011112222"},"CurrencyAmount":{"$ref":"#/components/schemas/CurrencyAmount"},"PromotionCode":{"$ref":"#/components/schemas/PromotionCodeGroup"},"CardHolder":{"$ref":"#/components/schemas/CardHolder"},"AgencyPCCDetail":{"$ref":"#/components/schemas/AgencyPCCDetail"},"AdditionalAmount":{"maxItems":6,"type":"array","items":{"$ref":"#/components/schemas/AdditionalAmount"}},"TravelInfoAir":{"$ref":"#/components/schemas/TravelInfoAir"}}}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"properties":{"value":{"maxLength":1024,"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique offer identifier that can be sent in subsequent payload requests to reference this offer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea')."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When building an AirPrice or Add Offer reference payload request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request."},"children":[]}]}]}],"example":"A0656EFF-FAF4-456F-B061-0161008D7C4E"},"authority":{"maxLength":128,"type":"string","description":"\"Name of the supplier system that created this identifier - the source of information.  \nFor AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier.  \nWhen returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer.  \nFor Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error.  \nFor Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.\"","example":"TVPT"}},"description":"A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination)."}},"components/schemas/CurrencyAmount":{"id":"components/schemas/CurrencyAmount","kind":"json-schema","title":"CurrencyAmount","data":{"properties":{"value":{"type":"number","description":"The amount of a given currency.","format":"float","example":124.56},"code":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 alpha character code (3 characters) that specifies a money unit.","example":"USD"},"minorUnit":{"type":"integer","description":"Minor units are a mechanism for expressing the relationship between a major currency unit and its corresponding minor currency unit.  \nIt is the smallest unit of a given currency. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit.","format":"int32","example":2},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"approximateInd":{"type":"boolean","description":"\"If true, the currency amount has been converted from the original amount.  \nFor Air Exchange Eligibility, returned only if a currency is converted. If returned, the value is always true, indicating that the fee is approximate because of currency conversion.  \nFor Hotel Availability and Rules, true indicates this is a calculated value; false indicates this is the value returned by the property.\"","example":true}},"description":"A monetary amount, up to 4 decimal places. Decimal place must be included."}},"components/schemas/CurrencySourceEnum":{"id":"components/schemas/CurrencySourceEnum","kind":"json-schema","title":"CurrencySourceEnum","data":{"type":"string","description":"The system requesting or returning the currency code specified in the attribute","example":"Supplier","enum":["Supplier","Charged","Requested"]}},"components/schemas/PromotionCodeGroup":{"id":"components/schemas/PromotionCodeGroup","kind":"json-schema","title":"PromotionCodeGroup","data":{"properties":{"promotionCode":{"maxLength":32,"type":"string","description":"The promotion code value","example":"SUMMER22"},"promotionVendorCode":{"type":"array","description":"The promotion vendor code value","example":[300,234,657],"items":{"maxLength":32,"type":"string"}}},"description":"Used to provide a promotion code of the loyalty redemption."}},"components/schemas/CardHolder":{"id":"components/schemas/CardHolder","kind":"json-schema","title":"CardHolder","data":{"required":["IP4Address"],"properties":{"@type":{"type":"string","example":"CardHolder"},"CardHolderName":{"maxLength":512,"type":"string","description":"Name imprinted or embossed on the payment card","example":"Eric K Miller"},"IP4Address":{"maxLength":15,"type":"string","description":"An IP 4 formatted string","example":"111.222.0.0"},"Person":{"$ref":"#/components/schemas/Person"}}}},"components/schemas/Person":{"id":"components/schemas/Person","kind":"json-schema","title":"Person","data":{"allOf":[{"$ref":"#/components/schemas/PersonID"},{"required":["PersonName"],"properties":{"birthDate":{"type":"string","description":"Date of Birth YYYY-MM-DD","format":"date","example":"2026-06-05"},"gender":{"$ref":"#/components/schemas/GenderEnum"},"PersonName":{"$ref":"#/components/schemas/PersonName"},"Address":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Address"}},"Telephone":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Telephone"}},"Email":{"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/Email"}}}}]}},"components/schemas/PersonID":{"id":"components/schemas/PersonID","kind":"json-schema","title":"PersonID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Person or PersonID","default":"PersonID"},"id":{"type":"string","example":"3456"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/GenderEnum":{"id":"components/schemas/GenderEnum","kind":"json-schema","title":"GenderEnum","data":{"type":"string","description":"Gender Type Male, Female etc. This field is not used by Hotel APIs and will be ignored.","example":"Female","enum":["Male","Female","Unknown","Undisclosed"]}},"components/schemas/PersonName":{"id":"components/schemas/PersonName","kind":"json-schema","title":"PersonName","data":{"required":["@type","Surname"],"properties":{"@type":{"type":"string","description":"Discriminator classes PersonName or PersonNameDetail","example":"PersonNameDetail"},"Prefix":{"maxLength":10,"type":"string","description":"Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)","example":"Mr"},"Given":{"maxLength":30,"type":"string","description":"Given name, first name or names.","example":"John"},"Middle":{"maxLength":30,"type":"string","description":"The middle name of the person name.","example":"Erick"},"Surname":{"maxLength":30,"minLength":1,"type":"string","description":"Family name, last name.","example":"Smith"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Travelport+ limits the combination of Given and Surname to 22 characters. Given name must have at least one character. Any PersonName exceeding 22 characters is truncated in the response."},"children":[]}]}]}],"discriminator":{"propertyName":"@type"}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"required":["@type","City"],"properties":{"@type":{"type":"string","description":"Discriminator classes Address or AddressDetail","example":"AddressDetail"},"id":{"type":"string","description":"unique address id","example":"Address_1"},"BldgRoom":{"$ref":"#/components/schemas/AddressBldgRoom"},"Number":{"$ref":"#/components/schemas/AddressStreetNumber"},"Street":{"maxLength":128,"type":"string","description":"Street name. May also contain the street number when the Number element is missing.","example":"ABC Street"},"AddressLine":{"maxItems":3,"type":"array","description":"Property street address. Used in place of Street and Number. Each element of the array represents an address line.","items":{"maxLength":128,"type":"string","example":"2035 S Havana street"}},"City":{"maxLength":128,"type":"string","description":"Full name of the city, town, or postal station (i.e., a postal service territory, often used in a military address).","example":"Dublin"},"County":{"maxLength":128,"type":"string","description":"County or Region Name.","example":"Berkshire"},"StateProv":{"$ref":"#/components/schemas/StateProv"},"Country":{"$ref":"#/components/schemas/Country"},"PostalCode":{"maxLength":128,"type":"string","description":"Postal code for the address.","example":"Sl6 1AB"},"Addressee":{"maxLength":37,"type":"string","description":"The name of the company or person to be addressed","example":"ACME INC"},"role":{"$ref":"#/components/schemas/Enum_AddressRole"}},"description":"The property or billing address information.","discriminator":{"propertyName":"@type"}}},"components/schemas/AddressBldgRoom":{"id":"components/schemas/AddressBldgRoom","kind":"json-schema","title":"AddressBldgRoom","data":{"properties":{"value":{"maxLength":128,"type":"string","example":"Moore House"},"buldingInd":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the information is a building name. When false, it is an apartment or room #"},"children":[]}]}]}],"example":true}},"description":"Address with building and room number"}},"components/schemas/AddressStreetNumber":{"id":"components/schemas/AddressStreetNumber","kind":"json-schema","title":"AddressStreetNumber","data":{"properties":{"value":{"maxLength":128,"type":"string","description":"Street number value.","example":"23B"},"streetNmbrSuffix":{"maxLength":32,"type":"string","description":"Street Number Suffix","example":"B"},"streetDirection":{"maxLength":32,"type":"string","description":"Direction of the Street","example":"NW"},"ruralRouteNmbr":{"pattern":"[0-9]{1,5}","type":"string","description":"RuralRoute Number","example":"76"},"po_Box":{"maxLength":128,"type":"string","description":"PO Box Number","example":"1001"}},"description":"The street number alone is the numerical number that precedes the street name in the address."}},"components/schemas/StateProv":{"id":"components/schemas/StateProv","kind":"json-schema","title":"StateProv","data":{"properties":{"value":{"maxLength":8,"minLength":1,"type":"string","description":"State, province, or region code needed to identify location (typically two characters).","example":"CA"},"name":{"maxLength":512,"type":"string","description":"State, province, or region name needed to identify location.","example":"California"}},"description":"The standard code or abbreviation for the state, province, or region. May also include full length name."}},"components/schemas/Country":{"id":"components/schemas/Country","kind":"json-schema","title":"Country","data":{"properties":{"value":{"pattern":"[a-zA-Z]{2}","type":"string","description":"The ISO 3166 code for the property's address.","example":"US"},"id":{"type":"string","description":"Custom user-assigned identifier for the country.","example":"23"},"name":{"maxLength":128,"type":"string","description":"The full name of the country for the property's address.","example":"United States"},"codeContext":{"maxLength":32,"type":"string","description":"The source of a code, such as the organization that provided the id number","example":"IATA"}},"description":"Contains the information needed to identify a country."}},"components/schemas/Enum_AddressRole":{"id":"components/schemas/Enum_AddressRole","kind":"json-schema","title":"Enum_AddressRole","data":{"type":"string","description":"Defines the type of location the address is assigned to. For TravelAgency address leave blank or use \"Other\".","example":"Business","enum":["Home","Business","Mailing","Delivery","Destination","Other","Billing"]}},"components/schemas/Telephone":{"id":"components/schemas/Telephone","kind":"json-schema","title":"Telephone","data":{"required":["@type","phoneNumber"],"properties":{"@type":{"type":"string","description":"Discriminator classes Telephone or TelephoneDetail","example":"Telephone"},"countryAccessCode":{"pattern":"[0-9]{1,3}","type":"string","description":"Phone country code","example":"1"},"areaCityCode":{"pattern":"[0-9]{1,8}","type":"string","description":"Phone local area code","example":"972"},"phoneNumber":{"maxLength":32,"type":"string","description":"Mobile/Telephone Number. Accepted characters are numeric, dash, space, and period.","example":"972-000-787"},"extension":{"pattern":"[0-9]{0,5}","type":"string","description":"Telephone extension number","example":"234"},"id":{"type":"string","description":"Optional internally referenced id","example":"3"},"cityCode":{"maxLength":10,"pattern":"([A-Z0-9]+)?","type":"string","description":"IATA city code if referenced by phone number.","example":"DEN"},"role":{"$ref":"#/components/schemas/Enum_TelephoneRole"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Enum_TelephoneRole":{"id":"components/schemas/Enum_TelephoneRole","kind":"json-schema","title":"Enum_TelephoneRole","data":{"type":"string","description":"Defines the type of location the Telephone is assigned to. For Travel Agency telephone select \"Other\" or leave blank.","example":"Mobile","enum":["Mobile","Home","Work","Office","Fax","Other"]}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"properties":{"value":{"maxLength":128,"type":"string","example":"exampledomain@example.com"},"id":{"type":"string","description":"Electronic email addresses, in IETF specified format.","example":"email_1"},"emailType":{"type":"string","description":"Use email type to specify if the email is to be sent \"TO\" or sent \"FROM\"","example":"FROM"},"comment":{"maxLength":4096,"type":"string","description":"Comments associated to the email"},"preferredFormat":{"maxLength":32,"type":"string","description":"Mime media type","example":"text/html"},"shareMarketing":{"$ref":"#/components/schemas/YesNoInheritEnum"},"shareSync":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optOutInd":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optInStatus":{"$ref":"#/components/schemas/OptInStatusEnum"},"optInDate":{"type":"string","description":"The datetime of receiving the opt in notice","format":"date-time","example":"2026-03-03T11:11:00Z"},"optOutDate":{"type":"string","description":"The datetime the opt out notice was received","format":"date-time","example":"2026-03-03T11:11:00Z"},"validInd":{"type":"boolean","description":"If true, this is a valid email address that has been system verified via a successful email transmission.","example":true},"provisionedInd":{"type":"boolean","description":"If true then the email address came from the provisioning process","example":true}},"description":"Electronic email addresses, in IETF specified format.  \nBooking.com requires a traveler email address in the Hotel Create Reservation and Add Reservation requests. A system-generated confirmation email is sent to the traveler after the booking completes."}},"components/schemas/YesNoInheritEnum":{"id":"components/schemas/YesNoInheritEnum","kind":"json-schema","title":"YesNoInheritEnum","data":{"type":"string","description":"Used to indicate marketing preferences, Yes, No, Inherit","example":"Yes","enum":["Yes","No","Inherit"]}},"components/schemas/OptInStatusEnum":{"id":"components/schemas/OptInStatusEnum","kind":"json-schema","title":"OptInStatusEnum","data":{"type":"string","description":"Used to indicate marketing preferences, OptIn, OptOut","enum":["OptedIn","OptedOut","Unknown"]}},"components/schemas/AgencyPCCDetail":{"id":"components/schemas/AgencyPCCDetail","kind":"json-schema","title":"AgencyPCCDetail","data":{"description":"Agency PCC detail information","allOf":[{"$ref":"#/components/schemas/AgencyPCC"},{"properties":{"Name":{"maxLength":128,"type":"string","description":"The name of the agency","example":"GALILEO FRANCE"},"StateProv":{"maxLength":8,"minLength":2,"type":"string","description":"The state or province of the agency","example":"CO"},"PostalCode":{"maxLength":32,"type":"string","description":"Postal code for the agency address.","example":"80012"}}}]}},"components/schemas/AgencyPCC":{"id":"components/schemas/AgencyPCC","kind":"json-schema","title":"AgencyPCC","data":{"required":["@type","City","Currency","agencyCode","codeAffinity","country","pseudoCityCode"],"properties":{"@type":{"type":"string","description":"Discriminator classes AgencyPCC or AgencyPCCDetail","example":"AgencyPCC"},"id":{"type":"string","description":"Agency PCC unique id","example":"agencyPCC_1"},"pseudoCityCode":{"maxLength":10,"minLength":2,"pattern":"([a-zA-Z0-9]{2,10})","type":"string","description":"PCC","example":"1CR"},"agencyCode":{"pattern":"([0-9]{8})","type":"string","description":"Agency PCC Code","example":"91212132"},"country":{"pattern":"[a-zA-Z]{2}","type":"string","description":"Country Code","example":"US"},"codeAffinity":{"maxLength":32,"type":"string","description":"Code Affinity","example":"1A"},"tierLevel":{"type":"integer","description":"Tier Level","format":"int32","example":2},"bsp":{"maxLength":32,"type":"string","description":"Billing Settlement Plan","example":"BSP"},"whps":{"maxLength":32,"type":"string","description":"WHPS code","example":"ABC12s"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"City":{"$ref":"#/components/schemas/AirportOrCity"},"Currency":{"$ref":"#/components/schemas/Currency"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/AirportOrCity":{"id":"components/schemas/AirportOrCity","kind":"json-schema","title":"AirportOrCity","data":{"properties":{"value":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string","example":"DEN"},"cityOrAirport":{"$ref":"#/components/schemas/CityOrAirportEnum"}},"description":"Airport or city code of the customer embarkation"}},"components/schemas/CityOrAirportEnum":{"id":"components/schemas/CityOrAirportEnum","kind":"json-schema","title":"CityOrAirportEnum","data":{"type":"string","description":"Optional enumeration specifying whether to restrict the search based on the city/airport code sent in From/value. Possible options and behavior are as follows. These behaviors are for availability selection only. Actual content may vary based on calculated price and diversity. Not all NDC carriers may support all options. Airport code with no cityOrAirport value expands the availability selection to the city while giving preference to the requested airport. For example, LGA would return flights for LGA, EWR, and JFK but would target more content from LGA. City code with no cityOrAirport value returns an unweighted selection of inventory for all airports in the city. For example, NYC would search content equally between LGA, EWR, and JFK. This behavior also applies to: city code with Airport Only, City code with City Only, City or airport code with City or Airport. Airport code with cityOrAirport value Airport Only returns content only from the specified airport. For example, LGA will return content from only LGA. Airport code with cityOrAirport value City expands the availability selection to the city without giving preference to the requested airport. This behavior is equivalent to searching with the airport's city code. For example, LGA would instead be treated as NYC and would return flights for LGA, EWR, and JFK with no preference.","example":"City or Airport","enum":["Airport Only","City or Airport","City Only","Use Default"]}},"components/schemas/Currency":{"id":"components/schemas/Currency","kind":"json-schema","title":"Currency","data":{"required":["code"],"properties":{"value":{"type":"number","format":"float","example":22.2},"code":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 alpha character code that specifies a money unit","example":"USD"}},"description":"The default currency that will apply to all prices, amounts, fares, etc. in a message.  It is placed at the top of any message using this object."}},"components/schemas/AdditionalAmount":{"id":"components/schemas/AdditionalAmount","kind":"json-schema","title":"AdditionalAmount","data":{"properties":{"value":{"type":"number","format":"float"},"additionalAmountType":{"$ref":"#/components/schemas/AdditionalAmountTypeEnum"},"code":{"pattern":"[a-zA-Z]{3}","type":"string","description":"The ISO currency code","example":"USD"},"minorUnit":{"maximum":4,"minimum":0,"type":"integer","description":"The minor unit for the currency","format":"int32","example":0},"currencySource":{"$ref":"#/components/schemas/CurrencySourceEnum"},"approximateInd":{"type":"boolean","description":"True if the currency amount has been converted from the original amount"}},"description":"An amount with a qualifier for what it is for"}},"components/schemas/AdditionalAmountTypeEnum":{"id":"components/schemas/AdditionalAmountTypeEnum","kind":"json-schema","title":"AdditionalAmountTypeEnum","data":{"type":"string","description":"Used in Columbia and other places as a way to add extra taxes","example":"FO","enum":["FA","FV","FO","SA","SV","ST"]}},"components/schemas/TravelInfoAir":{"id":"components/schemas/TravelInfoAir","kind":"json-schema","title":"TravelInfoAir","data":{"allOf":[{"$ref":"#/components/schemas/TravelInfo"},{"properties":{"fareBasisCode":{"maxLength":128,"type":"string","description":"The fare Basis Code","example":"YEE1Y"},"AirlineCodes":{"type":"array","description":"IATA defined code for Airline","example":"KL","items":{"pattern":"([a-zA-Z0-9]{2,3})","type":"string"}},"AirportCodes":{"type":"array","description":"IATA defined code for airport","example":"BNE","items":{"maxLength":3,"minLength":3,"pattern":"([a-zA-Z]{3})","type":"string"}},"FirstFlightNumber":{"pattern":"[0-9]{1,4}[A-Z]?|OPEN|ARNK","type":"string","description":"Flight number of the first flight on the itinerary","example":"BA 98"},"FirstFlightDepartureTime":{"type":"string","description":"Local departure time of the first flight","example":"915"},"FirstSegmentClass":{"maxLength":2,"minLength":1,"pattern":"([a-zA-Z0-9]{1,2})","type":"string","description":"Class of service of the first segment on the itinerary","example":"Y"}}}]}},"components/schemas/TravelInfo":{"id":"components/schemas/TravelInfo","kind":"json-schema","title":"TravelInfo","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes TravelInfo or TravelInfoAir","example":"TravelInfo"},"departureDate":{"type":"string","description":"The local date of departure for an intinerary","format":"date","example":"2018-08-28"},"numberOfTravelers":{"minimum":0,"exclusiveMinimum":false,"type":"integer","description":"The number of travelers","format":"int32","example":2},"LocatorCode":{"$ref":"#/components/schemas/Locator"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/Locator":{"id":"components/schemas/Locator","kind":"json-schema","title":"Locator","data":{"properties":{"value":{"maxLength":16,"pattern":"([A-Z0-9]+)?","type":"string","description":"\"Reference number for locatorType.  \nBooking.com returns a PIN number along with the confirmation number for each sold hotel segment. If the agent/traveler needs to reconcile the booking with Booking.com, Booking.com requires both the PIN number and confirmation number to locate the segment in their system.\"","example":"ZXG25P"},"locatorType":{"maxLength":32,"type":"string","description":"Specifies the type of reservation ID\nTravelport - Confirmation number; PNR locator Agency - IATA Number Booking.com - Confirmation number; PIN number\nIn Document History, may return the content source (e.g. GDS or NDC)","example":"Confirmation Number"},"source":{"maxLength":128,"type":"string","description":"\"Content source. Typically a two-character Supplier code that indicates the source system which generated the resid.  \nFor Hotels, if source matches chain code, the offer is directly with the supplier. If source is 'BO', the offer is with Booking.com.\"","example":"1G"},"sourceContext":{"maxLength":128,"type":"string","description":"Specifies the context of the source. Either Travelport, Agency, or Supplier.","example":"Travelport"},"otaType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Used for codes","example":"14.UIT"},"creationDate":{"type":"string","description":"Date created in Travelport or supplier system in YYYY-MM-DD format.","format":"date","example":"2026-03-01"},"lastUpdated":{"type":"string","description":"The date and time stamp the Reservation was last updated.","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Locator information for the reservation. Contains the locator (PNR or external locator) or cancellation number for the reservation, order, or offer."}},"components/schemas/PaymentCardAuthorizationResponseWrapper":{"id":"components/schemas/PaymentCardAuthorizationResponseWrapper","kind":"json-schema","title":"PaymentCardAuthorizationResponseWrapper","data":{"properties":{"PaymentCardAuthorizationResponse":{"$ref":"#/components/schemas/PaymentCardAuthorizationResponse"}},"description":"Wrapper schema to expose the name of the top level schema in the JSON example"}},"components/schemas/PaymentCardAuthorizationResponse":{"id":"components/schemas/PaymentCardAuthorizationResponse","kind":"json-schema","title":"PaymentCardAuthorizationResponse","data":{"properties":{"PaymentCardAuthorization":{"$ref":"#/components/schemas/PaymentCardAuthorization"}},"description":"The response of Payment card authorization endpoint request.","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/BaseResponse":{"id":"components/schemas/BaseResponse","kind":"json-schema","title":"BaseResponse","data":{"properties":{"@type":{"type":"string","example":"response"},"transactionId":{"type":"string","description":"A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting.  \nAlso known as E2ETrackingId.  \nNot returned in all Hotel API responses.","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"traceId":{"type":"string","description":"Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response.  \nFor Air Eligibility, returned if a custom trace ID was sent in the request header.  \nFor Hotel Rules, returned if a custom trace ID was sent in the request header.","example":"TraceID_123456"},"correlationId":{"type":"string","description":"Identifier used to correlate hotel API invocations across a multi-call business flow.","format":"uuid"},"reservationStatus":{"$ref":"#/components/schemas/ReservationOfferStatusEnum"},"Result":{"$ref":"#/components/schemas/Result"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"NextSteps":{"$ref":"#/components/schemas/NextSteps"},"ReferenceList":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/ReferenceList"}},"CurrencyRateConversion":{"maxItems":5,"type":"array","items":{"$ref":"#/components/schemas/CurrencyRateConversion"}},"Pagination":{"$ref":"#/components/schemas/Pagination"}},"description":"Base response is part of all JSON APIs responses and includes common items which are relevant across all APIs"}},"components/schemas/ReservationOfferStatusEnum":{"id":"components/schemas/ReservationOfferStatusEnum","kind":"json-schema","title":"ReservationOfferStatusEnum","data":{"type":"string","description":"Status of reservation or offer completion.","enum":["Success","Fail","Partial","Pending","OnHold","Retry","Other"],"x-enumDescriptions":{"Success":"All offer items have been booked and issued successfully.","Fail":"All offer items have failed to issue.","Partial":"Some offer items have failed to issue.","Pending":"Some offer items are pending carrier response.","OnHold":"Document issuance has not been attempted.","Retry":"A communication error has occurred and retry of document issuance is required.","Other":"An issue has occurred and will be communicated in the error or warning response."}}},"components/schemas/Result":{"id":"components/schemas/Result","kind":"json-schema","title":"Result","data":{"properties":{"@type":{"type":"string","description":"Discriminator class Result only","example":"Result"},"status":{"$ref":"#/components/schemas/ResultStatusEnum"},"Error":{"maxItems":50,"type":"array","description":"A list of error information returned at the provider level for a response.","items":{"$ref":"#/components/schemas/Error"}},"Warning":{"maxItems":100,"type":"array","description":"A list of warning information returned at the provider level for a response.","items":{"$ref":"#/components/schemas/Warning"}}},"description":"Returns the error and/or warning message information, if applicable."}},"components/schemas/ResultStatusEnum":{"id":"components/schemas/ResultStatusEnum","kind":"json-schema","title":"ResultStatusEnum","data":{"type":"string","description":"The status of an error or warning","example":"Complete","enum":["Not processed","Incomplete","Complete","Unknown"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Error or ErrorDetail","example":"ErrorDetail"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","example":200,"deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message","example":"No flights found."},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"description":"A list of error information returned from the provider.","discriminator":{"propertyName":"@type"}}},"components/schemas/NameValuePair":{"id":"components/schemas/NameValuePair","kind":"json-schema","title":"NameValuePair","data":{"required":["name"],"properties":{"value":{"maxLength":512,"type":"string","description":"Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).","example":"Sunday"},"id":{"type":"string","description":"Optional internally referenced id","example":"6"},"name":{"maxLength":512,"type":"string","description":"Key, categorizing the of type of remark or error.","example":"Day1"}},"description":"Further details describing remarks or error response, structured in name-value pairs."}},"components/schemas/Warning":{"id":"components/schemas/Warning","kind":"json-schema","title":"Warning","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes Warning or WarningDetail","example":"WarningDetail"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","example":200,"deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message","example":"Customer Loyalty could not be applied."},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"description":"A list of warning information returned from the provider.","discriminator":{"propertyName":"@type"}}},"components/schemas/NextSteps":{"id":"components/schemas/NextSteps","kind":"json-schema","title":"NextSteps","data":{"required":["NextStep","baseURI"],"properties":{"baseURI":{"type":"string","description":"The base portion of the uri in order to shorten the uris in the individual steps"},"id":{"type":"string","description":"Optional internally referenced id","example":"5"},"NextStep":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/NextStep"}}},"description":"Container for the steps that describe actions that may be taken on the containing object.  \nNot applicable for an Eligibility or Exchange response."}},"components/schemas/NextStep":{"id":"components/schemas/NextStep","kind":"json-schema","title":"NextStep","data":{"required":["action","method"],"properties":{"value":{"type":"string","example":"www.resourcelocation.com"},"id":{"type":"string","description":"Identifier for the Next Step","example":"2"},"action":{"maxLength":32,"type":"string","description":"The action this next step is intended to achieve","example":"cancel"},"method":{"$ref":"#/components/schemas/NextStepMethodEnum"},"description":{"maxLength":32,"type":"string","description":"Additional clarification for the next step","example":"remove offer from the order"}},"description":"A URL that describes a step that can be applied to the resource containing the next step structure."}},"components/schemas/NextStepMethodEnum":{"id":"components/schemas/NextStepMethodEnum","kind":"json-schema","title":"NextStepMethodEnum","data":{"type":"string","description":"Describes the set of potential methods that can be taken after an operation.","enum":["GET","DELETE","PUT","POST"]}},"components/schemas/ReferenceList":{"id":"components/schemas/ReferenceList","kind":"json-schema","title":"ReferenceList","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discriminator"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Air Price child classes are ReferenceListAmenity and ReferenceListBrand."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FareRules child class is ReferenceListFlight."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search Ancillaries child class is ReferenceListFlight."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seat Map child class is ReferenceListSeatingChart."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hotel Availability child class is ReferenceListPropertyDates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Book_Traveler child class is ReferenceListTraveler."},"children":[]}]}]}]}],"example":"ReferenceListFlight"},"id":{"type":"string","description":"Uniquely identifies for the Reference List"}},"description":"ReferenceList consolidates frequently referenced objects into a single instance, which is referenced throughout the response payload.  \nThis is most commonly used in our Search APIs where response size is a consideration. Air Search API will return one instance ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, ReferenceListBrand, and optionaly if requested, ReferenceListAmenity and ReferenceListUniversalProductAttributes.  \nNot applicable for an Eligibility or Exchange response.","discriminator":{"propertyName":"@type"}}},"components/schemas/CurrencyRateConversion":{"id":"components/schemas/CurrencyRateConversion","kind":"json-schema","title":"CurrencyRateConversion","data":{"required":["ConversionRate","SourceCurrency","TargetCurrency"],"properties":{"@type":{"type":"string","default":"CurrencyRateConversion"},"SourceCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"TargetCurrency":{"$ref":"#/components/schemas/CurrencyCode"},"ConversionRate":{"$ref":"#/components/schemas/ConversionRate"}},"description":"Conversion information for currency exchange between one currency and another. The response does not convert any amounts.  \nFor Hotel, returned only if requestedCurrency was sent in the request. By default the Hotel APIs return all rates in the currency of the hotel's location."}},"components/schemas/CurrencyCode":{"id":"components/schemas/CurrencyCode","kind":"json-schema","title":"CurrencyCode","data":{"properties":{"value":{"pattern":"[a-zA-Z]{3}","type":"string","description":"An ISO 4217 currency code.","example":"USD"},"codeAuthority":{"maxLength":32,"type":"string","description":"Currency code authority","example":"ISO 4217"},"decimalPlace":{"type":"integer","description":"Number of decimal places for the currency.","format":"int32","example":4},"decimalAuthority":{"maxLength":32,"type":"string","description":"Currency code decimal authority","example":"ISO 4217"}},"description":"Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world.  \nUnless changed in the request, the currency is the default associated with your provisioned PCC from Travelport.  \nFor Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency."}},"components/schemas/ConversionRate":{"id":"components/schemas/ConversionRate","kind":"json-schema","title":"ConversionRate","data":{"properties":{"value":{"type":"number","format":"float"},"rateAuthority":{"maxLength":32,"type":"string","description":"Contextual rate authority","example":"ISO 4217"},"rateAsOf":{"type":"string","description":"Rate as of","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts."}},"components/schemas/Pagination":{"id":"components/schemas/Pagination","kind":"json-schema","title":"Pagination","data":{"required":["@type","page","pageSize","totalItems","totalPages"],"properties":{"@type":{"type":"string","example":"Pagination"},"page":{"type":"integer","description":"The current page number of the full result set","format":"int32","example":1},"pageSize":{"type":"integer","description":"The total number of items on this page","format":"int32","example":20},"totalPages":{"type":"integer","description":"The total number of pages in this result set","format":"int32","example":5},"totalItems":{"type":"integer","description":"The total number of pages in this result set","format":"int32","example":100}},"description":"Pagination object used when result sets span across a number of pages."}},"components/schemas/PaymentCardAuthorization":{"id":"components/schemas/PaymentCardAuthorization","kind":"json-schema","title":"PaymentCardAuthorization","data":{"allOf":[{"$ref":"#/components/schemas/PaymentCardAuthorizationID"},{"properties":{"completionCode":{"maxLength":32,"type":"string","description":"The completion code value","example":"0"},"approvalCode":{"maxLength":32,"type":"string","description":"The approval code value","example":"235"},"avsResult":{"maxLength":1,"type":"string","description":"The address verification result code","example":"G"},"securityResult":{"maxLength":1,"type":"string","description":"The security result code","example":"C"},"completionCodeDescription":{"maxLength":512,"type":"string","description":"Completion code description","example":"OK"},"avsResultDescription":{"maxLength":512,"type":"string","description":"The avs result description","example":"Address not verified for International transaction (International only)"},"securityResultDescription":{"maxLength":512,"type":"string","description":"The security result description","example":"CVV2 Match"},"PrimaryAccountNumber":{"maxLength":19,"minLength":13,"pattern":"([0-9]+)?","type":"string","description":"The unencrypted credit card number","example":"444111000222"}}}]}},"components/schemas/PaymentCardAuthorizationID":{"id":"components/schemas/PaymentCardAuthorizationID","kind":"json-schema","title":"PaymentCardAuthorizationID","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes PaymentCardAuthorizationID or PaymentCardAuthorization","example":"PaymentCardAuthorization"},"id":{"type":"string","description":"internally referenced xsd id","example":"63"},"Identifier":{"$ref":"#/components/schemas/Identifier"},"PaymentCardAuthorizationRef":{"type":"string"}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ErrorResponseWrapper":{"id":"components/schemas/ErrorResponseWrapper","kind":"json-schema","title":"ErrorResponseWrapper","data":{"properties":{"ErrorResponse":{"$ref":"#/components/schemas/ErrorResponse"}},"description":"Wrapper object"}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"description":"Base common error response","allOf":[{"$ref":"#/components/schemas/BaseResponse"}]}},"components/schemas/ErrorWarningDetail":{"id":"components/schemas/ErrorWarningDetail","kind":"json-schema","title":"ErrorWarningDetail","data":{"description":"Detailed child class of ErrorWarning","allOf":[{"$ref":"#/components/schemas/ErrorWarning"},{"required":["SourceID"],"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"VALIDATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/ErrorWarning":{"id":"components/schemas/ErrorWarning","kind":"json-schema","title":"ErrorWarning","data":{"required":["@type"],"properties":{"@type":{"type":"string","description":"Discriminator classes ErrorWarning or ErrorWarningDetail","example":"ErrorWarning"},"StatusCode":{"type":"integer","description":"Http standard response code","format":"int32","deprecated":true},"Message":{"maxLength":4096,"type":"string","description":"The Travelport standardized error or warning message"},"NameValuePair":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/NameValuePair"}}},"discriminator":{"propertyName":"@type"}}},"components/schemas/ErrorDetail":{"id":"components/schemas/ErrorDetail","kind":"json-schema","title":"ErrorDetail","data":{"description":"Detailed child class of Error","allOf":[{"$ref":"#/components/schemas/Error"},{"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"VALIDATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning","example":"1G"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system","example":"1234"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/WarningDetail":{"id":"components/schemas/WarningDetail","kind":"json-schema","title":"WarningDetail","data":{"description":"Detailed child class of Warning","allOf":[{"$ref":"#/components/schemas/Warning"},{"properties":{"category":{"maxLength":128,"type":"string","description":"A category to assist in identifying the error","example":"INFORMATION"},"SourceID":{"maxLength":128,"type":"string","description":"The identifier of the source system sending the error or warning","example":"1G"},"SourceCode":{"maxLength":32,"type":"string","description":"The error or warning code returned by the source airline or host system","example":"1234"},"SourceDescription":{"maxLength":4096,"type":"string","description":"The error or warning message as it is returned by the source airline or host system"}}}]}},"components/schemas/PersonNameDetail":{"id":"components/schemas/PersonNameDetail","kind":"json-schema","title":"PersonNameDetail","data":{"description":"The extended class of Person Name.","allOf":[{"$ref":"#/components/schemas/PersonName"},{"properties":{"personNameType":{"$ref":"#/components/schemas/NameTypeEnum"},"language":{"type":"string","description":"'ISO639 code of the language the name is represented ","example":"EN"},"SurnamePrefix":{"maxLength":32,"type":"string","description":"The surname prefix","example":"Von"},"Suffix":{"maxLength":10,"type":"string","description":"Hold various name suffixes and letters","example":"Jr."},"Title":{"maxLength":32,"type":"string","description":"Degree or honors","example":"DR"},"Privacy":{"$ref":"#/components/schemas/Privacy"},"defaultInd":{"type":"boolean","description":"If true, this is the default or primary name within a collection of names.","example":true}}}]}},"components/schemas/NameTypeEnum":{"id":"components/schemas/NameTypeEnum","kind":"json-schema","title":"NameTypeEnum","data":{"type":"string","description":"OTA Code","enum":["Former","Nickname","Alternate","Maiden"]}},"components/schemas/Privacy":{"id":"components/schemas/Privacy","kind":"json-schema","title":"Privacy","data":{"properties":{"id":{"type":"string","description":"Optional internally referenced id","example":"2"},"shareMarketing":{"$ref":"#/components/schemas/YesNoInheritEnum"},"shareSync":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optOutInd":{"$ref":"#/components/schemas/YesNoInheritEnum"},"optInStatus":{"$ref":"#/components/schemas/OptInStatusEnum"},"optInDate":{"type":"string","description":"The datetime of receiving the opt in notice","format":"date-time","example":"2026-08-07T12:12:00Z"},"optOutDate":{"type":"string","description":"The datetime the opt out notice was received","format":"date-time","example":"2026-08-07T12:12:00Z"}},"description":"Confidential details for marketing purpose"}},"components/schemas/AddressDetail":{"id":"components/schemas/AddressDetail","kind":"json-schema","title":"AddressDetail","data":{"description":"The extended class of Address.","allOf":[{"$ref":"#/components/schemas/Address"},{"properties":{"addressType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for address type","example":"CLT"},"use":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"OTA code for address use","example":"AUT"},"Comment":{"$ref":"#/components/schemas/Comment"},"Privacy":{"$ref":"#/components/schemas/Privacy"},"Priority":{"type":"integer","description":"The priority ranking within the group","format":"int32","example":1},"validInd":{"type":"boolean","description":"If true, this is a valid and complete mailing address that has been verified through an address verification service or previously mailed materials have not been returned.","example":false},"provisionedInd":{"type":"boolean","description":"If true, this address came into the system through provisioning","example":false}}}]}},"components/schemas/Comment":{"id":"components/schemas/Comment","kind":"json-schema","title":"Comment","data":{"properties":{"value":{"maxLength":4096,"type":"string","description":"Actual text. May be restricted by character limits based on the type of comment (e.g. Notepad remarks limited to 87 characters).","example":"Additional comments"},"id":{"type":"string","description":"Local identifier within a given message for this object.","example":"comment_1"},"name":{"maxLength":128,"type":"string","description":"Title of comment or type of remark.","example":"Comment name"},"language":{"type":"string","description":"Language code using ISO-639 standard","example":"EN"}},"description":"Textual information."}},"components/schemas/TelephoneDetail":{"id":"components/schemas/TelephoneDetail","kind":"json-schema","title":"TelephoneDetail","data":{"description":"Extended class of Telephone","allOf":[{"$ref":"#/components/schemas/Telephone"},{"properties":{"phoneLocationType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Location of the phone","example":"Agency"},"phoneTechType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Indicates the type of technology associated with the telephone number","example":"Voice"},"phoneUseType":{"pattern":"[0-9A-Z]{1,3}(\\.[A-Z]{3}(\\.X){0,1}){0,1}","type":"string","description":"Agency code for how phone is used (e.g., Home, Business, Emergency Contact, Travel Arranger, Day, Evening).","example":"Home"},"pin":{"maxLength":32,"type":"string","description":"Additional codes used for telephone","example":"3456"},"priority":{"type":"integer","description":"Priority","format":"int32","example":1},"Privacy":{"$ref":"#/components/schemas/Privacy"},"Enum_TelephoneRole":{"$ref":"#/components/schemas/Enum_TelephoneRole"},"Comment":{"$ref":"#/components/schemas/Comment"},"defaultInd":{"type":"boolean","description":"When true, indicates a default value should be used.","example":true},"provisionedInd":{"type":"boolean","description":"true indicates this phone number was created through provisioned","example":false}}}]}},"components/schemas/ReferenceListTextBlock":{"id":"components/schemas/ReferenceListTextBlock","kind":"json-schema","title":"ReferenceListTextBlock","data":{"allOf":[{"$ref":"#/components/schemas/ReferenceList"},{"properties":{"TextBlock":{"type":"array","items":{"$ref":"#/components/schemas/TextBlock"}}}}]}},"components/schemas/TextBlock":{"id":"components/schemas/TextBlock","kind":"json-schema","title":"TextBlock","data":{"required":["@type","TextFormatted"],"properties":{"@type":{"type":"string","description":"Discriminator classes TextBlock or TextBlockDetail","example":"TextBlockDetail"},"title":{"maxLength":512,"type":"string","description":"\"The title of the rule or information. \nFor TermsAndConditionsFullHospitality, may include any of the following Rule Types; Promotional Data, Rate Description, Room Rate Data, Rate Text, Guarantee, Cancellation, Deposit, Check in/out, Room detail, Extra charges, Packages, Property, Location, Miscellaneous, Rate Amount, Alternate Rate Amount, Rate Comment, FAX, Phone, Special Information, Information, Room Hold Expiration Time. Not every property returns all of these types. Some properties do not return any title. Only English is supported for these values.\"","example":"Baggage Details"},"id":{"type":"string","description":"Internally referenced id","example":"2"},"TextFormatted":{"maxItems":50,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/TextFormatted"}}},"description":"Each instance is one rule or set of information."}},"components/schemas/TextFormatted":{"id":"components/schemas/TextFormatted","kind":"json-schema","title":"TextFormatted","data":{"properties":{"value":{"maxLength":4096,"type":"string","description":"The actual text of the hotel rule or information.","example":"ID Required Must Guarantee Late Arrival"},"language":{"type":"string","description":"The language in which the text or rule is provided.","example":"English"},"textFormat":{"$ref":"#/components/schemas/TextFormatEnum"}},"description":"Provides text, generally rules or information, and indicates how it is formatted."}},"components/schemas/TextFormatEnum":{"id":"components/schemas/TextFormatEnum","kind":"json-schema","title":"TextFormatEnum","data":{"type":"string","description":"Describes the format of text such as plain text or html","enum":["PlainText","HTML"]}},"schema_450":{"kind":"json-schema","data":{"type":"string","enum":["AUTH","REVS","VALD","AAVS"]},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"maxLength":100,"minLength":0,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"49f58f5f-c443-43b4-9f5d-be405fd00a01"},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"maxLength":89,"minLength":10,"type":"string","example":"TraceID_123456789"},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"maxLength":36,"minLength":36,"pattern":"([a-zA-Z-0-9-_]*)","type":"string","example":"19Y88702-C27A-4E5D-829A-89D7016688B1"},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"pattern":"^[a-zA-Z\\d]{3,4}_\\w{2}$","type":"string","example":"DU7_1G"},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"string","example":"gzip, deflate"},"id":"schema_455"}},"exampleStore":{"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data":{"value":{"@type":"PaymentCardAuthorizationQueryRequest","PaymentCardRequest":{"@type":"PaymentCardRequest","airlineMerchantCode":"AA","expireDate":"1223","agentSignOn":"ABC123BZ","localDateTime":"2026-09-82T09:45:00","paymentCardCode":"VI","PrimaryAccountNumber":"4012001037141112","CurrencyAmount":{"value":130,"code":"USD"},"AgencyPCCDetail":{"@type":"AgencyPCC","StateProv":"CO","PostalCode":"12345","agencyCode":"91212132","pseudoCityCode":"1CR","country":"US","codeAffinity":"1A","Currency":{"value":22.2,"code":"USD"},"City":{"value":"DEN","cityOrAirport":"City or Airport"}},"PromotionCode":{"promotionCode":"SUMMER22","promotionVendorCode":["300","234","657"]}}},"key":"minimum_required_data","summary":"Minimum Required data","id":"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data"},"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS":{"value":{"@type":"PaymentCardAuthorizationQueryRequest","PaymentCardRequest":{"@type":"PaymentCardRequest","airlineMerchantCode":"AA","expireDate":"1223","agentSignOn":"ABC123BZ","localDateTime":"2026-09-08T09:45:00","paymentCardCode":"DS","PrimaryAccountNumber":"6011406100000002","CurrencyAmount":{"value":130,"code":"USD"},"AgencyPCCDetail":{"@type":"AgencyPCC","StateProv":"CO","PostalCode":"12345","agencyCode":"91212132","pseudoCityCode":"1CR","country":"US","codeAffinity":"1A","Currency":{"value":22.2,"code":"USD"},"City":{"value":"DEN","cityOrAirport":"City or Airport"}},"PromotionCode":{"promotionCode":"SUMMER22","promotionVendorCode":["300","234","657"]}}},"key":"minimum_required_data_discover_exception_for_US_POS","summary":"Minimum Required data - discover exception for US POS","id":"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/minimum_required_data_discover_exception_for_US_POS"},"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data":{"value":{"@type":"PaymentCardAuthorizationQueryRequest","PaymentCardRequest":{"@type":"PaymentCardRequest","airlineMerchantCode":"AA","extendedPaymentInstallments":"06","expireDate":"1223","eCI":"05","cAVV":"AAACBGESJIMBIFMBZhIkAAAAAAA=","xID":"MDAwMDAwMDAwMDEyMzQ2Njc4OTA=","agentSignOn":"ZD1C05","localDateTime":"2026-09-08T09:45:00","paymentCardCode":"VI","PrimaryAccountNumber":"4012001037141112","CurrencyAmount":{"value":20066,"code":"USD"},"CardHolder":{"@type":"CardHolder","CardHolderName":"John Doe","IP4Address":"111.222.0.0","Person":{"@type":"PersonID","dob":"2011-01-24","PersonName":{"@type":"PersonNameDetail","Given":"John","Middle":"E","Surname":"Doe"},"Address":[{"@type":"AddressDetail","AddressLine":["123 Main St"],"City":"YourCity","StateProv":{"value":"CO"},"Country":{"value":"IN"},"PostalCode":"80010"}],"Telephone":[{"@type":"Telephone","role":"Mobile","phoneNumber":"5551212"}],"Email":[{"value":"happy.customer@travelport.com"}]}},"TravelInfoAir":{"@type":"TravelInfo","departureDate":"2026-11-28","numberOfTravelers":1,"fareBasisCode":"Y","LocatorCode":{"value":"ZXG25P","source":"1G"},"FirstFlightNumber":"1123","FirstFlightDepartureTime":"09:45:00-06:00","FirstSegmentClass":"F","AirportCodes":["DEN","ORD","DEN","DFW"],"AirlineCodes":["AA","BA","DL"]},"AgencyPCCDetail":{"@type":"AgencyPCC","StateProv":"CO","PostalCode":"12345","agencyCode":"91212132","pseudoCityCode":"1CR","country":"US","codeAffinity":"1A","Currency":{"value":22.2,"code":"USD"},"City":{"value":"DEN","cityOrAirport":"City or Airport"}},"PromotionCode":{"promotionCode":"SUMMER22","promotionVendorCode":["300","234","657"]}}},"key":"visa_3DS_data","summary":"Visa 3DS data","id":"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/visa_3DS_data"},"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data":{"value":{"@type":"PaymentCardAuthorizationQueryRequest","PaymentCardRequest":{"@type":"PaymentCardRequest","airlineMerchantCode":"XX","extendedPaymentInstallments":"0","expireDate":"1225","eCI":"00","uCAFIndicator":"0","agentSignOn":"ZD1C05","localDateTime":"2026-09-08T09:45:00","paymentCardSecurityCode":"134","paymentCardCode":"CA","PrimaryAccountNumber":"5204********0008","CurrencyAmount":{"value":5100,"code":"USD","mnorUnit":"2"},"AgencyPCCDetail":{"@type":"AgencyPCC","StateProv":"CO","PostalCode":"12345","agencyCode":"91212132","pseudoCityCode":"1CR","country":"US","codeAffinity":"1A","Currency":{"value":22.2,"code":"USD"},"City":{"value":"DEN","cityOrAirport":"City or Airport"}},"CardHolder":{"@type":"CardHolder","CardHolderName":"John Doe","IP4Address":"111.222.0.0","Person":{"@type":"PersonID","dob":"2011-01-24","PersonName":{"@type":"PersonNameDetail","Given":"John","Middle":"E","Surname":"Doe"},"Address":[{"@type":"AddressDetail","AddressLine":["123 Main St"],"City":"YourCity","StateProv":{"value":"CO"},"Country":{"value":"US"},"PostalCode":"80010"}],"Telephone":[{"@type":"Telephone","role":"Mobile","phoneNumber":"5551212.0"}],"Email":[{"value":"happy.customer@travelport.com"}]}},"TravelInfoAir":{"@type":"TravelInfo","departureDate":"2026-12-04","numberOfTravelers":1,"fareBasisCode":"Y","LocatorCode":{"value":"ZXG25P","source":"1G"},"FirstFlightNumber":"1123","FirstFlightDepartureTime":"09:45:00-06:00","FirstSegmentClass":"F","AirportCodes":["DEN","ORD","DEN","DFW"],"AirlineCodes":["AA","BA","DL"]},"PromotionCode":{"promotionCode":"SUMMER22","promotionVendorCode":["300","234","657"]}}},"key":"mastercard_3DS_data","summary":"MasterCard 3DS data","id":"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/mastercard_3DS_data"},"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI":{"value":{"@type":"PaymentCardAuthorizationQueryRequest","PaymentCardRequest":{"@type":"PaymentCardRequest","airlineMerchantCode":"DL","localDateTime":"2022-06-08T09:45:00","paymentCardCode":"VI","PrimaryAccountNumber":"4012001037141112","approvalCode":"00187C","expireDate":"1228","CurrencyAmount":{"value":130,"code":"USD"},"AgencyPCCDetail":{"@type":"AgencyPCC","StateProv":"CO","PostalCode":"12345","agencyCode":"91212132","pseudoCityCode":"1CR","country":"US","codeAffinity":"1A","Currency":{"value":22.2,"code":"USD"},"City":{"value":"DEN","cityOrAirport":"City or Airport"}},"PromotionCode":{"promotionCode":"SUMMER22","promotionVendorCode":["300","234","657"]}}},"key":"Revs/Deauth_VI","summary":"Revs/Deauth VI","id":"paths/~1paymentcardauthorizations~1{authType}/post/requestBody/content/application~1json/examples/Revs~1Deauth_VI"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/pay","isMockServer":true,"description":"Mock server"},{"url":"https://api.pp.travelport.net/11/payment"},{"url":"https://api.travelport.net/11/payment"}]},"options":{"hideDownloadButtons":true,"hideReplay":true,"jsonSamplesExpandLevel":3,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Payload"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/apis/pay","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/pay/@11.34/index.json?download"},{"url":"/_bundle/apis/pay/@11.34/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TripServices Pay","description":"The TripServices Pay v11 APIs allow online travel agencies to request credit card authorizations, card and address validations, and reversals against a specific merchant vendor."}},"baseSlug":"/apis/pay","routesMapping":{}}