@paciolan/cybersource-sdk/dist/models/ptsv2payments-travel-information-transit-airline.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation } from './ptsv2payments-travel-information-transit-airline-ancillary-information';
import { Ptsv2paymentsTravelInformationTransitAirlineLegs } from './ptsv2payments-travel-information-transit-airline-legs';
import { Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer } from './ptsv2payments-travel-information-transit-airline-ticket-issuer';
/**
 *
 * @export
 * @interface Ptsv2paymentsTravelInformationTransitAirline
 */
export interface Ptsv2paymentsTravelInformationTransitAirline {
    /**
     * Specifies if the flight is: Domestic (01) International (02) If Y then 01 else 02
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    isDomestic?: string;
    /**
     * Reference number for the airline booking. Required if ticket numbers are not issued.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    bookingReferenceNumber?: string;
    /**
     * Airline that generated the ticket. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    carrierName?: string;
    /**
     *
     * @type {Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    ticketIssuer?: Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer;
    /**
     * Ticket number. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    ticketNumber?: string;
    /**
     * Check digit for the ticket number. CyberSource recommends that you validate the check digit. With Discover and Diners Club, a valid ticket number has these characteristics: - The value is numeric. - The first three digits are a valid IATA2 license plate carrier code. - The last digit is a check digit or zero (0). - All remaining digits are nonzero.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    checkDigit?: string;
    /**
     * Flag that indicates whether or not the ticket is restricted (nonrefundable). Possible values: - 0: No restriction (refundable) - 1: Restricted (nonrefundable) Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field.
     * @type {number}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    restrictedTicketIndicator?: number;
    /**
     * Type of charge. Possible values: - 01: Charge is for an airline ticket - 02: Charge is for an item that is not an airline ticket
     * @type {number}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    transactionType?: number;
    /**
     * The field is not currently supported.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    extendedPaymentCode?: string;
    /**
     * Name of the passenger to whom the ticket was issued.  This will always be a single passenger's name. If there are more than one passengers, provide only the primary passenger's name. Do not include special characters such as commas, hyphens, or apostrophes. Only ASCII characters are supported. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    passengerName?: string;
    /**
     * Reference number or code that identifies the cardholder. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    customerCode?: string;
    /**
     * Airline document type code that specifies the purpose of the transaction. Format: English characters only. Optional request field.  | Code | Description | | --- | --- | | 01 | Passenger ticket | | 02 | Additional collection | | 03 | Excess baggage | | 04 | Miscellaneous charge order (MCO) or prepaid ticket authorization | | 05 | Special service ticket | | 06 | Supported refund | | 07 | Unsupported refund | | 08 | Lost ticket application | | 09 | Tour order voucher | | 10 | Ticket by mail | | 11 | Undercharge adjustment | | 12 | Group ticket | | 13 | Exchange adjustment | | 14 | SPD or air freight | | 15 | In-flight adjustment | | 16 | Agency passenger ticket | | 17 | Agency tour order or voucher | | 18 | Agency miscellaneous charge order (MCO) | | 19 | Agency exchange order | | 20 | Agency group ticket | | 21 | Debit adjustment for duplicate refund or use | | 22 | In-flight merchandise order | | 23 | Catalogue merchandise order | | 24 | In-flight phone charges | | 25 | Frequent flyer fee or purchase | | 26 | Kennel charge | | 27 | Animal transportation charge | | 28 | Firearms case | | 29 | Upgrade charge | | 30 | Credit for unused transportation | | 31 | Credit for class of service adjustment | | 32 | Credit for denied boarding | | 33 | Credit for miscellaneous refund | | 34 | Credit for lost ticket refund | | 35 | Credit for exchange refund | | 36 | Credit for overcharge adjustment | | 37 | Credit for multiple Unused tickets | | 38 | Exchange order | | 39 | Self-service ticket | | 41 | In-flight duty-free purchase | | 42 | Senior citizen discount booklets | | 43 | Club membership fee | | 44 | Coupon book | | 45 | In-flight charges | | 46 | Tour deposit | | 47 | Frequent flyer overnight delivery charge | | 48 | Frequent flyer fulfillment | | 49 | Small package delivery | | 50 | Vendor sale | | 51 | Miscellaneous taxes or fees | | 52 | Travel agency fee | | 60 | Vendor refund or credit | | 64 | Duty free sale | | 65 | Preferred seat upgrade | | 66 | Cabin upgrade | | 67 | Lounge or club access or day pass | | 68 | Agent assisted reservation or ticketing fee | | 69 | Ticket change or cancel fee | | 70 | Trip insurance | | 71 | Unaccompanied minor | | 72 | Standby fee | | 73 | Curbside baggage | | 74 | In-flight medical equipment | | 75 | Ticket or pass print fee | | 76 | Checked sporting or special equipment | | 77 | Dry ice fee | | 78 | Mail or postage fee | | 79 | Club membership fee or temporary trial | | 80 | Frequent flyer activation or reinstatement | | 81 | Gift certificate | | 82 | Onboard or in-flight prepaid voucher | | 83 | Optional services fee | | 84 | Advance purchase for excess baggage | | 85 | Advance purchase for preferred seat upgrade | | 86 | Advance purchase for cabin upgrade | | 87 | Advance purchase for optional services | | 88 | WiFi | | 89 | Packages | | 90 | In-flight entertainment or internet access | | 91 | Overweight bag fee | | 92 | Sleep sets | | 93 | Special purchase fee |
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    documentType?: string;
    /**
     * The field is not currently supported.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    documentNumber?: string;
    /**
     * The field is not currently supported.
     * @type {number}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    documentNumberOfParts?: number;
    /**
     * Invoice number for the airline transaction.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    invoiceNumber?: string;
    /**
     * Invoice date. The format is YYYYMMDD. If this value is included in the request, it is used in the creation of the invoice number. See \"Invoice Number,\"
     * @type {number}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    invoiceDate?: number;
    /**
     * Description of the charge if the charge does not involve an airline ticket. For example: Excess baggage.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    additionalCharges?: string;
    /**
     * Total fee for the ticket. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    totalFeeAmount?: string;
    /**
     * Number that identifies the clearing message when multiple clearing messages are allowed per authorized transaction. Each clearing message linked to one authorization request must include a unique clearing sequence number between 1 and the total number of clearing records. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    clearingSequence?: string;
    /**
     * Total number of clearing messages associated with the authorization request. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    clearingCount?: string;
    /**
     * Total clearing amount for all transactions in the clearing count set. This value cannot exceed `99999999999999999999` (twenty 9s). Format: English characters only. If this field is not set and if the total amount from the original authorization is not NULL, the total clearing amount is set to the total amount from the original authorization.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    totalClearingAmount?: string;
    /**
     * Number of passengers for whom the ticket was issued. Format: English characters only. Optional request field.
     * @type {number}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    numberOfPassengers?: number;
    /**
     * Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    reservationSystemCode?: string;
    /**
     * Airline process identifier. This value is the airline's three-digit IATA1 code which is used to process extended payment airline tickets.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    processIdentifier?: string;
    /**
     * Date on which the transaction occurred. Format: `YYYYMMDD` Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    ticketIssueDate?: string;
    /**
     * Flag that indicates whether an electronic ticket was issued. Possible values: - `true` - `false` Optional request field.
     * @type {boolean}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    electronicTicketIndicator?: boolean;
    /**
     * Original ticket number when the transaction is for a replacement ticket.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    originalTicketNumber?: string;
    /**
     * Type of purchase. Possible values: - `EXC`: Exchange ticket - `MSC`: Miscellaneous (not a ticket purchase and not a transaction related to an exchange ticket) - `REF`: Refund - `TKT`: Ticket Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    purchaseType?: string;
    /**
     * Reason for the credit. Possible values: - `A`: Cancellation of the ancillary passenger transport purchase. - `B`: Cancellation of the airline ticket and the passenger transport ancillary purchase. - `C`: Cancellation of the airline ticket. - `O`: Other. - `P`: Partial refund of the airline ticket. Format: English characters only.  Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    creditReasonIndicator?: string;
    /**
     * Type of update. Possible values: - `C`: Change to the existing ticket. - `N`: New ticket. Format: English characters only Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    ticketChangeIndicator?: string;
    /**
     * Plan number based on the fare. This value is provided by the airline. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    planNumber?: string;
    /**
     * Date of arrival for the last leg of the trip. Format: `MMDDYYYY` English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    arrivalDate?: string;
    /**
     * Text that describes the ticket limitations, such as _nonrefundable_. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    restrictedTicketDesciption?: string;
    /**
     * Amount of the exchanged ticket. Format: English characters only.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    exchangeTicketAmount?: string;
    /**
     * Fee for exchanging the ticket. Format: English characters only. Optional request field.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    exchangeTicketFeeAmount?: string;
    /**
     * The field is not currently supported.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    reservationType?: string;
    /**
     * Boarding fee.
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    boardingFeeAmount?: string;
    /**
     *
     * @type {Array<Ptsv2paymentsTravelInformationTransitAirlineLegs>}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    legs?: Array<Ptsv2paymentsTravelInformationTransitAirlineLegs>;
    /**
     *
     * @type {Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    ancillaryInformation?: Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation;
    /**
     * Specifies the type of flight. One way (0) Return (1) Transit (2) Transit & Return (3) Multi-City (4)
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    flightType?: string;
    /**
     * The total cost of the flight insurance. Example: 10000.00
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    insuranceAmount?: string;
    /**
     * The consumer's frequent flyer number. Leave 0 if there is no frequent flyer number
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    frequentFlyerNumber?: string;
    /**
     * Specifies if the travel agent joins the flight (0) or not (1)
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    thirdPartyStatus?: string;
    /**
     * List of passenger types in a booking code: A (Adult) C (Child) Comma separated values for total number of passenger
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    passengerType?: string;
    /**
     * Total insurance amount. We have per leg and not total
     * @type {string}
     * @memberof Ptsv2paymentsTravelInformationTransitAirline
     */
    totalInsuranceAmount?: string;
}