AirTicketingReq |
element |
|
|
|
Request to ticket a previously stored reservation. |
| RetrieveProviderReservationDetails |
boolean simple type |
|
Optional |
false |
|
| AuthorizedBy |
string simple type |
|
Optional |
|
Used in showing who authorized the request. Use is optional. |
| LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
| OverrideLogging |
string simple type |
TRACE , DEBUG , INFO , WARN , ERROR , FATAL |
Optional |
|
Use to override the default logging level |
| ReturnAmenities |
boolean simple type |
|
Optional |
false |
When set to true, Amenities information will be returned in the response. |
| ReturnSponsoredFlight |
boolean simple type |
|
Optional |
|
When set to true, Sponsored flight information will be returned in the response. |
| SponsoredFltTrnxId |
string simple type |
|
Optional |
|
Identifier for Sponsored Flight transaction information. |
| TargetBranch |
string simple type |
|
Optional |
|
Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified. |
| TokenId |
string simple type |
|
Optional |
|
Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| BulkTicket |
boolean simple type |
|
Optional |
false |
Provider: 1G,1V,1P. |
| ReturnInfoOnFail |
boolean simple type |
|
Optional |
true |
|
| ValidateSpanishResidency |
boolean simple type |
|
Optional |
false |
Provider: 1G - If set as true, Spanish Residency will be validated for
Provisioned Customers. |
| BillingPointOfSaleInfo |
element |
|
|
|
Point of Sale information for Billing |
| CIDBNumber |
integer simple type |
|
Optional |
|
A 10 Digit customer number generated by CIDB system. |
| OriginApplication |
string simple type |
|
Required |
|
Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user. |
| AgentIDOverride |
element |
|
|
|
Vendor specific agent identifier overrides to be used to access vendor systems. |
| AgentID |
string simple type |
|
Required |
|
The Agent ID for the applicable supplier/vendor |
| ProviderCode |
string simple type |
|
Required |
|
Provider code to route the AgentId to proper provider. |
| SupplierCode |
string simple type |
|
Optional |
|
Supplier code to determine which vendor this AgentId belongs to. |
| TerminalSessionInfo |
string simple type |
|
|
|
Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user |
| OverridePCC |
element |
|
|
|
Used to emulate to another PCC or SID. Providers: 1G, 1V, 1P. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| AirReservationLocatorCode |
element |
|
|
|
Identifies the AirReservation LocatorCode
within the Universal Record |
| AirPricingInfoRef |
element |
|
|
|
Provider: 1G,1V,1P-Indicates air pricing infos to be ticketed. |
| Key |
string simple type |
|
Required |
|
|
| BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
| Key |
string simple type |
|
Optional |
|
|
| LoyaltyCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DriversLicenseRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DiscountCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| PaymentRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| TicketingModifiersRef |
typeTicketingModifiersRef complex type |
|
|
|
Provider: 1P-Reference to a shared list of Ticketing Modifiers. This is supported for Worldspan providers only. When AirPricingInfoRef is used along with TicketingModifiersRef means that particular TicketingModifiers will to be applied while ticketing the Stored fare corresponding to the AirPricingInfo. Absence of AirPricingInfoRef means that particular TicketingModifiers will be applied to all Stored fares which are requested to be ticketed. |
| Key |
string simple type |
|
Required |
|
|
| AirPricingInfoRef |
element |
|
|
|
Reference to a AirPricing from a shared
list |
| Key |
string simple type |
|
Required |
|
|
| WaiverCode |
element |
|
|
|
Waiver code to override fare validations |
| Endorsement |
string simple type |
|
Optional |
|
Endorsement. Size can be up to 100
characters |
| TicketDesignator |
string simple type |
|
Optional |
|
|
| TourCode |
string simple type |
|
Optional |
|
|
| Commission |
element |
|
|
|
Identifies the agency commission |
| Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
| CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan,Galileo |
| Key |
string simple type |
|
Optional |
|
|
| Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
| Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
| Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
| Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
| Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
| DetailedBillingInformation |
element |
|
|
|
Container to send Detailed Billing
Information for ticketing |
| FormOfPaymentRef |
element |
|
|
|
A reference to a Form of Payment in the existing UR |
| Key |
string simple type |
|
Required |
|
|
| AirPricingInfoRef |
element |
|
|
|
Reference to a AirPricing from a shared
list |
| Key |
string simple type |
|
Required |
|
|
| BillingDetailItem |
element |
|
|
|
The Billing Details Information |
| DataType |
string simple type |
Alpha , Numeric , AlphaNumeric , Date |
Required |
|
Detailed Billing Information DataType
(Alpha, Numeric, etc.) |
| MaxLength |
string simple type |
|
Required |
|
Detailed Billing Information Maximum
Length. |
| MinLength |
string simple type |
|
Required |
|
Detailed Billing Information Minimum
Length. |
| Name |
string simple type |
PersonalId , CostAccountNumber , AccountNumber , ProjectNumber , ActionCode , DepartmentCode , AccountingUnit , OrderNumber , Destination , FileDate |
Required |
|
Detailed Billing Information Name(e.g
Personal ID, Account Number) |
| Value |
string simple type |
|
Optional |
|
Detailed Billing Information Value |
| FaxDetailsInformation |
element |
|
|
|
Container to send Fax details Information for ticketing |
| AirPricingInfoRef |
element |
|
|
|
Reference to a AirPricing from a shared
list |
| Key |
string simple type |
|
Required |
|
|
| FaxDetails |
element |
|
|
|
The Fax Details Information |
| DeptBillingCode |
string simple type |
|
Optional |
|
Department billing code. |
| From |
string simple type |
|
Optional |
|
From address. |
| IncludeCoverSheet |
boolean simple type |
|
Optional |
|
Specifies whether to include a cover page with fax or not. |
| InvoiceNumber |
string simple type |
|
Optional |
|
Invoice number. |
| To |
string simple type |
|
Optional |
|
To address. |
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| TermConditions |
element |
|
|
|
The terms and conditions to be included in Fax details |
| IncludeTermConditions |
boolean simple type |
|
Required |
|
Specifies whether Term and Conditions included in the Fax or not . |
| LanguageOption |
element |
|
|
|
Enables itineraries and invoices to print in different languages. |
| Country |
string simple type |
|
Required |
|
2 Letter ISO Country code |
| Language |
string simple type |
|
Required |
|
2 Letter ISO Language code |
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| AirTicketingModifiers |
element |
|
|
|
Modifiers used during ticketing |
| NoComparisonSFQ |
boolean simple type |
|
Optional |
false |
1P - Set to "true" to include the no comparison overide #NC to override the existing SFQ and issue the ticket. Only valid for AirTicketingReq, not valid for AirExchangeTicketingReq. |
| PlatingCarrier |
string simple type |
|
Optional |
|
The Plating Carrier used for this ticket |
| SuppressTaxAndFee |
boolean simple type |
|
Optional |
false |
Allow to suppress Taxand Fee in ticketing response.Providers supported: Worldspan. |
| TicketedFareOverride |
boolean simple type |
|
Optional |
false |
It is a modifier to allow re-issuance of tickets for stored fares which are already ticketed. Providers supported are 1P |
| DocumentModifiers |
element |
|
|
|
It is a modifier to allow re-issuance of tickets for stored fares which are already ticketed. Providers supported are 1P |
| GenerateAccountingInterface |
boolean simple type |
|
Optional |
false |
Generate interface message along with ticket |
| GenerateItineraryInvoice |
boolean simple type |
|
Optional |
false |
Generate itinerary/invoice documents along with
ticket |
| AirPricingInfoRef |
element |
|
|
|
Reference to a AirPricing from a shared
list |
| Key |
string simple type |
|
Required |
|
|
| TourCode |
element |
|
|
|
Tour Code Fare Basis |
| Value |
string simple type |
|
Required |
|
|
| TicketEndorsement |
element |
|
|
|
|
| Value |
string simple type |
|
Required |
|
|
| Commission |
element |
|
|
|
Identifies the agency commission |
| Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
| BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
| CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan,Galileo |
| Key |
string simple type |
|
Optional |
|
|
| Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
| Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
| Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
| Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
| Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
| FormOfPayment |
element |
|
|
|
A Form of Payment used to purchase all or part of
a booking. |
| AgentText |
string simple type |
|
Optional |
|
This is only relevent when IsAgentType is specified as true. Otherwise this will be ignored. |
| ExternalReference |
string simple type |
|
Optional |
|
|
| FulfillmentIDNumber |
string simple type |
|
Optional |
|
Identification number, e.g. card number, to define how the customer will identify himself when collecting the ticket |
| FulfillmentIDType |
string simple type |
Bahn Card , Credit Card , Euro Cheque Card , Collection Reference |
Optional |
|
Identification type, e.g. credit card, to define how the customer will identify himself when collecting the ticket |
| FulfillmentLocation |
string simple type |
|
Optional |
|
Information about the location of the printer. |
| FulfillmentType |
string simple type |
|
Optional |
|
Defines how the client wishes to receive travel documents. Type does not define where or how payment is made. The supported values are "Ticket on Departure",
"Travel Agency",
"Courier",
"Standard Mail",
"Ticketless",
"Ticket Office",
"Express Mail",
"Corporate Kiosk",
"Train Station Service Desk",
"Direct Printing of Ticket",
"Ticket by Email",
"Digital Printing of Ticket at Home",
"Retrieve Ticket at Eurostar in London"
Collect booking ticket at a Kiosk, print in agency. |
| IsAgentType |
boolean simple type |
|
Optional |
false |
If this is true then FormOfPayment mention in Type is anAgent type FormOfPayment. |
| Key |
string simple type |
|
Optional |
|
|
| ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
| ProfileKey |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
| Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
| ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
| Type |
string simple type |
|
Required |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| CreditCard |
element |
|
|
|
Container for all credit card information. |
| AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
| BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
| BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
| BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
| CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
| Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
| ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
| ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
| ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
| CVV |
string simple type |
|
Optional |
|
Card Verification Code |
| ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
| Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
| Number |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
| Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
| ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
| Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
| City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
| State |
element |
|
|
|
Container to house the state code for an address |
| PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
| Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| DebitCard |
element |
|
|
|
Container for all debit card information. |
| ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
| CVV |
string simple type |
|
Optional |
|
Card Verification Code |
| ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
| Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
| Number |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
| IssueNumber |
string simple type |
|
Optional |
|
Verification number for Debit Cards |
| Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
| ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
| Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
| City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
| State |
element |
|
|
|
Container to house the state code for an address |
| PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
| Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| EnettVan |
element |
|
|
|
Container for all eNett Van information. |
| ExpiryDays |
duration simple type |
|
Optional |
|
The number of days from the VAN generation date that the VAN will be active for, after which the VAN cannot be used. |
| MaxPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The maximum percentage that will be applied on the Total price and sent to enett, which will denote the maximum authorized amount as approved by eNett. This value will be ignored and not used for Multi-Use VAN’s. |
| MinPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The minimum percentage that will be applied on the Total price and sent to enett,which will denote the minimum authorized amount approved by eNett.uApi will default this to zero for multi-use Van's. |
| MultiUse |
boolean simple type |
|
Optional |
true |
Acceptable values are true or false. If set to true it will denote that the VAN being requested is multi-use else it will indicate a single -use VAN.A Single use VAN can only be debited once while the multiple use VAN's can be debited multiple times subjected to the maximum value it has been authorized for. The default value will be TRUE to indicate a multi-use VAN is being issued. |
| Certificate |
element |
|
|
|
Certificate Form of Payment |
| Amount |
string simple type |
|
Optional |
|
The monetary value of the certificate. |
| DiscountAmount |
string simple type |
|
Optional |
|
The monetary discount amount of this certificate. |
| DiscountPercentage |
decimal simple type |
|
Optional |
|
The percentage discount value of this certificate. |
| NotValidAfter |
date simple type |
|
Optional |
|
The date that this certificate expires. |
| NotValidBefore |
date simple type |
|
Optional |
|
The date that this certificate becomes valid. |
| Number |
string simple type |
|
Required |
|
The Certificate number |
| TicketNumber |
StringLength1to13 simple type |
|
|
|
The identifying number for the actual ticket |
| Check |
element |
|
|
|
Check Form of Payment |
| AccountNumber |
string simple type |
|
Optional |
|
The account number of the check |
| CheckNumber |
string simple type |
|
Optional |
|
The sequential check number of the check. |
| MICRNumber |
string simple type |
|
Optional |
|
Magnetic Ink Character Reader Number of check. |
| RoutingNumber |
string simple type |
|
Optional |
|
The bank routing number of the check. |
| Requisition |
element |
|
|
|
Requisition Form of Payment |
| Category |
string simple type |
Government , Other |
Optional |
|
Classification Category for the requisition payment |
| Number |
string simple type |
|
Optional |
|
Requisition number used for accounting |
| Type |
string simple type |
Cash , Credit |
Optional |
|
Type can be Cash or Credit for category as Government |
| MiscFormOfPayment |
element |
|
|
|
Miscellaneous Form of Payments |
| AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
| Category |
string simple type |
|
Required |
|
Indicates what Category the Miscellaneous Form Of Payment is being used for payment - The category may vary by GDS.Allowable values are
"Text"
"Credit"
"CreditCard"
"FreeFormCreditCard"
"Invoice"
"NonRefundable"
"MultipleReceivables"
"Exchange"
"Cash" |
| CreditCardNumber |
string simple type |
|
Optional |
|
|
| CreditCardType |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type or code which may not have been issued using the standard bank card types - i.e. an airline issued card |
| ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
| Text |
string simple type |
|
Optional |
|
Any free form text which may be associated with the Miscellaneous Form of Payment. This text may be provider or GDS specific |
| AgencyPayment |
typeAgencyPayment complex type |
|
|
|
Container for Agency Payment |
| AgencyBillingIdentifier |
string simple type |
|
Required |
|
Value of the billing id |
| AgencyBillingNumber |
string simple type |
|
Optional |
|
Value of billing number |
| AgencyBillingPassword |
string simple type |
|
Optional |
|
Value of billing password |
| UnitedNations |
element |
|
|
|
United Nations Form of Payments |
| Number |
string simple type |
|
Required |
|
|
| DirectPayment |
element |
|
|
|
Direct Payment Form of Payments |
| Text |
string simple type |
|
Optional |
|
|
| AgentVoucher |
element |
|
|
|
Agent Voucher Form of Payments |
| Number |
string simple type |
|
Required |
|
|
| PaymentAdvice |
element |
|
|
|
Contains other form of payment for Cruise
Reservations |
| DocumentNumber |
string simple type |
|
Required |
|
Payment Document Number Examples: 1234567890,
R7777 |
| IssueCity |
string simple type |
|
Required |
|
City code of document issuance |
| IssueDate |
date simple type |
|
Required |
|
Document Issuance date |
| OriginalFOP |
string simple type |
|
Optional |
|
Original form of payment Examples: CHECK 3500 |
| Type |
string simple type |
|
Required |
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
| ProviderReservationInfoRef |
typeFormOfPaymentPNRReference complex type |
|
|
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
| Key |
string simple type |
|
Optional |
|
Unique ID to identify a ProviderReservationInfo |
| ProviderReservationLevel |
boolean simple type |
|
Optional |
true |
It means that the form of payment is applied at ProviderReservation level. |
| SegmentRef |
typeGeneralReference complex type |
|
|
|
It means that the form of payment is applied at ProviderReservation level. |
| Key |
string simple type |
|
Required |
|
|
| BSPPayment |
element |
|
|
|
BSP form of payment.ACH Only |
| BSPIdentifier |
string simple type |
|
Required |
|
Value of the BSP Direct Bill id |
| BSPPassword |
string simple type |
|
Optional |
|
Value of the BSP Direct Bill id password |
| ARCPayment |
element |
|
|
|
ARC form of payment.ACH Only |
| ARCIdentifier |
string simple type |
|
Required |
|
Value of the ARC Direct Bill id |
| ARCPassword |
string simple type |
|
Optional |
|
Value of the ARC Direct Bill id password |
| CreditCardAuth |
element |
|
|
|
The result of a Credit Auth Request. Will contain all the authorization info and result codes. |
| AVSResultCode |
string simple type |
|
Optional |
|
The address verification result code (if AVS was requested) |
| Amount |
string simple type |
|
Required |
|
The amount that was authorized. |
| AuthCode |
string simple type |
|
Optional |
|
The authorization code to confirm card acceptance |
| AuthResultCode |
string simple type |
|
Required |
|
The result code of the authorization command. |
| FormOfPaymentRef |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Message |
string simple type |
|
Optional |
|
The message explains the result of the authorization command. |
| Number |
string simple type |
|
Optional |
|
|
| PaymentRef |
string simple type |
|
Optional |
|
|
| ProviderReservationInfoRef |
string simple type |
|
Optional |
|
|
| TransId |
string simple type |
|
Optional |
|
The transaction id from the credit processing system |
| Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
| Amount |
string simple type |
|
Required |
|
|
| AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
| ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
| BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
| FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
| Key |
string simple type |
|
Optional |
|
|
| Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
| Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| AirSegmentTicketingModifiers |
element |
|
|
|
Specifies modifiers that a particular segment should be priced with. If this is used, then there must be one for each AirSegment in the AirItinerary. |
| AirSegmentRef |
string simple type |
|
Optional |
|
|
| BrandTier |
string simple type |
|
Required |
|
Modifier to price by specific brand tier number. |