Universal Fraud APIs
Retail Extension Overview
Retail Complete Request Structure
4 min
Topic type: Reference
Purpose: Show the complete Universal Retail API request hierarchy, including shared transaction fields, nested objects, all supported payment types, retail item and fulfillment data, and post-authorization fields.
Audience: API integrators and client developers implementing the Universal Retail API.
Applies to: Universal Retail API preAuthRetail and postAuthRetail 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 for illustration purposes.
Real-world requests typically contain only the fields relevant to the transaction being submitted.
Note: The postAuthRetail and preAuthRetail examples below should be used to understand object hierarchy and field placement, not as a required payload.
postAuthRetail
The postAuthRetail structure includes the authorization and 3-D Secure fields available after authorization.
{
"transactionID": "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": true,
"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": "physicalItems",
"listingID": "abcd1234",
"isPaymentOptimization": true,
"is3DS": true,
"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,
"orderMessage": "Enjoy the gift",
"isPaymentInInstallments": true,
"installmentAmount": 99.99,
"installmentCurrencyCode": "USD",
"installmentCount": 12,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-001",
"addressType": "shipping",
"primaryFlag": true,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Apt 7",
"city": "Anaheim",
"region": "CA",
"postCode": "92802",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-002",
"addressType": "billing",
"primaryFlag": false,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Billing Avenue",
"address2": "Suite 10",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"shippingAddresses": [
{
"addressID": "shipping-001",
"primaryFlag": true,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Apt 7",
"city": "Anaheim",
"region": "CA",
"postCode": "92802",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"billingAddresses": [
{
"addressID": "billing-001",
"primaryFlag": true,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Billing Avenue",
"address2": "Suite 10",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Accertify, Inc",
"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.00,
"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": "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.00,
"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": "billing-001"
},
{
"paymentType": "giftCard",
"paymentMethodID": "payment-gift-card-001",
"paymentMethodAmount": 75.00,
"isPaymentStoredOnFile": false,
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678",
"expirationDay": "09",
"expirationMonth": "11",
"expirationYear": "2029",
"paymentMethodBalanceAmount": 150.00,
"totalFailedAttempts": 0,
"addressID": "billing-001"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "payment-bank-account-001",
"paymentMethodAmount": 100.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"paymentMethodBalanceAmount": 2500.00,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "billing-001"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "payment-loyalty-001",
"paymentMethodAmount": 50.00,
"isPaymentStoredOnFile": true,
"points": 50000,
"loyaltyProgramName": "Members Plus",
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "cash",
"paymentMethodID": "payment-cash-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false
},
{
"paymentType": "check",
"paymentMethodID": "payment-check-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "payment-crypto-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "payment-eft-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"addressID": "billing-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "payment-invoice-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Accertify, Inc",
"addressID": "billing-001"
},
{
"paymentType": "loan",
"paymentMethodID": "payment-loan-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "payment-money-order-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "secCard",
"paymentMethodID": "payment-sec-card-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "payment-store-credit-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"paymentMethodBalanceAmount": 250.00
},
{
"paymentType": "thirdParty",
"paymentMethodID": "payment-third-party-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "payment-voucher-001",
"paymentMethodAmount": 8.91,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
}
],
"items": [
{
"itemType": "physicalGood",
"brandName": "Apple",
"description": "Macbook Pro",
"category": "Computers",
"itemID": "item-physical-001",
"isHighRiskItem": true,
"price": 1199.99,
"faceValueAmount": 1599.99,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingCompany": "ups",
"companyName": "Regional Courier Co",
"shippingMethod": "ground",
"shippingTrackingNumber": "23l4fdswerea02",
"promoCode": "ABC12",
"promoAmount": 50.00,
"promoType": "employeeDiscount",
"pickupLocation": "curbside",
"pickupDateTime": "2022-03-11T17:07:24-07:00",
"pickupPersonFirstName": "Betty",
"pickupPersonLastName": "Smith"
},
{
"itemType": "giftCard",
"brandName": "Acme",
"description": "Digital Gift Card",
"category": "Gift Cards",
"itemID": "item-gift-card-001",
"isHighRiskItem": true,
"price": 100.00,
"faceValueAmount": 100.00,
"quantity": 1,
"productCondition": "new",
"shippingMethod": "digital",
"promoCode": "GIFTCARD10",
"promoAmount": 10.00,
"promoType": "percentage"
},
{
"itemType": "parking",
"brandName": "Acme Parking",
"description": "Event Parking",
"category": "Parking",
"itemID": "item-parking-001",
"isHighRiskItem": false,
"price": 25.00,
"faceValueAmount": 25.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "reservation",
"brandName": "Acme Reservations",
"description": "Store Appointment",
"category": "Reservations",
"itemID": "item-reservation-001",
"isHighRiskItem": false,
"price": 20.00,
"faceValueAmount": 20.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "subscription",
"brandName": "Acme Plus",
"description": "Annual Membership",
"category": "Subscriptions",
"itemID": "item-subscription-001",
"isHighRiskItem": false,
"price": 99.99,
"faceValueAmount": 99.99,
"quantity": 1,
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "ticket",
"brandName": "Acme Events",
"description": "Admission Ticket",
"category": "Tickets",
"itemID": "item-ticket-001",
"isHighRiskItem": true,
"price": 75.00,
"faceValueAmount": 75.00,
"quantity": 2,
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "other",
"brandName": "Acme",
"description": "Miscellaneous Retail Item",
"category": "Other",
"itemID": "item-other-001",
"isHighRiskItem": false,
"price": 10.00,
"faceValueAmount": 10.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "other",
"shippingCompany": "other",
"companyName": "Regional Courier Co",
"shippingMethod": "other",
"shippingTrackingNumber": "OTHER123456"
}
],
"promotions": [
{
"promoCode": "BOGO2026",
"promoAmount": 25.00,
"promoType": "bogo"
},
{
"promoCode": "BUNDLE2026",
"promoAmount": 20.00,
"promoType": "bundle"
},
{
"promoCode": "EMPLOYEE50",
"promoAmount": 50.00,
"promoType": "employeeDiscount"
},
{
"promoCode": "FREESHIP",
"promoAmount": 5.99,
"promoType": "freeShipping"
},
{
"promoCode": "LOYALTY25",
"promoAmount": 25.00,
"promoType": "loyaltyDiscount"
},
{
"promoCode": "NEWMEMBER10",
"promoAmount": 10.00,
"promoType": "newMemberDiscount"
},
{
"promoCode": "PERCENT15",
"promoAmount": 15.00,
"promoType": "percentage"
},
{
"promoCode": "QUANTITY20",
"promoAmount": 20.00,
"promoType": "quantityPromotion"
},
{
"promoCode": "OTHERPROMO",
"promoAmount": 5.00,
"promoType": "other"
}
]
}
preAuthRetail
The preAuthRetail request omits the post-authorization fields from the "credit card" example under paymentMethods[] block.
{
"transactionID": "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": true,
"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": "physicalItems",
"listingID": "abcd1234",
"isPaymentOptimization": true,
"is3DS": true,
"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,
"orderMessage": "Enjoy the gift",
"isPaymentInInstallments": true,
"installmentAmount": 99.99,
"installmentCurrencyCode": "USD",
"installmentCount": 12,
"isPaymentRecurring": false
},
"addresses": [
{
"addressID": "address-001",
"addressType": "shipping",
"primaryFlag": true,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Apt 7",
"city": "Anaheim",
"region": "CA",
"postCode": "92802",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
},
{
"addressID": "address-002",
"addressType": "billing",
"primaryFlag": false,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Billing Avenue",
"address2": "Suite 10",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"shippingAddresses": [
{
"addressID": "shipping-001",
"primaryFlag": true,
"isAddressOnFile": false,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "1863 Main Street",
"address2": "Apt 7",
"city": "Anaheim",
"region": "CA",
"postCode": "92802",
"country": "US",
"companyName": "Accertify, Inc",
"addressCreatedDateTime": "2020-03-28T17:07:24-07:00",
"addressUpdatedDateTime": "2021-03-28T17:07:24-07:00"
}
],
"billingAddresses": [
{
"addressID": "billing-001",
"primaryFlag": true,
"isAddressOnFile": true,
"firstName": "Jane",
"middleName": "Marie",
"lastName": "Doe",
"emailAddress": "[email protected]",
"phone": "3125555555",
"phoneCountryCode": "001",
"address1": "200 Billing Avenue",
"address2": "Suite 10",
"city": "Chicago",
"region": "IL",
"postCode": "60601",
"country": "US",
"companyName": "Accertify, Inc",
"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.00,
"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": "billing-001"
},
{
"paymentType": "digitalWallet",
"paymentMethodID": "payment-wallet-001",
"paymentMethodAmount": 100.00,
"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": "billing-001"
},
{
"paymentType": "giftCard",
"paymentMethodID": "payment-gift-card-001",
"paymentMethodAmount": 75.00,
"isPaymentStoredOnFile": false,
"giftCardNumber": "5555444433332222",
"giftCardLastFour": "2222",
"giftCardBIN": "654678",
"expirationDay": "09",
"expirationMonth": "11",
"expirationYear": "2029",
"paymentMethodBalanceAmount": 150.00,
"totalFailedAttempts": 0,
"addressID": "billing-001"
},
{
"paymentType": "bankAccount",
"paymentMethodID": "payment-bank-account-001",
"paymentMethodAmount": 100.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"paymentMethodBalanceAmount": 2500.00,
"totalFailedAttempts": 0,
"paymentMethodCreatedDateTime": "2020-03-28T17:07:24-07:00",
"paymentMethodUpdatedDateTime": "2021-03-28T17:07:24-07:00",
"addressID": "billing-001"
},
{
"paymentType": "loyaltyPoints",
"paymentMethodID": "payment-loyalty-001",
"paymentMethodAmount": 50.00,
"isPaymentStoredOnFile": true,
"points": 50000,
"loyaltyProgramName": "Members Plus",
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "cash",
"paymentMethodID": "payment-cash-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false
},
{
"paymentType": "check",
"paymentMethodID": "payment-check-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "cryptoCurrency",
"paymentMethodID": "payment-crypto-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "electronicFundTransfer",
"paymentMethodID": "payment-eft-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"accountType": "checking",
"addressID": "billing-001"
},
{
"paymentType": "invoice",
"paymentMethodID": "payment-invoice-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Accertify, Inc",
"addressID": "billing-001"
},
{
"paymentType": "loan",
"paymentMethodID": "payment-loan-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "moneyOrder",
"paymentMethodID": "payment-money-order-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
},
{
"paymentType": "secCard",
"paymentMethodID": "payment-sec-card-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "storeCredit",
"paymentMethodID": "payment-store-credit-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": true,
"nameOnAccount": "Jane Doe",
"paymentMethodBalanceAmount": 250.00
},
{
"paymentType": "thirdParty",
"paymentMethodID": "payment-third-party-001",
"paymentMethodAmount": 25.00,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe",
"addressID": "billing-001"
},
{
"paymentType": "voucher",
"paymentMethodID": "payment-voucher-001",
"paymentMethodAmount": 8.91,
"isPaymentStoredOnFile": false,
"nameOnAccount": "Jane Doe"
}
],
"items": [
{
"itemType": "physicalGood",
"brandName": "Apple",
"description": "Macbook Pro",
"category": "Computers",
"itemID": "item-physical-001",
"isHighRiskItem": true,
"price": 1199.99,
"faceValueAmount": 1599.99,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingCompany": "ups",
"companyName": "Regional Courier Co",
"shippingMethod": "ground",
"shippingTrackingNumber": "23l4fdswerea02",
"promoCode": "ABC12",
"promoAmount": 50.00,
"promoType": "employeeDiscount",
"pickupLocation": "curbside",
"pickupDateTime": "2022-03-11T17:07:24-07:00",
"pickupPersonFirstName": "Betty",
"pickupPersonLastName": "Smith"
},
{
"itemType": "giftCard",
"brandName": "Acme",
"description": "Digital Gift Card",
"category": "Gift Cards",
"itemID": "item-gift-card-001",
"isHighRiskItem": true,
"price": 100.00,
"faceValueAmount": 100.00,
"quantity": 1,
"productCondition": "new",
"shippingMethod": "digital",
"promoCode": "GIFTCARD10",
"promoAmount": 10.00,
"promoType": "percentage"
},
{
"itemType": "parking",
"brandName": "Acme Parking",
"description": "Event Parking",
"category": "Parking",
"itemID": "item-parking-001",
"isHighRiskItem": false,
"price": 25.00,
"faceValueAmount": 25.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "reservation",
"brandName": "Acme Reservations",
"description": "Store Appointment",
"category": "Reservations",
"itemID": "item-reservation-001",
"isHighRiskItem": false,
"price": 20.00,
"faceValueAmount": 20.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "subscription",
"brandName": "Acme Plus",
"description": "Annual Membership",
"category": "Subscriptions",
"itemID": "item-subscription-001",
"isHighRiskItem": false,
"price": 99.99,
"faceValueAmount": 99.99,
"quantity": 1,
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "ticket",
"brandName": "Acme Events",
"description": "Admission Ticket",
"category": "Tickets",
"itemID": "item-ticket-001",
"isHighRiskItem": true,
"price": 75.00,
"faceValueAmount": 75.00,
"quantity": 2,
"productCondition": "new",
"shippingMethod": "digital"
},
{
"itemType": "other",
"brandName": "Acme",
"description": "Miscellaneous Retail Item",
"category": "Other",
"itemID": "item-other-001",
"isHighRiskItem": false,
"price": 10.00,
"faceValueAmount": 10.00,
"quantity": 1,
"addressID": "shipping-001",
"productCondition": "other",
"shippingCompany": "other",
"companyName": "Regional Courier Co",
"shippingMethod": "other",
"shippingTrackingNumber": "OTHER123456"
}
],
"promotions": [
{
"promoCode": "BOGO2026",
"promoAmount": 25.00,
"promoType": "bogo"
},
{
"promoCode": "BUNDLE2026",
"promoAmount": 20.00,
"promoType": "bundle"
},
{
"promoCode": "EMPLOYEE50",
"promoAmount": 50.00,
"promoType": "employeeDiscount"
},
{
"promoCode": "FREESHIP",
"promoAmount": 5.99,
"promoType": "freeShipping"
},
{
"promoCode": "LOYALTY25",
"promoAmount": 25.00,
"promoType": "loyaltyDiscount"
},
{
"promoCode": "NEWMEMBER10",
"promoAmount": 10.00,
"promoType": "newMemberDiscount"
},
{
"promoCode": "PERCENT15",
"promoAmount": 15.00,
"promoType": "percentage"
},
{
"promoCode": "QUANTITY20",
"promoAmount": 20.00,
"promoType": "quantityPromotion"
},
{
"promoCode": "OTHERPROMO",
"promoAmount": 5.00,
"promoType": "other"
}
]
}
Pre-Auth omits these fields:
- avsResult
- cvvResult
- cardAuthorizationCode
- cardAuthorizationDateTime
- isPreAuthorizationReject
- postAuthorizationRejectReason
- eciIndicator
- isSCASoftDecline
- sca3DSFlow
- sca3DSVersion
- sca3DSChallengeRequestType
- sca3DSTransactionStatus
- scaAuthorizationStatus
- scaAuthorizationError