Ticketing Complete Request Structure
Topic type: Reference
Purpose: Demonstrate the complete Universal Ticketing API request hierarchy and show where shared transaction fields, Ticketing extensions, event structures, ticket structures, agency information, insurance information, and activity information appear within a request.
Audience: API integrators and client developers implementing the Universal Ticketing API.
Applies to: Universal Ticketing API preAuthTicketing and postAuthTicketing 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 Ticketing-specific extensions.
Real-world requests typically contain only the structures applicable to the transaction being submitted.
postAuthTicketing
The postAuthTicketing structure includes the authorization and 3-D Secure fields available after authorization.
{
"transactionID": "TKT-12345678",
"transactionDateTime": "2022-03-11T17:07:24-07:00",
"eventSource": "web",
"accountID": "12363454566",
"isGuestCheckout": false,
"isAgenticCheckout": false,
"paymentAmount": 532.7,
"taxAmount": 12.34,
"deliveryAmount": 5.99,
"currencyCode": "USD",
"success": false,
"ipAddress": "10.12.12.123",
"userAgent": "Mozilla/5.0",
"deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
"devicePayload": "afklasdjlasdjl3l23j23423klj",
"ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
"ubaEvents": "lasjdlkfdsljelkrrjwl3kl324j32k432",
"emailAddress": "[email protected]",
"authenticationMethod": "magicLink",
"failureCode": "authFailed",
"brand": "acme",
"phoneNumber": "3125555555",
"latitude": 41.878,
"longitude": -87.629,
"accountStatus": "active",
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"purchaseType": "physicalItems",
"listingID": "abcd1234",
"isPaymentOptimization": true,
"is3DS": false,
"ticketPackageID": "3jlsdfs9732",
"ticketPackageClass": "gold",
"ticketPackageDescription": "gold family package",
"ticketDeliveryType": "mobileApp",
"account": {
"isEnrolledInLoyaltyProgram": true,
"loyaltyNumber": "Id1234",
"accountLocale": "en-US",
"accountLevel": "Gold",
"accountType": "family",
"loyaltyProgramName": "Members Plus",
"loyaltyPointsBalance": 987654321
},
"payment": {
"salesRepID": "SR#46k90",
"referralCode": "API 210315",
"isGift": true,
"orderMessage": "Rush shipping requested",
"isPaymentInInstallments": false,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-billing-001",
"addressType": "billing",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"shippingAddresses": [
{
"addressID": "shipping-001",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"billingAddresses": [
{
"addressID": "billing-001",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"paymentMethods": [
{
"paymentType": "creditCard",
"paymentMethodID": "cc-001",
"cardNumber": "4111111111111111",
"cardToken": "6f7%gf38hfUa",
"expirationMonth": "11",
"expirationYear": "2029",
"nameOnCreditCard": "Jane Doe",
"cardBin": "411111",
"cardLastFour": "1111"
"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": "wallet-001",
"walletType": "Apple Pay",
"walletStatus": "active"
},
{
"paymentType": "giftCard",
"paymentMethodID": "gift-001",
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "bank-001",
"accountType": "checking"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "lp-001",
"points": 50000,
"loyaltyProgramName": "Members Plus"
},
{
"paymentType": "cash",
"paymentMethodID": "cash-001"
},
{
"paymentType": "check",
"paymentMethodID": "check-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "crypto-001"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "eft-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "invoice-001"
},
{
"paymentType": "loan",
"paymentMethodID": "loan-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "mo-001"
},
{
"paymentType": "secCard",
"paymentMethodID": "sec-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "store-001"
},
{
"paymentType": "thirdParty",
"paymentMethodID": "third-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "voucher-001"
}
],
"items": [
{
"itemType": "giftCard",
"itemID": "gift-item"
},
{
"itemType": "parking",
"itemID": "parking-item"
},
{
"itemType": "physicalGood",
"itemID": "physical-item"
},
{
"itemType": "reservation",
"itemID": "reservation-item"
},
{
"itemType": "subscription",
"itemID": "subscription-item"
},
{
"itemType": "ticket",
"itemID": "ticket-item"
},
{
"itemType": "other",
"itemID": "other-item"
}
],
"promotions": [
{
"promoCode": "BOGO",
"promoType": "bogo",
"promoAmount": 25
},
{
"promoCode": "BUNDLE",
"promoType": "bundle",
"promoAmount": 20
},
{
"promoCode": "EMPLOYEE50",
"promoType": "employeeDiscount",
"promoAmount": 50
},
{
"promoCode": "FREESHIP",
"promoType": "freeShipping",
"promoAmount": 5.99
},
{
"promoCode": "LOYALTY25",
"promoType": "loyaltyDiscount",
"promoAmount": 25
},
{
"promoCode": "NEWMEMBER10",
"promoType": "newMemberDiscount",
"promoAmount": 10
},
{
"promoCode": "PERCENT15",
"promoType": "percentage",
"promoAmount": 15
},
{
"promoCode": "QUANTITY20",
"promoType": "quantityPromotion",
"promoAmount": 20
},
{
"promoCode": "OTHERPROMO",
"promoType": "other",
"promoAmount": 5
}
],
"ticketDetails": [
{
"guestFirstName": "John",
"guestMiddleName": "Edward",
"guestLastName": "Smith",
"guestAdultOrChild": "adult",
"ticketPLU": "234jl234jl324jl23kl23",
"ticketPrice": 99.92,
"ticketCurrencyCode": "USD",
"ticketStartDateTime": "2020-02-22T17:07:24-07:00",
"ticketExpirationDateTime": "2020-02-22T17:07:24-07:00",
"ticketClass": "premium"
}
],
"event": {
"eventID": "234kl5jkl523jkl423jkl",
"eventType": "concert",
"eventName": "Fleetwood Mac",
"eventDateTime": "2022-03-11T17:07:24-07:00",
"eventGenre": "country",
"venueID": "223jklk234j3l4",
"venueAddressID": "3243324232",
"tickets": {
"sectionNumber": "401",
"sectionName": "home",
"row": "24",
"rowName": "upper",
"numberOfTickets": 2,
"startSeat": "2",
"endSeat": "3"
}
},
"agencyInformation": {
"agencyDetails": [
{
"agencyCode": "01234ABC",
"agencyName": "Acme Travel Inc",
"agencySalesRepresentativeID": "232324521",
"agencyConfirmationNumber": "ABC123",
"agencyCountryCode": "AU",
"agencyEmail": "[email protected]",
"agencyHeadOffice": "Melbourne",
"agencyPhone": "19876543211"
}
]
},
"insuranceInformation": {
"insuranceDetails": [
{
"insuranceType": "travel",
"insuranceCity": "Sydney",
"insuranceCountryCode": "AU",
"insuranceName": "Acme Insurance Full Cover",
"insuranceReservationName": "Jane Doe",
"insuranceTotalAmount": 399.04,
"insuranceCurrencyCode": "AUD"
}
]
},
"activityInformation": {
"activityDetails": [
{
"activitySupplier": "Chicago Segways",
"activityName": "Lincoln Park Food Tour",
"activityAmount": 149.99,
"activityAmountCurrencyCode": "USD",
"activityAddressID": "23kl4l32l",
"activityStartDateTime": "2022-03-11T17:07:24-07:00"
}
]
}
}
preAuthTicketing
The preAuthTicketing request omits the post-authorization fields from the "credit card" example under paymentMethods[] block.
{
"transactionID": "TKT-12345678",
"transactionDateTime": "2022-03-11T17:07:24-07:00",
"eventSource": "web",
"accountID": "12363454566",
"isGuestCheckout": false,
"isAgenticCheckout": false,
"paymentAmount": 532.7,
"taxAmount": 12.34,
"deliveryAmount": 5.99,
"currencyCode": "USD",
"success": false,
"ipAddress": "10.12.12.123",
"userAgent": "Mozilla/5.0",
"deviceTransactionID": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383",
"devicePayload": "afklasdjlasdjl3l23j23423klj",
"ubaID": "3143e969395de649c48c1c9f3e363a3e7ae7",
"ubaEvents": "lasjdlkfdsljelkrrjwl3kl324j32k432",
"emailAddress": "[email protected]",
"authenticationMethod": "magicLink",
"failureCode": "authFailed",
"brand": "acme",
"phoneNumber": "3125555555",
"latitude": 41.878,
"longitude": -87.629,
"accountStatus": "active",
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"purchaseType": "physicalItems",
"listingID": "abcd1234",
"isPaymentOptimization": true,
"is3DS": false,
"ticketPackageID": "3jlsdfs9732",
"ticketPackageClass": "gold",
"ticketPackageDescription": "gold family package",
"ticketDeliveryType": "mobileApp",
"account": {
"isEnrolledInLoyaltyProgram": true,
"loyaltyNumber": "Id1234",
"accountLocale": "en-US",
"accountLevel": "Gold",
"accountType": "family",
"loyaltyProgramName": "Members Plus",
"loyaltyPointsBalance": 987654321
},
"payment": {
"salesRepID": "SR#46k90",
"referralCode": "API 210315",
"isGift": true,
"orderMessage": "Rush shipping requested",
"isPaymentInInstallments": false,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-billing-001",
"addressType": "billing",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"shippingAddresses": [
{
"addressID": "shipping-001",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"billingAddresses": [
{
"addressID": "billing-001",
"firstName": "Jane",
"lastName": "Doe",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US"
}
],
"paymentMethods": [
{
"paymentType": "creditCard",
"paymentMethodID": "cc-001",
"cardNumber": "4111111111111111",
"cardToken": "6f7%gf38hfUa",
"expirationMonth": "11",
"expirationYear": "2029",
"nameOnCreditCard": "Jane Doe",
"cardBin": "411111",
"cardLastFour": "1111"
},
{
"paymentType": "digitalWallet",
"paymentMethodID": "wallet-001",
"walletType": "Apple Pay",
"walletStatus": "active"
},
{
"paymentType": "giftCard",
"paymentMethodID": "gift-001",
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "bank-001",
"accountType": "checking"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "lp-001",
"points": 50000,
"loyaltyProgramName": "Members Plus"
},
{
"paymentType": "cash",
"paymentMethodID": "cash-001"
},
{
"paymentType": "check",
"paymentMethodID": "check-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "crypto-001"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "eft-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "invoice-001"
},
{
"paymentType": "loan",
"paymentMethodID": "loan-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "mo-001"
},
{
"paymentType": "secCard",
"paymentMethodID": "sec-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "store-001"
},
{
"paymentType": "thirdParty",
"paymentMethodID": "third-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "voucher-001"
}
],
"items": [
{
"itemType": "giftCard",
"itemID": "gift-item"
},
{
"itemType": "parking",
"itemID": "parking-item"
},
{
"itemType": "physicalGood",
"itemID": "physical-item"
},
{
"itemType": "reservation",
"itemID": "reservation-item"
},
{
"itemType": "subscription",
"itemID": "subscription-item"
},
{
"itemType": "ticket",
"itemID": "ticket-item"
},
{
"itemType": "other",
"itemID": "other-item"
}
],
"promotions": [
{
"promoCode": "BOGO",
"promoType": "bogo",
"promoAmount": 25
},
{
"promoCode": "BUNDLE",
"promoType": "bundle",
"promoAmount": 20
},
{
"promoCode": "EMPLOYEE50",
"promoType": "employeeDiscount",
"promoAmount": 50
},
{
"promoCode": "FREESHIP",
"promoType": "freeShipping",
"promoAmount": 5.99
},
{
"promoCode": "LOYALTY25",
"promoType": "loyaltyDiscount",
"promoAmount": 25
},
{
"promoCode": "NEWMEMBER10",
"promoType": "newMemberDiscount",
"promoAmount": 10
},
{
"promoCode": "PERCENT15",
"promoType": "percentage",
"promoAmount": 15
},
{
"promoCode": "QUANTITY20",
"promoType": "quantityPromotion",
"promoAmount": 20
},
{
"promoCode": "OTHERPROMO",
"promoType": "other",
"promoAmount": 5
}
],
"ticketDetails": [
{
"guestFirstName": "John",
"guestMiddleName": "Edward",
"guestLastName": "Smith",
"guestAdultOrChild": "adult",
"ticketPLU": "234jl234jl324jl23kl23",
"ticketPrice": 99.92,
"ticketCurrencyCode": "USD",
"ticketStartDateTime": "2020-02-22T17:07:24-07:00",
"ticketExpirationDateTime": "2020-02-22T17:07:24-07:00",
"ticketClass": "premium"
}
],
"event": {
"eventID": "234kl5jkl523jkl423jkl",
"eventType": "concert",
"eventName": "Fleetwood Mac",
"eventDateTime": "2022-03-11T17:07:24-07:00",
"eventGenre": "country",
"venueID": "223jklk234j3l4",
"venueAddressID": "3243324232",
"tickets": {
"sectionNumber": "401",
"sectionName": "home",
"row": "24",
"rowName": "upper",
"numberOfTickets": 2,
"startSeat": "2",
"endSeat": "3"
}
},
"agencyInformation": {
"agencyDetails": [
{
"agencyCode": "01234ABC",
"agencyName": "Acme Travel Inc",
"agencySalesRepresentativeID": "232324521",
"agencyConfirmationNumber": "ABC123",
"agencyCountryCode": "AU",
"agencyEmail": "[email protected]",
"agencyHeadOffice": "Melbourne",
"agencyPhone": "19876543211"
}
]
},
"insuranceInformation": {
"insuranceDetails": [
{
"insuranceType": "travel",
"insuranceCity": "Sydney",
"insuranceCountryCode": "AU",
"insuranceName": "Acme Insurance Full Cover",
"insuranceReservationName": "Jane Doe",
"insuranceTotalAmount": 399.04,
"insuranceCurrencyCode": "AUD"
}
]
},
"activityInformation": {
"activityDetails": [
{
"activitySupplier": "Chicago Segways",
"activityName": "Lincoln Park Food Tour",
"activityAmount": 149.99,
"activityAmountCurrencyCode": "USD",
"activityAddressID": "23kl4l32l",
"activityStartDateTime": "2022-03-11T17:07:24-07:00"
}
]
}
}
Pre-Auth omits these fields:
- avsResult
- cvvResult
- cardAuthorizationCode
- cardAuthorizationDateTime
- isPreAuthorizationReject
- postAuthorizationRejectReason
- eciIndicator
- isSCASoftDecline
- sca3DSFlow
- sca3DSVersion
- sca3DSChallengeRequestType
- sca3DSTransactionStatus
- scaAuthorizationStatus
- scaAuthorizationError