iGaming Complete Request Structure
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: Authorization 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.
Note: 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.
{
"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": "[email protected]",
"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": "[email protected]",
"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
}
}
preAuthIGaming
The preAuthIGaming request omits the post-authorization fields from the "credit card" example under paymentMethods[] block.
{
"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": "[email protected]",
"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": "[email protected]",
"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
}
}
Pre-Auth omits these fields:
- avsResult
- cvvResult
- cardAuthorizationCode
- cardAuthorizationDateTime
- isPreAuthorizationReject
- postAuthorizationRejectReason
- eciIndicator
- isSCASoftDecline
- sca3DSFlow
- sca3DSVersion
- sca3DSChallengeRequestType
- sca3DSTransactionStatus
- scaAuthorizationStatus
- scaAuthorizationError