iGaming Complete Request Structure

\<font color="#b6c7cb">\</font> topic type reference purpose demonstrate the complete universal igaming api request hierarchy and show where shared transaction fields, igaming specific extensions, deposit and withdrawal structures, member statistics, and supporting objects appear within a request audience api integrators and client developers implementing the universal igaming api applies to universal igaming api preauthigaming and postauthigaming request structures does not apply to a uthorization update, fulfillment update, or chargeback update request models this topic explains the complete igaming request hierarchy complete request example topics intentionally combine multiple optional and conditional structures into a single payload to demonstrate object hierarchy, field placement, and supported data branches real world requests typically contain only the structures relevant to the transaction being submitted \<font color="#386b84"> note \</font> for igaming, a transaction should include either a deposit object or a withdrawal object, not both postauthigaming the postauthigaming structure includes the authorization and 3 d secure fields available after authorization postauthigamingairline example { "transactionid" "igm 12345678", "transactiondatetime" "2022 06 10t14 30 00 05 00", "eventsource" "web", "accountid" "98712345678", "isguestcheckout" false, "isagenticcheckout" false, "paymentamount" 500 0, "deliveryamount" 0 0, "success" false, "ipaddress" "10 12 12 123", "useragent" "mozilla/5 0", "devicetransactionid" "e1a1aade06e2557f34036eeb06173faf1fa05c64959383", "devicepayload" "afklasdjlasdjl3l23j23423klj", "ubaid" "3143e969395de649c48c1c9f3e363a3e7ae7", "ubaevents" "lasjdlkfdsljelkrrjwl3kl324j32k432", "emailaddress" "adam\@example com", "authenticationmethod" "password", "failurecode" "authfailed", "brand" "acme", "phonenumber" "3125555555", "latitude" 41 878, "longitude" 87 629, "accountstatus" "active", "firstname" "jane", "middlename" "marie", "lastname" "doe", "purchasetype" "services", "listingid" "abcd1234", "ispaymentoptimization" false, "account" { "isenrolledinloyaltyprogram" true, "loyaltynumber" "id1234", "accountlocale" "en us", "accountlevel" "gold", "accounttype" "individual", "loyaltyprogramname" "members plus", "loyaltypointsbalance" 987654321 }, "payment" { "isgift" false, "ordermessage" "enjoy the gift", "ispaymentininstallments" false, "ispaymentrecurring" false }, "addresses" \[ { "addressid" "23l4jk23klj23", "addresstype" "billing", "primaryflag" true, "isaddressonfile" true, "firstname" "jane", "middlename" "marie", "lastname" "doe", "emailaddress" "jane doe123\@gmail com", "phone" "3125555555", "phonecountrycode" "001", "address1" "1863 main street", "address2" "apt 7", "city" "chicago", "region" "il", "postcode" "60601", "country" "us" } ], "paymentmethods" \[ { "paymenttype" "creditcard", "paymentmethodid" "2ljr9vxsdfew", "paymentmethodamount" 500 0, "ispaymentstoredonfile" true, "cardtoken" "6f7%gf38hfua", "expirationmonth" "11", "expirationyear" "2027", "nameoncreditcard" "jane doe", "cardbin" "345678", "cardlastfour" "1111", "addressid" "23kl4l32l" "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", "iswalletprotectioneligible" true }, { "paymenttype" "giftcard", "paymentmethodid" "gift 001", "giftcardnumber" "5555444433332222", "giftcardlastfour" "2222", "giftcardbin" "654678" }, { "paymenttype" "bankaccount", "paymentmethodid" "bank 001", "accounttype" "checking", "nameonaccount" "jane doe" }, {"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" "emp", "promotype" "employeediscount", "promoamount" 50}, {"promocode" "ship", "promotype" "freeshipping", "promoamount" 5 99}, {"promocode" "loyal", "promotype" "loyaltydiscount", "promoamount" 25}, {"promocode" "new", "promotype" "newmemberdiscount", "promoamount" 10}, {"promocode" "pct", "promotype" "percentage", "promoamount" 15}, {"promocode" "qty", "promotype" "quantitypromotion", "promoamount" 20}, {"promocode" "other", "promotype" "other", "promoamount" 5} ], "deposit" { "depositid" "dep1234567", "depositdatetime" "2022 06 10t14 28 00 05 00", "deposittotalamount" 500 0, "taxamount" 0 0, "currencycode" "usd", "salesrepid" "sr#46k90", "referralcode" "api 210315" }, "withdrawal" { "withdrawalid" "wd1234567", "withdrawaldatetime" "2022 06 10t14 28 00 05 00", "withdrawaltotalamount" 250 0, "taxamount" 0 0, "currencycode" "usd" }, "memberstats" { "wagerslast7days" 42, "wagersamountlast7days" 850 0, "wagerswonlast7days" 18, "wagersamountwonlast7days" 1200 0, "averageoddslast7days" 2 15, "averagewager7days" 25 5, "maxwager7days" 500 0, "minwager7days" 1 0, "earlycashoutslast7days" 3, "earlycashoutsamountlast7days" 75 0, "livewagerslast7days" 5, "averagetimebeforematch" 45, "houselimit" 5000 0 } } preauth igaming the preauthigaming request omits the post authorization fields from the "credit card" example under paymentmethods\[] block preauth igaming example { "transactionid" "igm 12345678", "transactiondatetime" "2022 06 10t14 30 00 05 00", "eventsource" "web", "accountid" "98712345678", "isguestcheckout" false, "isagenticcheckout" false, "paymentamount" 500 0, "deliveryamount" 0 0, "success" false, "ipaddress" "10 12 12 123", "useragent" "mozilla/5 0", "devicetransactionid" "e1a1aade06e2557f34036eeb06173faf1fa05c64959383", "devicepayload" "afklasdjlasdjl3l23j23423klj", "ubaid" "3143e969395de649c48c1c9f3e363a3e7ae7", "ubaevents" "lasjdlkfdsljelkrrjwl3kl324j32k432", "emailaddress" "adam\@example com", "authenticationmethod" "password", "failurecode" "authfailed", "brand" "acme", "phonenumber" "3125555555", "latitude" 41 878, "longitude" 87 629, "accountstatus" "active", "firstname" "jane", "middlename" "marie", "lastname" "doe", "purchasetype" "services", "listingid" "abcd1234", "ispaymentoptimization" false, "account" { "isenrolledinloyaltyprogram" true, "loyaltynumber" "id1234", "accountlocale" "en us", "accountlevel" "gold", "accounttype" "individual", "loyaltyprogramname" "members plus", "loyaltypointsbalance" 987654321 }, "payment" { "isgift" false, "ordermessage" "enjoy the gift", "ispaymentininstallments" false, "ispaymentrecurring" false }, "addresses" \[ { "addressid" "23l4jk23klj23", "addresstype" "billing", "primaryflag" true, "isaddressonfile" true, "firstname" "jane", "middlename" "marie", "lastname" "doe", "emailaddress" "jane doe123\@gmail com", "phone" "3125555555", "phonecountrycode" "001", "address1" "1863 main street", "address2" "apt 7", "city" "chicago", "region" "il", "postcode" "60601", "country" "us" } ], "paymentmethods" \[ { "paymenttype" "creditcard", "paymentmethodid" "2ljr9vxsdfew", "paymentmethodamount" 500 0, "ispaymentstoredonfile" true, "cardtoken" "6f7%gf38hfua", "expirationmonth" "11", "expirationyear" "2027", "nameoncreditcard" "jane doe", "cardbin" "345678", "cardlastfour" "1111", "addressid" "23kl4l32l" }, { "paymenttype" "digitalwallet", "paymentmethodid" "wallet 001", "wallettype" "apple pay", "walletstatus" "active", "iswalletprotectioneligible" true }, { "paymenttype" "giftcard", "paymentmethodid" "gift 001", "giftcardnumber" "5555444433332222", "giftcardlastfour" "2222", "giftcardbin" "654678" }, { "paymenttype" "bankaccount", "paymentmethodid" "bank 001", "accounttype" "checking", "nameonaccount" "jane doe" }, {"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" "emp", "promotype" "employeediscount", "promoamount" 50}, {"promocode" "ship", "promotype" "freeshipping", "promoamount" 5 99}, {"promocode" "loyal", "promotype" "loyaltydiscount", "promoamount" 25}, {"promocode" "new", "promotype" "newmemberdiscount", "promoamount" 10}, {"promocode" "pct", "promotype" "percentage", "promoamount" 15}, {"promocode" "qty", "promotype" "quantitypromotion", "promoamount" 20}, {"promocode" "other", "promotype" "other", "promoamount" 5} ], "deposit" { "depositid" "dep1234567", "depositdatetime" "2022 06 10t14 28 00 05 00", "deposittotalamount" 500 0, "taxamount" 0 0, "currencycode" "usd", "salesrepid" "sr#46k90", "referralcode" "api 210315" }, "withdrawal" { "withdrawalid" "wd1234567", "withdrawaldatetime" "2022 06 10t14 28 00 05 00", "withdrawaltotalamount" 250 0, "taxamount" 0 0, "currencycode" "usd" }, "memberstats" { "wagerslast7days" 42, "wagersamountlast7days" 850 0, "wagerswonlast7days" 18, "wagersamountwonlast7days" 1200 0, "averageoddslast7days" 2 15, "averagewager7days" 25 5, "maxwager7days" 500 0, "minwager7days" 1 0, "earlycashoutslast7days" 3, "earlycashoutsamountlast7days" 75 0, "livewagerslast7days" 5, "averagetimebeforematch" 45, "houselimit" 5000 0 } } omitted post auth fields pre auth omits these fields avsresult cvvresult cardauthorizationcode cardauthorizationdatetime ispreauthorizationreject postauthorizationrejectreason eciindicator isscasoftdecline sca3dsflow sca3dsversion sca3dschallengerequesttype sca3dstransactionstatus scaauthorizationstatus scaauthorizationerror