The identity and technical contract details declared by the specification.
TransactionResponseCode
string
Code indicating the Shift4 host response. Value | Description | Details -------|-------------------------------------------------------------------------------…
AirlineTaxAmount
number
The tax amount
CustomerEnrollDate
string
Date of the user's first transaction in your system, regardless of payment method used. The date and time must be passed in ISO 8601 format including the timez…
OTAStartCity
string
OTA start city.
AirlineFlightLegsFlightNumber
string
Number of the airline flight to be taken on Leg of the trip.
CustomerAddressLine1
string
Cardholder’s street address exactly as it appears on their billing statement. This field is used in AVS.
MerchantName
string
The merchant’s business name as configured with Shift4.
CustomerLastName
string
Specifies a consumer’s last name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the re…
AirlinePassengerCode
string
The code supplied by the customer using a purchase card. Maximum 17 characters.
TransactionVendorReference
string
Optional field for information that can be searched in the merchant portal.
AirlinePassengerCountryCode
string
The passenger's nationality in ISO 3166 Alpha-2 format.
AmountTotal
number
The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.
SourceIP
string
Public source IP Address where the request originates, not the IP Address of the web server.
AirlineTicketsArrayPayPal
array
Array of ticket number and passenger name. Note: At least one instance of ticket number and passenger name info should be provided.
CustomerRegion
string
A level 2 country subdivision code according to ISO-3166-2.
AirlineIssueDate
string
The date the ticket was issued to the customer. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm).
CustomerCity
string
Customer address city.
OTARequestPayPal
object
Conditional: Utilize this object for Online Travel Agency transactions
7 properties
7 required
PayPalPaymentMethodId
string
Identifier for a single or multi-use payment token
MerchantMID
number
The merchant ID associated with the merchant account.
CustomerEmailAddress
string
Customer email address.
AirlineFlightLegsDestAirportCode
string
Indicates destination city's airport code for the leg.
PayPalPaymentMethodIdUsage
string
Dictates whether paymentMethodId returned will be single or multi-use payment token Value|Description -----|----------- S | Single Use M | Multiple Use
PayPalClientToken
string
A Base64 encoded string used to initialize client SDKs.
AirlinePassengerBirthDate
string
The passenger's date of birth in YYYY-MM-DD format
ServerName
string
The name of the server that processed the request.
AirlineRestrictedTicketIndicator
string
Indicates whether this ticket is non-refundable. Value | Description -------|------------------- 0 | No restriction 1 | Restricted (non-refundable) ticket
PayPalLegacyId
string
Legacy unique identifier.
AirlinePassengerArrivalDate
string
Date that the ticket holder is scheduled to arrive at their destination at the time of issuance of the original ticket. The date and time in ISO 8601 format in…
CustomerFirstName
string
Specifies a consumer’s first name. This field is used in AVS. If the interface sends this field, the value specified by the interface will be returned in the r…
DateTime
string
The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For ex…
TransactionInvoice
string
10-digit invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a ba…
PayPalClientMetaDataId
string
Identifier for completing risk check. Returned if transaction.ota is sent in the request.
AirlineFlightLegsServiceClass
string
Indicates service class for leg. Value | Description -------|--------------- FC | First Class BC | Business Class EC | Economy/Coach Class
PayPalCaptureId
string
If funds for the transaction have settled, the PayPal ID for the capture of funds.
PayPalAuthorizationId
string
If the transaction was successfully authorized, the PayPal ID for the authorization.
CustomerBrowserType
string
Internet browser or simply a browser.
AirlineConjunctionTicketIndicator
string
Indicates whether the itinerary contains more than four segments of travel. Value | Description -------|------------------- Y | Yes N | No
AirlineTravelAgencyCode
string
Code identifying travel agency if the ticket was issued by a travel agency. Conditional: Send if a travel agency service was used.
OTAStartCountry
string
OTA start country in ISO 3166 Alpha-2 format.; for example, country where bus ticket was purchased.
AmountTax
number
The amount of sales tax charged for a transaction. The tax amount is used by businesses to track tax expenses for accounting purposes. Identifying the tax amou…
AirlineTravelAgencyName
string
Name of travel agency if the ticket was issued by a travel agency. Conditional: Send if a travel agency service was used.
AirlineFlightLegsCouponNumber
number
Number of coupons in the ticket for the leg.
CustomerCountry
string
2 character ISO Country Code. See the [ISO](https://www.iso.org/obp/ui/search/code/) website for details.
OTAStartZipCode
string
OTA start zip code.
AirlineFlightLegsOriginAirportCode
string
Indicates origination city's airport code for the leg.
TransactionOriginalDate
string
The date and time of the original transaction request in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be an exact match…
AirlineTicketsTicketNumber
string
The ticket number provided by the Carrier for the passenger.
CustomerPhoneCountry
string
Country calling code of the phone number. Required when sending customer.phoneNumber.
MerchantResponse
object
2 properties
PayPalPayerId
string
The ID belonging to the PayPal account.
AirlineFlightLegsLegDepartureDateTime
string
The date and time the flight is scheduled to depart for the leg. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh…
AirlineExchangeTicketNumber
string
The original ticket number that was replaced by a new ticket number.
PayPalTransactionId
string
Unique identifier.
TransactionNotes
string
A free-form notes field that supports the use of HTML tags. This can be used for reference in [Lighthouse Transaction Manager](https://ltm.shift4test.com/) and…
AirlineRequestPayPal
object
Conditional: Utilize this object for Airline transactions
12 properties
4 required
AirlineFlightLegsLegArrivalDateTime
string
The date and time the flight is scheduled to arrive for the leg. The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh…
PayPalStatus
string
The current status of this transaction.
AirlineCarrierCode
string
The code of the airline carrier issuing the ticket.
AirlineFlightLegsCarrierCode
string
Code indicating name of carrier (United Airlines, Jet Blue, etc.) for the leg.
AirlineFlightLegsPayPal
object
14 properties
7 required
TransactionOriginalInvoice
string
The invoice number from the original sale. Used to link the refund to the original sale. Note: For US and Canadian processing: Although the invoice number is s…
AirlineTicketsPassengerName
string
Name of the passenger to whom the ticket was issued. This field contains the Passenger Name in format: SURNAME FIRSTNAME MIDDLEINITIAL TITLE Example: "Doe Jane…
AirlineTicketsPayPal
object
3 properties
2 required
OTAServiceEndDate
string
OTA service end date in YYYY-MM-DD format. A consumer booking a service such as a hotel for too many days elevates risk.
CustomerIpAddress
string
Public source IP Address where the request originates, not the IP Address of the web server.
AirlineFlightLegsFareBasis
string
This field contains primary and secondary discount codes that indicate the class of service and fare level associated with the ticket for the leg. Truncate at…
PayPalPaymentMethodNonce
string
A payment method nonce is a secure, one-time-use reference to payment information. It's the key element that allows your server to communicate sensitive paymen…
CustomerPhoneNumber
string
Customer phone number
AirlineTicketsTicketFare
number
Ticket fare is the total amount for each ticket, including service fee or any other fee for each ticket.
OTAChangeGuest
string
Whether the guest (the person being served) is able to be changed. Fraudsters tend to pay for services that can change the guest.
CustomerExternalId
string
Your external identifier for the Customer
PayPalOrderId
string
Additional information about the transaction.
PayPalDeviceData
string
The customer's device information.
TransactionAuthSource
string
In a response, a code returned by the processor to indicate which host issued the response. Value | Description -------|---------------------------- E | Engine…
OTAType
array
OTA transaction type array.
OTAServiceStartDate
string
OTA service start date in YYYY-MM-DD format. A service start date that is very close to the transaction date elevates risk.
AirlineFlightLegsStopOverCode
string
Indicates whether a stopover is allowed on this ticket for leg. The entry must be a D, O, or X. Value | Description -------|--------------- O | Stopover allowe…
AirlineFlightLegsArrayPayPal
array
Array of flight trip leg info. Maximun 4 legs to a trip allowed. Note: At least one instance of flight trip leg info should be provided.
CurrencyCode
string
Transaction currency code. See the [Currency Codes](/guides/appendices/currency-codes) section for details. Note: This is currently supported when processing f…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Shift4 publishes across the network.
