RailRefundRsp |
element |
|
|
|
Returns rail cancel information. |
| CommandHistory |
string simple type |
|
Optional |
|
HTTP link to download command history and debugging information of the request that generated this response. Must be enabled on the system. |
| ResponseTime |
decimal simple type |
|
Optional |
|
The time (in ms) the system spent processing this request, not including transmission times. |
| SponsoredFltTrnxId |
string simple type |
|
Optional |
|
Identifier for Sponsored Flight transaction information. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| TransactionId |
string simple type |
|
Optional |
|
System generated unique identifier for this atomic transaction. |
| ResponseMessage |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
| Code |
decimal simple type |
|
Required |
|
|
| Type |
string simple type |
Warning , Error , Info |
Optional |
|
Indicates the type of message (Warning, Error, Info) |
| ProviderCode |
string simple type |
|
Optional |
|
|
| SupplierCode |
string simple type |
|
Optional |
|
|
| 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. |
| MCO |
element |
|
|
|
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. |
| MCONumber |
string simple type |
|
Optional |
|
The unique MCO number |
| MCOType |
string simple type |
|
Optional |
|
The Type of MCO. Once of Agency Fee, Airline Service Fee, or Residual value from an Exchange. |
| Status |
string simple type |
|
Optional |
|
Current status of the MCO |
| ExpiryDate |
date simple type |
|
Optional |
|
E-Voucher’s Expiry Date. This expiry date is specific to Rail product |
| IssueReasonCode |
string simple type |
|
Optional |
|
MCO issuing reason code. Possible Values (List): A - Air transportation, B - Surface transportationC - Bag shipped as cargo, D - Land arrgs for it, E - Car hire, F - Sleeper / berthG - Up-grading, H - Under collections, I - Taxes/fees/charges, J - Deposits down paymentsK - Refundable Balances, L - Hotel accommodations, M - Sundry charges, N - Cancellation feeO - Other, P thru Z - airline specific, 1 thru 9 - market specific |
| Location |
string simple type |
|
Optional |
|
Location of honoring carrier or operator. |
| MCODocNum |
string simple type |
|
Optional |
|
MCO document number. |
| MCOIssueDate |
dateTime simple type |
|
Optional |
|
Date and time in which the MCO was issued. |
| MCOIssued |
boolean simple type |
|
Required |
|
Set to true when the MCO is to be issued and set to false if it is stored for issue at a later time. |
| PlatingCarrier |
string simple type |
|
Optional |
|
The Plating Carrier for this MCO |
| ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider that houses this MCO. |
| ProviderLocatorCode |
string simple type |
|
Optional |
|
Contains the Provider Locator Code of the Provider Reservation that houses this MCO. |
| PseudoCityCode |
string simple type |
|
Optional |
|
The PCC in the host system. |
| TicketNumber |
string simple type |
|
Optional |
|
The ticket that this MCO was issued in connection with. Could be the ticket that caused the fee, a residual from an exchange, or an airline service fee. |
| TicketType |
string simple type |
|
Optional |
|
Ticket issue indicator. Possible values "Pre-paid ticket advice", "Ticket on departure" and "Other" . |
| TourCode |
string simple type |
|
Optional |
|
The Tour Code of the MCO. |
| TourOperator |
string simple type |
|
Optional |
|
Tour Operator - name of honoring carrier or operator. |
| PassengerInfo |
element |
|
|
|
Booking Traveler information tied to invoice |
| BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger related to a ticket. |
| PassengerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
| Name |
element |
|
|
|
Complete name fields |
| First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
| Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
| Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
| Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
| Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
| TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
| 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 |
| Endorsement |
element |
|
|
|
Restrictions or instructions about the fare or ticket |
| Value |
string simple type |
|
Required |
|
|
| MCOExchangeInfo |
element |
|
|
|
Information related to the exchange tickets available for the MCO |
| IATACode |
string simple type |
|
Optional |
|
IATA code of the issuing agency. |
| OriginalCityCode |
string simple type |
|
Optional |
|
Location of honoring carrier or operator. |
| OriginalTicketDate |
date simple type |
|
Optional |
|
Date that the Original ticket was issued. |
| OriginalTicketNumber |
string simple type |
|
Optional |
|
Airline form and serial number of the original ticket issued. |
| 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 |
| ExchangedCoupon |
element |
|
|
|
The coupon numbers that were used in the exchange process to create the MCO. |
| CouponNumber |
string simple type |
|
Optional |
|
Coupon numbers that were exchanged specific to this ticket |
| TicketNumber |
string simple type |
|
Required |
|
The ticket number for which the exchange coupons are present. |
| MCOFeeInfo |
element |
|
|
|
Information related to the PTA/TOD (Prepaid Ticket Advice / Ticket on Departure) related to the MCO |
| FeeAppliesToInd |
string simple type |
Per-Person , Per-MCO |
Optional |
|
Indicates if PTA/TOD fee is for the entire MCO or is per person. |
| Amount |
string simple type |
|
Optional |
|
The monetary amount. |
| Percentage |
string simple type |
|
Optional |
|
The percentage. |
| MCORemark |
element |
|
|
|
Information related to fare construction, free form text etc. of the MCO |
| AdditionalRmk |
boolean simple type |
|
Optional |
|
Indicates if the remark is additional remark or not. |
| MCOPriceData |
element |
|
|
|
Indicates if the remark is additional remark or not. |
| MCOAmount |
string simple type |
|
Required |
|
The total value of the MCO including any processing fees. |
| MCOEquivalentFare |
string simple type |
|
Optional |
|
Exchange value of the currency actually collected. |
| MCOTotalAmount |
string simple type |
|
Optional |
|
The Total amount for the MCO. |
| TaxInfo |
typeTaxInfo complex type |
|
|
|
The Total amount for the MCO. |
| CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
| Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
| CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
| FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
| Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
| ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
| SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
| SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
| TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
| Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
| Amount |
string simple type |
|
Required |
|
|
| CountryCode |
string simple type |
|
Optional |
|
|
| Description |
string simple type |
|
Optional |
|
|
| DestinationAirport |
string simple type |
|
Optional |
|
|
| FareInfoRef |
string simple type |
|
Optional |
|
|
| OriginAirport |
string simple type |
|
Optional |
|
|
| IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
| Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| Commission |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
| Amount |
string simple type |
|
Optional |
|
The monetary amount. |
| Percentage |
string simple type |
|
Optional |
|
The percentage. |
| StockControl |
element |
|
|
|
The Stock Control Numbers related details of the MCO. |
| Number |
string simple type |
|
Optional |
|
Stock control number. |
| Type |
string simple type |
|
Optional |
|
Stock control type valid options include: Pending, Failed, Plain Paper, Blank, Suppressed. |
| MCOText |
element |
|
|
|
All type of free format text messages related to MCO like - Command Text, Agent Entry, MCO Modifiers, Text Message |
| Type |
string simple type |
|
Optional |
|
The type of text. Possible values: Command Text, Agent Entry, MCO Modifiers, Text Message |