Universal Fraud APIs
Travel Extension Overview
Travel Complete Request Structure
4 min
Topic type: Reference
Purpose: Demonstrate the complete Universal Travel API request hierarchy and show where shared transaction fields, Travel extensions, flight information, lodging information, car rental information, cruise information, activity information, agency information, and insurance information appear within a request.
Audience: API integrators and client developers implementing the Universal Travel API.
Applies to: Universal Travel API preAuthTravel and postAuthTravel request structures.
Does not apply to: Authorization Update, Fulfillment Update, or Chargeback Update requests, which use separate request models.
This example combines multiple optional and conditional structures into a single request to demonstrate object hierarchy, field placement, and Travel-specific extensions.
Real-world requests typically contain only the structures applicable to the transaction being submitted.
postAuthTravel
The postAuthTravel structure includes the authorization and 3-D Secure fields available after authorization.
{
"transactionID": "TRV-ABC123456",
"transactionDateTime": "2022-03-11T17:07:24-07:00",
"eventSource": "web",
"accountID": "12363454566",
"isGuestCheckout": false,
"isAgenticCheckout": false,
"paymentAmount": 1082.91,
"taxAmount": 1.23,
"deliveryAmount": 5.99,
"currencyCode": "USD",
"success": false,
"ipAddress": "10.12.12.123",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0",
"deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
"devicePayload": "afklasdjlasdjl3l23j23423klj",
"ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
"ubaEvents": "lasjdlkfdsljelkrrjwl3kl324j32k432",
"emailAddress": "[email protected]",
"authenticationMethod": "magicLink",
"failureCode": "authFailed",
"brand": "acme",
"phoneNumber": "3125555555",
"latitude": 33.836,
"longitude": -117.914,
"accountStatus": "dormant",
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"purchaseType": "services",
"listingID": "travel-listing-001",
"isPaymentOptimization": false,
"is3DS": false,
"account": {
"isEnrolledInLoyaltyProgram": true,
"loyaltyNumber": "Id1234",
"accountLocale": "en-US",
"accountLevel": "Gold",
"accountType": "family",
"accountRegistrationDateTime": "2020-11-22T17:07:24-07:00",
"accountEmailUpdatedDateTime": "2020-08-28T19:00:00-04:00",
"accountPasswordUpdatedDateTime": "2021-06-15T10:30:00-07:00",
"dateOfBirth": "1985-11-15",
"loyaltyProgramName": "Members Plus",
"loyaltyPointsBalance": 987654321
},
"payment": {
"salesRepID": "SR#46k90",
"referralCode": "API 210315",
"isGift": true,
"isPaymentInInstallments": true,
"installmentAmount": 99.99,
"installmentCurrencyCode": "USD",
"installmentCount": 12,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-billing-001",
"addressType": "billing",
"primaryFlag": true,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Unit 1",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Acme Travel",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-shipping-002",
"addressType": "shipping",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Shipping Avenue",
"address2": "Unit 2",
"city": "Chicago",
"region": "IL",
"postCode": "60602",
"country": "US",
"companyName": "Acme Travel",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-lodging-003",
"addressType": "lodging",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "222 Marylebone Road",
"address2": "Unit 3",
"city": "London",
"region": "London",
"postCode": "NW1 6JQ",
"country": "GB",
"companyName": "The Landmark London",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-pickup-004",
"addressType": "pickup",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Northern Perimeter Road",
"address2": "Unit 4",
"city": "London",
"region": "London",
"postCode": "TW6 2RY",
"country": "GB",
"companyName": "Hertz Heathrow",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-return-005",
"addressType": "return",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Northern Perimeter Road",
"address2": "Unit 5",
"city": "London",
"region": "London",
"postCode": "TW6 2RY",
"country": "GB",
"companyName": "Hertz Heathrow",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-departure-006",
"addressType": "departure",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1015 North America Way",
"address2": "Unit 6",
"city": "Miami",
"region": "FL",
"postCode": "33132",
"country": "US",
"companyName": "PortMiami",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-return-007",
"addressType": "return",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1015 North America Way",
"address2": "Unit 7",
"city": "Miami",
"region": "FL",
"postCode": "33132",
"country": "US",
"companyName": "PortMiami",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-venue-008",
"addressType": "venue",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Riverside Building County Hall",
"address2": "Unit 8",
"city": "London",
"region": "London",
"postCode": "SE1 7PB",
"country": "GB",
"companyName": "London Eye",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"paymentMethods": [
{
"paymentType": "creditCard",
"paymentMethodID": "payment-credit-card-001",
"paymentMethodAmount": 399.0,
"isPaymentStoredOnFile": true,
"cardNumber": "4111111111111111",
"cardToken": "6f7%gf38hfUa",
"expirationMonth": "11",
"expirationYear": "2029",
"nameOnCreditCard": "Jane Doe",
"cardBin": "411111",
"cardLastFour": "1111",
"totalFailedAttempts": 1,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
"avsResult": "matched",
"cvvResult": "matched",
"cardAuthorizationCode": "A1B2C3",
"cardAuthorizationDateTime": "2022-03-11T17:07:25-07:00",
"isPreAuthorizationReject": false,
"postAuthorizationRejectReason": "creditReject",
"eciIndicator": "successful",
"isSCASoftDecline": false,
"sca3DSFlow": "frictionless",
"sca3DSVersion": "2.2.0",
"sca3DSChallengeRequestType": "02",
"sca3DSTransactionStatus": "Y",
"scaAuthorizationStatus": "approve",
"scaAuthorizationError": "decline"
},
{
"paymentType": "digitalWallet",
"paymentMethodID": "payment-wallet-001",
"paymentMethodAmount": 100.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"walletType": "Apple Pay",
"walletStatus": "active",
"isWalletProtectionEligible": true,
"paymentMethodBalanceAmount": 4000.32,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
},
{
"paymentType": "giftCard",
"paymentMethodID": "payment-gift-card-001",
"paymentMethodAmount": 75.0,
"isPaymentStoredOnFile": false,
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678",
"expirationDay": "09",
"expirationMonth": "11",
"expirationYear": "2029",
"paymentMethodBalanceAmount": 150.0,
"totalFailedAttempts": 0,
"addressID": "address-billing-001"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "payment-bank-account-001",
"paymentMethodAmount": 100.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"paymentMethodBalanceAmount": 2500.0,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "payment-loyalty-001",
"paymentMethodAmount": 50.0,
"isPaymentStoredOnFile": true,
"points": 50000,
"loyaltyProgramName": "Members Plus",
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "cash",
"paymentMethodID": "payment-cash-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false
},
{
"paymentType": "check",
"paymentMethodID": "payment-check-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "payment-crypto-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "payment-eft-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"addressID": "address-billing-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "payment-invoice-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Acme Travel",
"addressID": "address-billing-001"
},
{
"paymentType": "loan",
"paymentMethodID": "payment-loan-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "payment-money-order-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "secCard",
"paymentMethodID": "payment-sec-card-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "payment-store-credit-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"paymentMethodBalanceAmount": 250.0
},
{
"paymentType": "thirdParty",
"paymentMethodID": "payment-third-party-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "payment-voucher-001",
"paymentMethodAmount": 8.91,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
}
],
"items": [
{
"itemType": "giftCard",
"brandName": "Acme Travel",
"description": "giftCard travel item",
"category": "Travel",
"itemID": "travel-giftCard-001",
"isHighRiskItem": true,
"price": 101.0,
"faceValueAmount": 126.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK001",
"promoCode": "TRVPROMO01",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "parking",
"brandName": "Acme Travel",
"description": "parking travel item",
"category": "Travel",
"itemID": "travel-parking-001",
"isHighRiskItem": false,
"price": 102.0,
"faceValueAmount": 127.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK002",
"promoCode": "TRVPROMO02",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "physicalGood",
"brandName": "Acme Travel",
"description": "physicalGood travel item",
"category": "Travel",
"itemID": "travel-physicalGood-001",
"isHighRiskItem": false,
"price": 103.0,
"faceValueAmount": 128.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "ups",
"companyName": "Acme Travel",
"shippingMethod": "ground",
"shippingTrackingNumber": "TRVTRACK003",
"promoCode": "TRVPROMO03",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "reservation",
"brandName": "Acme Travel",
"description": "reservation travel item",
"category": "Travel",
"itemID": "travel-reservation-001",
"isHighRiskItem": false,
"price": 104.0,
"faceValueAmount": 129.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK004",
"promoCode": "TRVPROMO04",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "subscription",
"brandName": "Acme Travel",
"description": "subscription travel item",
"category": "Travel",
"itemID": "travel-subscription-001",
"isHighRiskItem": false,
"price": 105.0,
"faceValueAmount": 130.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK005",
"promoCode": "TRVPROMO05",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "ticket",
"brandName": "Acme Travel",
"description": "ticket travel item",
"category": "Travel",
"itemID": "travel-ticket-001",
"isHighRiskItem": true,
"price": 106.0,
"faceValueAmount": 131.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK006",
"promoCode": "TRVPROMO06",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "other",
"brandName": "Acme Travel",
"description": "other travel item",
"category": "Travel",
"itemID": "travel-other-001",
"isHighRiskItem": false,
"price": 107.0,
"faceValueAmount": 132.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "other",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK007",
"promoCode": "TRVPROMO07",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
}
],
"promotions": [
{
"promoCode": "PROMO01",
"promoAmount": 5.0,
"promoType": "bogo"
},
{
"promoCode": "PROMO02",
"promoAmount": 10.0,
"promoType": "bundle"
},
{
"promoCode": "PROMO03",
"promoAmount": 15.0,
"promoType": "employeeDiscount"
},
{
"promoCode": "PROMO04",
"promoAmount": 20.0,
"promoType": "freeShipping"
},
{
"promoCode": "PROMO05",
"promoAmount": 25.0,
"promoType": "loyaltyDiscount"
},
{
"promoCode": "PROMO06",
"promoAmount": 30.0,
"promoType": "newMemberDiscount"
},
{
"promoCode": "PROMO07",
"promoAmount": 35.0,
"promoType": "percentage"
},
{
"promoCode": "PROMO08",
"promoAmount": 40.0,
"promoType": "quantityPromotion"
},
{
"promoCode": "PROMO09",
"promoAmount": 45.0,
"promoType": "other"
}
],
"flightInformation": {
"pnr": "ABC123",
"flightType": "round-trip",
"isThirdPartyBooking": true,
"fareBasisCode": "YLOWUS",
"otaIdentificationNumber": "OTA12345",
"otaName": "Expedia",
"initialDepartingAirport": "ORD",
"finalArrivalAirport": "LHR",
"numberOfPassengers": 1,
"segments": [
{
"routeInfo": "ORD-LHR",
"airlineName": "American Airlines",
"operatingAirline": "British Airways",
"flightNumber": "BA294",
"ticketClass": "business",
"fareClass": "J",
"specialFareType": "corporate",
"isAwardTicket": false,
"departureDateTime": "2022-04-15T17:00:00-05:00",
"departureAirportCode": "ORD",
"arrivalDateTime": "2022-04-16T07:00:00+01:00",
"arrivalAirportCode": "LHR",
"isFinalDestination": true
}
],
"passengers": [
{
"passengerID": "PAX001",
"ticketNumber": "0012345678901",
"passengerDateOfBirth": "1985-11-15",
"passengerGender": "F",
"passengerAdultOrChild": "adult",
"passengerTitle": "Ms",
"passengerFirstName": "Jane",
"passengerMiddleName": "Marie",
"passengerLastName": "Doe",
"passengerFullName": "Jane Marie Doe",
"passengerPhone": "3125555555",
"passengerPhoneCountryCode": "1",
"passengerEmailAddress": "[email protected]",
"passengerCheckedBaggageCount": 1,
"passengerLoyaltyNumber": "AA123456",
"passengerLoyaltySinceDate": "2015-06-01",
"passengerLoyaltyLevel": "Gold",
"passengerPassportNumber": "A12345678",
"passengerPassportCountryCode": "US",
"passengerPassportExpirationDate": "2030-06-01"
}
]
},
"lodgingInformation": {
"lodgingDetails": [
{
"lodgingName": "The Landmark London",
"lodgingPropertyID": "LDMRK001",
"lodgingChainName": "Independent",
"lodgingAmount": 350.0,
"lodgingAmountCurrencyCode": "GBP",
"lodgingRoomOccupancy": 2,
"lodgingBedType": "King",
"lodgingRoomType": "Deluxe",
"lodgingComments": "Non-smoking room requested",
"lodgingCheckInDateTime": "2022-04-16T15:00:00+01:00",
"lodgingCheckOutDateTime": "2022-04-20T11:00:00+01:00",
"lodgingAddressID": "address-lodging-003"
}
],
"guests": [
{
"guestFirstName": "Jane",
"guestMiddleName": "Marie",
"guestLastName": "Doe"
}
]
},
"carRentalInformation": {
"carRentalDetails": [
{
"carRentalBrand": "Hertz",
"carRentalAmount": 210.0,
"carRentalCurrencyCode": "GBP",
"rentalType": "daily",
"rentalClass": "compact",
"pickupAddressID": "address-pickup-004",
"pickUpDateTime": "2022-04-16T16:00:00+01:00",
"returnAddressID": "address-return-005",
"returnDateTime": "2022-04-20T10:00:00+01:00"
}
]
},
"cruiseInformation": {
"cruiseDetails": [
{
"cruiseBrand": "Royal Caribbean",
"cruiseAmount": 1500.0,
"cruiseCurrencyCode": "USD",
"cruiseDepartureAddressID": "address-departure-006",
"cruiseInitialStartDateTime": "2022-06-01T16:00:00-04:00",
"cruiseReturnAddressID": "address-return-007",
"cruiseFinalReturnDateTime": "2022-06-08T09:00:00-04:00"
}
]
},
"activityInformation": {
"activityDetails": [
{
"activitySupplier": "London Eye",
"activityName": "Thames River Cruise",
"activityAmount": 45.0,
"activityAmountCurrencyCode": "GBP",
"activityAddressID": "address-venue-008",
"activityStartDateTime": "2022-04-17T14:00:00+01:00"
}
]
},
"agencyInformation": {
"agencyDetails": [
{
"agencyCode": "01234ABC",
"agencyName": "Acme Travel Inc",
"agencySalesRepresentativeID": "232324521",
"agencyConfirmationNumber": "ABC123",
"agencyCountryCode": "US",
"agencyEmail": "[email protected]",
"agencyHeadOffice": "Chicago",
"agencyPhone": "13125555555"
}
]
},
"insuranceInformation": {
"insuranceDetails": [
{
"insuranceType": "travel",
"insuranceCity": "Chicago",
"insuranceCountryCode": "US",
"insuranceStartDateTime": "2022-04-15T00:00:00-05:00",
"insuranceEndDateTime": "2022-04-21T00:00:00-05:00",
"insuranceName": "Acme Travel Insurance Full Cover",
"insuranceReservationName": "Jane Doe",
"insuranceTotalAmount": 399.04,
"insuranceCurrencyCode": "USD"
}
]
}
}
preAuthTravel
The preAuthTravel request omits the post-authorization fields from the "credit card" example under paymentMethods[] block.
{
"transactionID": "TRV-ABC123456",
"transactionDateTime": "2022-03-11T17:07:24-07:00",
"eventSource": "web",
"accountID": "12363454566",
"isGuestCheckout": false,
"isAgenticCheckout": false,
"paymentAmount": 1082.91,
"taxAmount": 1.23,
"deliveryAmount": 5.99,
"currencyCode": "USD",
"success": false,
"ipAddress": "10.12.12.123",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0",
"deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
"devicePayload": "afklasdjlasdjl3l23j23423klj",
"ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
"ubaEvents": "lasjdlkfdsljelkrrjwl3kl324j32k432",
"emailAddress": "[email protected]",
"authenticationMethod": "magicLink",
"failureCode": "authFailed",
"brand": "acme",
"phoneNumber": "3125555555",
"latitude": 33.836,
"longitude": -117.914,
"accountStatus": "dormant",
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"purchaseType": "services",
"listingID": "travel-listing-001",
"isPaymentOptimization": false,
"is3DS": false,
"account": {
"isEnrolledInLoyaltyProgram": true,
"loyaltyNumber": "Id1234",
"accountLocale": "en-US",
"accountLevel": "Gold",
"accountType": "family",
"accountRegistrationDateTime": "2020-11-22T17:07:24-07:00",
"accountEmailUpdatedDateTime": "2020-08-28T19:00:00-04:00",
"accountPasswordUpdatedDateTime": "2021-06-15T10:30:00-07:00",
"dateOfBirth": "1985-11-15",
"loyaltyProgramName": "Members Plus",
"loyaltyPointsBalance": 987654321
},
"payment": {
"salesRepID": "SR#46k90",
"referralCode": "API 210315",
"isGift": true,
"isPaymentInInstallments": true,
"installmentAmount": 99.99,
"installmentCurrencyCode": "USD",
"installmentCount": 12,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-billing-001",
"addressType": "billing",
"primaryFlag": true,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Unit 1",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Acme Travel",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-shipping-002",
"addressType": "shipping",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Shipping Avenue",
"address2": "Unit 2",
"city": "Chicago",
"region": "IL",
"postCode": "60602",
"country": "US",
"companyName": "Acme Travel",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-lodging-003",
"addressType": "lodging",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "222 Marylebone Road",
"address2": "Unit 3",
"city": "London",
"region": "London",
"postCode": "NW1 6JQ",
"country": "GB",
"companyName": "The Landmark London",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-pickup-004",
"addressType": "pickup",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Northern Perimeter Road",
"address2": "Unit 4",
"city": "London",
"region": "London",
"postCode": "TW6 2RY",
"country": "GB",
"companyName": "Hertz Heathrow",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-return-005",
"addressType": "return",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Northern Perimeter Road",
"address2": "Unit 5",
"city": "London",
"region": "London",
"postCode": "TW6 2RY",
"country": "GB",
"companyName": "Hertz Heathrow",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-departure-006",
"addressType": "departure",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1015 North America Way",
"address2": "Unit 6",
"city": "Miami",
"region": "FL",
"postCode": "33132",
"country": "US",
"companyName": "PortMiami",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-return-007",
"addressType": "return",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1015 North America Way",
"address2": "Unit 7",
"city": "Miami",
"region": "FL",
"postCode": "33132",
"country": "US",
"companyName": "PortMiami",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-venue-008",
"addressType": "venue",
"primaryFlag": false,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "Riverside Building County Hall",
"address2": "Unit 8",
"city": "London",
"region": "London",
"postCode": "SE1 7PB",
"country": "GB",
"companyName": "London Eye",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"paymentMethods": [
{
"paymentType": "creditCard",
"paymentMethodID": "payment-credit-card-001",
"paymentMethodAmount": 399.0,
"isPaymentStoredOnFile": true,
"cardNumber": "4111111111111111",
"cardToken": "6f7%gf38hfUa",
"expirationMonth": "11",
"expirationYear": "2029",
"nameOnCreditCard": "Jane Doe",
"cardBin": "411111",
"cardLastFour": "1111",
"totalFailedAttempts": 1,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
},
{
"paymentType": "digitalWallet",
"paymentMethodID": "payment-wallet-001",
"paymentMethodAmount": 100.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"walletType": "Apple Pay",
"walletStatus": "active",
"isWalletProtectionEligible": true,
"paymentMethodBalanceAmount": 4000.32,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
},
{
"paymentType": "giftCard",
"paymentMethodID": "payment-gift-card-001",
"paymentMethodAmount": 75.0,
"isPaymentStoredOnFile": false,
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678",
"expirationDay": "09",
"expirationMonth": "11",
"expirationYear": "2029",
"paymentMethodBalanceAmount": 150.0,
"totalFailedAttempts": 0,
"addressID": "address-billing-001"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "payment-bank-account-001",
"paymentMethodAmount": 100.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"paymentMethodBalanceAmount": 2500.0,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "address-billing-001"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "payment-loyalty-001",
"paymentMethodAmount": 50.0,
"isPaymentStoredOnFile": true,
"points": 50000,
"loyaltyProgramName": "Members Plus",
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "cash",
"paymentMethodID": "payment-cash-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false
},
{
"paymentType": "check",
"paymentMethodID": "payment-check-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "payment-crypto-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "payment-eft-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"addressID": "address-billing-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "payment-invoice-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Acme Travel",
"addressID": "address-billing-001"
},
{
"paymentType": "loan",
"paymentMethodID": "payment-loan-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "payment-money-order-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "secCard",
"paymentMethodID": "payment-sec-card-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "payment-store-credit-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"paymentMethodBalanceAmount": 250.0
},
{
"paymentType": "thirdParty",
"paymentMethodID": "payment-third-party-001",
"paymentMethodAmount": 25.0,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "address-billing-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "payment-voucher-001",
"paymentMethodAmount": 8.91,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
}
],
"items": [
{
"itemType": "giftCard",
"brandName": "Acme Travel",
"description": "giftCard travel item",
"category": "Travel",
"itemID": "travel-giftCard-001",
"isHighRiskItem": true,
"price": 101.0,
"faceValueAmount": 126.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK001",
"promoCode": "TRVPROMO01",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "parking",
"brandName": "Acme Travel",
"description": "parking travel item",
"category": "Travel",
"itemID": "travel-parking-001",
"isHighRiskItem": false,
"price": 102.0,
"faceValueAmount": 127.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK002",
"promoCode": "TRVPROMO02",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "physicalGood",
"brandName": "Acme Travel",
"description": "physicalGood travel item",
"category": "Travel",
"itemID": "travel-physicalGood-001",
"isHighRiskItem": false,
"price": 103.0,
"faceValueAmount": 128.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "ups",
"companyName": "Acme Travel",
"shippingMethod": "ground",
"shippingTrackingNumber": "TRVTRACK003",
"promoCode": "TRVPROMO03",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "reservation",
"brandName": "Acme Travel",
"description": "reservation travel item",
"category": "Travel",
"itemID": "travel-reservation-001",
"isHighRiskItem": false,
"price": 104.0,
"faceValueAmount": 129.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK004",
"promoCode": "TRVPROMO04",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "subscription",
"brandName": "Acme Travel",
"description": "subscription travel item",
"category": "Travel",
"itemID": "travel-subscription-001",
"isHighRiskItem": false,
"price": 105.0,
"faceValueAmount": 130.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK005",
"promoCode": "TRVPROMO05",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "ticket",
"brandName": "Acme Travel",
"description": "ticket travel item",
"category": "Travel",
"itemID": "travel-ticket-001",
"isHighRiskItem": true,
"price": 106.0,
"faceValueAmount": 131.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "new",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK006",
"promoCode": "TRVPROMO06",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
},
{
"itemType": "other",
"brandName": "Acme Travel",
"description": "other travel item",
"category": "Travel",
"itemID": "travel-other-001",
"isHighRiskItem": false,
"price": 107.0,
"faceValueAmount": 132.0,
"quantity": 1,
"addressID": "address-shipping-002",
"productCondition": "other",
"shippingCompany": "other",
"companyName": "Acme Travel",
"shippingMethod": "digital",
"shippingTrackingNumber": "TRVTRACK007",
"promoCode": "TRVPROMO07",
"promoAmount": 10.0,
"promoType": "percentage",
"pickupLocation": "other",
"pickupDateTime": "2022-04-16T14:00:00+01:00",
"pickupPersonFirstName": "Jane",
"pickupPersonLastName": "Doe"
}
],
"promotions": [
{
"promoCode": "PROMO01",
"promoAmount": 5.0,
"promoType": "bogo"
},
{
"promoCode": "PROMO02",
"promoAmount": 10.0,
"promoType": "bundle"
},
{
"promoCode": "PROMO03",
"promoAmount": 15.0,
"promoType": "employeeDiscount"
},
{
"promoCode": "PROMO04",
"promoAmount": 20.0,
"promoType": "freeShipping"
},
{
"promoCode": "PROMO05",
"promoAmount": 25.0,
"promoType": "loyaltyDiscount"
},
{
"promoCode": "PROMO06",
"promoAmount": 30.0,
"promoType": "newMemberDiscount"
},
{
"promoCode": "PROMO07",
"promoAmount": 35.0,
"promoType": "percentage"
},
{
"promoCode": "PROMO08",
"promoAmount": 40.0,
"promoType": "quantityPromotion"
},
{
"promoCode": "PROMO09",
"promoAmount": 45.0,
"promoType": "other"
}
],
"flightInformation": {
"pnr": "ABC123",
"flightType": "round-trip",
"isThirdPartyBooking": true,
"fareBasisCode": "YLOWUS",
"otaIdentificationNumber": "OTA12345",
"otaName": "Expedia",
"initialDepartingAirport": "ORD",
"finalArrivalAirport": "LHR",
"numberOfPassengers": 1,
"segments": [
{
"routeInfo": "ORD-LHR",
"airlineName": "American Airlines",
"operatingAirline": "British Airways",
"flightNumber": "BA294",
"ticketClass": "business",
"fareClass": "J",
"specialFareType": "corporate",
"isAwardTicket": false,
"departureDateTime": "2022-04-15T17:00:00-05:00",
"departureAirportCode": "ORD",
"arrivalDateTime": "2022-04-16T07:00:00+01:00",
"arrivalAirportCode": "LHR",
"isFinalDestination": true
}
],
"passengers": [
{
"passengerID": "PAX001",
"ticketNumber": "0012345678901",
"passengerDateOfBirth": "1985-11-15",
"passengerGender": "F",
"passengerAdultOrChild": "adult",
"passengerTitle": "Ms",
"passengerFirstName": "Jane",
"passengerMiddleName": "Marie",
"passengerLastName": "Doe",
"passengerFullName": "Jane Marie Doe",
"passengerPhone": "3125555555",
"passengerPhoneCountryCode": "1",
"passengerEmailAddress": "[email protected]",
"passengerCheckedBaggageCount": 1,
"passengerLoyaltyNumber": "AA123456",
"passengerLoyaltySinceDate": "2015-06-01",
"passengerLoyaltyLevel": "Gold",
"passengerPassportNumber": "A12345678",
"passengerPassportCountryCode": "US",
"passengerPassportExpirationDate": "2030-06-01"
}
]
},
"lodgingInformation": {
"lodgingDetails": [
{
"lodgingName": "The Landmark London",
"lodgingPropertyID": "LDMRK001",
"lodgingChainName": "Independent",
"lodgingAmount": 350.0,
"lodgingAmountCurrencyCode": "GBP",
"lodgingRoomOccupancy": 2,
"lodgingBedType": "King",
"lodgingRoomType": "Deluxe",
"lodgingComments": "Non-smoking room requested",
"lodgingCheckInDateTime": "2022-04-16T15:00:00+01:00",
"lodgingCheckOutDateTime": "2022-04-20T11:00:00+01:00",
"lodgingAddressID": "address-lodging-003"
}
],
"guests": [
{
"guestFirstName": "Jane",
"guestMiddleName": "Marie",
"guestLastName": "Doe"
}
]
},
"carRentalInformation": {
"carRentalDetails": [
{
"carRentalBrand": "Hertz",
"carRentalAmount": 210.0,
"carRentalCurrencyCode": "GBP",
"rentalType": "daily",
"rentalClass": "compact",
"pickupAddressID": "address-pickup-004",
"pickUpDateTime": "2022-04-16T16:00:00+01:00",
"returnAddressID": "address-return-005",
"returnDateTime": "2022-04-20T10:00:00+01:00"
}
]
},
"cruiseInformation": {
"cruiseDetails": [
{
"cruiseBrand": "Royal Caribbean",
"cruiseAmount": 1500.0,
"cruiseCurrencyCode": "USD",
"cruiseDepartureAddressID": "address-departure-006",
"cruiseInitialStartDateTime": "2022-06-01T16:00:00-04:00",
"cruiseReturnAddressID": "address-return-007",
"cruiseFinalReturnDateTime": "2022-06-08T09:00:00-04:00"
}
]
},
"activityInformation": {
"activityDetails": [
{
"activitySupplier": "London Eye",
"activityName": "Thames River Cruise",
"activityAmount": 45.0,
"activityAmountCurrencyCode": "GBP",
"activityAddressID": "address-venue-008",
"activityStartDateTime": "2022-04-17T14:00:00+01:00"
}
]
},
"agencyInformation": {
"agencyDetails": [
{
"agencyCode": "01234ABC",
"agencyName": "Acme Travel Inc",
"agencySalesRepresentativeID": "232324521",
"agencyConfirmationNumber": "ABC123",
"agencyCountryCode": "US",
"agencyEmail": "[email protected]",
"agencyHeadOffice": "Chicago",
"agencyPhone": "13125555555"
}
]
},
"insuranceInformation": {
"insuranceDetails": [
{
"insuranceType": "travel",
"insuranceCity": "Chicago",
"insuranceCountryCode": "US",
"insuranceStartDateTime": "2022-04-15T00:00:00-05:00",
"insuranceEndDateTime": "2022-04-21T00:00:00-05:00",
"insuranceName": "Acme Travel Insurance Full Cover",
"insuranceReservationName": "Jane Doe",
"insuranceTotalAmount": 399.04,
"insuranceCurrencyCode": "USD"
}
]
}
}
Pre-Auth omits these fields:
- avsResult
- cvvResult
- cardAuthorizationCode
- cardAuthorizationDateTime
- isPreAuthorizationReject
- postAuthorizationRejectReason
- eciIndicator
- isSCASoftDecline
- sca3DSFlow
- sca3DSVersion
- sca3DSChallengeRequestType
- sca3DSTransactionStatus
- scaAuthorizationStatus
- scaAuthorizationError