Ticketing Complete Request Structure

\<font color="#b6c7cb">\</font> 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 postauth ticketing example { "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" "jane doe\@example com", "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" "jane doe123\@gmail com", "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" } ] } } preauth ticketing the preauthticketing request omits the post authorization fields from the "credit card" example under paymentmethods\[] block preauth ticketing example { "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" "jane doe\@example com", "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" "jane doe123\@gmail com", "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" } ] } } omitted post auth fields pre auth omits these fields avsresult cvvresult cardauthorizationcode cardauthorizationdatetime ispreauthorizationreject postauthorizationrejectreason eciindicator isscasoftdecline sca3dsflow sca3dsversion sca3dschallengerequesttype sca3dstransactionstatus scaauthorizationstatus scaauthorizationerror