Submits a ticketing purchase event before payment authorization to receive a real-time risk assessment. Returns device intelligence, connection signals, and optionally 3DS/payment optimization recommendations.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "preAuth", "type": "object", "example": "{\"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\":false,\"ipAddress\":\"10.12.12.123\",\"emailAddress\":\"a@example.com\",\"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\":false,\"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\":[{\"addressType\":\"shipping\",\"addressID\":\"23l4jk23klj23\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"phone\":\"3125555555\",\"phoneCountryCode\":\"001\",\"address1\":\"1863 Main Street\",\"city\":\"Anaheim\",\"region\":\"CA\",\"postCode\":\"92802\",\"country\":\"US\"}],\"paymentMethods\":[{\"paymentType\":\"creditCard\",\"paymentMethodID\":\"2ljr9vxsdfew\",\"paymentMethodAmount\":532.7,\"expirationMonth\":\"11\",\"expirationYear\":\"2027\",\"nameOnCreditCard\":\"Jane Doe\",\"cardBin\":\"345678\",\"cardLastFour\":\"1111\"}],\"promotions\":[{\"promoCode\":\"ABC12\",\"promoAmount\":50,\"promoType\":\"employeeDiscount\"}],\"items\":[{\"itemType\":\"ticket\",\"description\":\"Macbook Pro\",\"itemID\":\"af877wernnasnfes\",\"isHighRiskItem\":true,\"price\":1199.99,\"quantity\":2,\"shippingMethod\":\"storePickup\"}],\"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\",\"agencyConfirmationNumber\":\"ABC123\",\"agencyCountryCode\":\"AU\"}]},\"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\"}]}}", "description": "Top-level scalar fields shared by the Universal Fraud API preAuth and postAuth endpoints. Ticketing-specific top-level fields for the Universal Fraud API preAuth and postAuth endpoints.
", "schema": [ { "name": "transactionID", "kind": "required", "type": "string", "description": "[Required] Unique transaction identifier (max 40 chars).
", "example": "ABC123456", "maxLength": 40 }, { "name": "transactionDateTime", "kind": "required", "type": "string[Required] ISO 8601 timestamp of when the transaction occurred.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "eventSource", "kind": "required", "type": "string[Required] Originating channel; one of: agentPhone, agentStore, affiliate, kiosk, mobileApp, other, web.
", "example": "web", "enum": [ "agentPhone", "agentStore", "affiliate", "kiosk", "mobileApp", "other", "web" ] }, { "name": "accountID", "kind": "optional", "type": "string", "description": "[Conditional] Merchant internal account identifier; required when isGuestCheckout is \"false\".
", "example": "12363454566" }, { "name": "isGuestCheckout", "kind": "required", "type": "boolean", "description": "[Required] Whether the customer checked out without an account (\"true\"/\"false\").
", "example": false }, { "name": "isAgenticCheckout", "kind": "optional", "type": "boolean", "description": "[Optional] String \"true\"/\"false\" also accepted.
", "example": false }, { "name": "paymentAmount", "kind": "required", "type": "number", "description": "[Required] Total payment amount including tax and delivery; zero or positive, up to 2 decimal places.
", "example": 1082.91, "minimum": 0 }, { "name": "taxAmount", "kind": "required", "type": "number", "description": "[Required] Tax portion of the payment amount; zero or positive, up to 2 decimal places.
", "example": 1.23, "minimum": 0 }, { "name": "deliveryAmount", "kind": "required", "type": "number", "description": "[Required] Delivery/shipping cost; zero or positive, up to 2 decimal places.
", "example": 5.99, "minimum": 0 }, { "name": "currencyCode", "kind": "required", "type": "string", "description": "[Required] ISO 4217 three-letter currency code for the transaction.
", "example": "USD" }, { "name": "success", "kind": "required", "type": "boolean", "description": "[Required] Outcome of the transaction attempt (\"true\"/\"false\").
", "example": false }, { "name": "ipAddress", "kind": "optional", "type": "string", "description": "[Conditional] Client IP address; required when eventSource is mobileApp or web.
", "example": "10.12.12.123" }, { "name": "userAgent", "kind": "optional", "type": "string", "description": "[Conditional] Browser User-Agent string (max 250 chars); required when eventSource is web.
", "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.14; rv:72.0) Gecko/20100101 Firefox/72.0", "maxLength": 250 }, { "name": "deviceTransactionID", "kind": "optional", "type": "string", "description": "[Optional] Session token generated by the device data collection script.
", "example": "e1a1aade06e2557f34036eeb06173faf1fa05c64959383" }, { "name": "devicePayload", "kind": "optional", "type": "string", "description": "[Optional] Raw payload from the device fingerprinting library.
", "example": "afklasdjlasdjl3l23j23423klj" }, { "name": "ubaID", "kind": "optional", "type": "string", "description": "[Optional] UBA behavioral analytics session ID (max 100 chars).
", "example": "3143e969395de649c48c1c9f3e363a3e7ae7", "maxLength": 100 }, { "name": "ubaEvents", "kind": "optional", "type": "string", "description": "[Optional] Serialized stream of UBA behavioral events captured during the session.
", "example": "lasjdlkfdsljelkrrjwl3kl324j32k432" }, { "name": "emailAddress", "kind": "required", "type": "string", "description": "[Required] Customer email address; must be a valid email format.
", "example": "a@example.com" }, { "name": "authenticationMethod", "kind": "optional", "type": "string[Optional] Method used to authenticate the customer; one of: appAuthenticator, appPush, magicLink, other, passkey, password, SMS.
", "example": "magicLink", "enum": [ "appAuthenticator", "appPush", "other", "password", "passkey", "magicLink", "SMS" ] }, { "name": "failureCode", "kind": "optional", "type": "string[Conditional] Reason the transaction was unsuccessful; one of: authFailed, exportCompliance, other. Required when success is \"false\".
", "example": "authFailed", "enum": [ "authFailed", "exportCompliance", "other" ] }, { "name": "brand", "kind": "optional", "type": "string", "description": "[Optional] Merchant sub-brand for multi-brand deployments (max 50 chars).
", "example": "acme", "maxLength": 50 }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "[Optional] Customer billing phone number (max 25 chars).
", "example": "3125555555", "maxLength": 25 }, { "name": "latitude", "kind": "optional", "type": "number", "description": "[Optional] Geographic latitude of the transaction origin.
", "example": 33.836 }, { "name": "longitude", "kind": "optional", "type": "number", "description": "[Optional] Geographic longitude of the transaction origin.
", "example": -117.914 }, { "name": "accountStatus", "kind": "optional", "type": "string[Optional] Current lifecycle status of the account; one of: active, dormant, suspended, terminated, trial, other.
", "example": "dormant", "enum": [ "active", "dormant", "suspended", "terminated", "trial", "other" ] }, { "name": "firstName", "kind": "optional", "type": "string", "description": "[Optional] Customer billing first name.
", "example": "Jane" }, { "name": "middleName", "kind": "optional", "type": "string", "description": "[Optional] Customer billing middle name.
", "example": "Marie" }, { "name": "lastName", "kind": "optional", "type": "string", "description": "[Optional] Customer billing last name.
", "example": "Doe" }, { "name": "purchaseType", "kind": "required", "type": "string[Required] Nature of the items in this order; one of: physicalItems, digitalItems, services, other.
", "example": "physicalItems", "enum": [ "physicalItems", "digitalItems", "services", "other" ] }, { "name": "listingID", "kind": "optional", "type": "string", "description": "[Optional] Marketplace listing identifier (max 50 chars).
", "example": "abcd1234", "maxLength": 50 }, { "name": "isPaymentOptimization", "kind": "optional", "type": "boolean", "description": "[Optional] Whether payment optimization is enabled (\"true\"/\"false\").
", "example": false }, { "name": "is3DS", "kind": "optional", "type": "boolean", "description": "[Optional] Whether 3D Secure authentication was applied (\"true\"/\"false\").
", "example": false }, { "name": "ticketPackageID", "kind": "optional", "type": "string", "description": "[Optional] Ticket package identifier.
", "example": "3jlsdfs9732" }, { "name": "ticketPackageClass", "kind": "optional", "type": "string", "description": "[Optional] Ticket package class.
", "example": "gold" }, { "name": "ticketPackageDescription", "kind": "optional", "type": "string", "description": "[Optional] Ticket package description.
", "example": "gold family package" }, { "name": "ticketDeliveryType", "kind": "optional", "type": "string[Optional] How the ticket is delivered.
", "example": "mobileApp", "enum": [ "email", "mobileApp", "pickup" ] }, { "name": "account", "kind": "optional", "type": "object", "description": "Nested object containing account-level details for the transacting customer.
", "example": "{\"isEnrolledInLoyaltyProgram\":true,\"loyaltyNumber\":\"Id1234\",\"accountLocale\":\"en-US\",\"accountLevel\":\"Gold\",\"accountType\":\"family\",\"loyaltyProgramName\":\"Members Plus\",\"loyaltyPointsBalance\":987654321}", "schema": [ { "name": "isEnrolledInLoyaltyProgram", "kind": "optional", "type": "boolean", "description": "[Optional] Whether the account holds a loyalty membership (\"true\"/\"false\").
", "example": true }, { "name": "loyaltyNumber", "kind": "optional", "type": "string", "description": "[Optional] Customer's loyalty program membership number.
", "example": "Id1234" }, { "name": "accountLocale", "kind": "optional", "type": "string", "description": "[Optional] Account locale/language preference (e.g., \"en-US\").
", "example": "en-US" }, { "name": "accountLevel", "kind": "optional", "type": "string", "description": "[Optional] Customer tier within the loyalty or membership program (e.g., \"Gold\").
", "example": "Gold" }, { "name": "accountType", "kind": "optional", "type": "string[Optional] Account category; one of: individual, business, family, other.
", "example": "family", "enum": [ "individual", "business", "family", "other" ] }, { "name": "accountRegistrationDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of when the account was created.
", "example": "2020-11-22T17:07:24-07:00", "format": "date-time" }, { "name": "accountEmailUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last email address change on the account.
", "example": "2020-08-28T19:00:00-04:00", "format": "date-time" }, { "name": "accountPasswordUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last password change on the account.
", "example": "2021-06-15T10:30:00-07:00", "format": "date-time" }, { "name": "dateOfBirth", "kind": "optional", "type": "string[Optional] Customer's date of birth in ISO 8601 date format (YYYY-MM-DD).
", "example": "1985-11-15", "format": "date" }, { "name": "loyaltyProgramName", "kind": "optional", "type": "string", "description": "[Optional] Name of the loyalty program the account belongs to (max 100 chars).
", "example": "Members Plus", "maxLength": 100 }, { "name": "loyaltyPointsBalance", "kind": "optional", "type": "integer", "description": "[Optional] Current point balance in the loyalty program; zero or positive.
", "example": 987654321, "minimum": 0 } ] }, { "name": "payment", "kind": "optional", "type": "object", "description": "Nested object containing additional payment-level details for the order.
", "example": "{\"salesRepID\":\"SR#46k90\",\"referralCode\":\"API 210315\",\"isGift\":true,\"orderMessage\":\"Rush shipping requested\",\"isPaymentInInstallments\":false,\"isPaymentRecurring\":false}", "schema": [ { "name": "salesRepID", "kind": "optional", "type": "string", "description": "[Optional] Identifier of the sales representative who assisted with the order (max 20 chars).
", "example": "SR#46k90", "maxLength": 20 }, { "name": "referralCode", "kind": "optional", "type": "string", "description": "[Optional] Promotional or affiliate referral code applied at checkout (max 50 chars).
", "example": "API 210315", "maxLength": 50 }, { "name": "isGift", "kind": "optional", "type": "boolean", "description": "[Optional] Indicates the order is being sent as a gift (\"true\"/\"false\").
", "example": true }, { "name": "isPaymentInInstallments", "kind": "optional", "type": "boolean", "description": "[Optional] Whether the total will be paid in multiple installments (\"true\"/\"false\").
", "example": false }, { "name": "installmentAmount", "kind": "optional", "type": "number", "description": "[Optional] Amount of each individual installment payment; positive number.
", "example": 99.99, "minimum": 0, "exclusiveMinimum": true }, { "name": "installmentCurrencyCode", "kind": "optional", "type": "string", "description": "[Conditional] ISO 4217 currency code for installment amounts; required when isPaymentInInstallments is \"true\".
", "example": "USD" }, { "name": "installmentCount", "kind": "optional", "type": "integer", "description": "[Conditional] Total number of installment payments; required when isPaymentInInstallments is \"true\".
", "example": 12, "minimum": 0, "exclusiveMinimum": true }, { "name": "isPaymentRecurring", "kind": "optional", "type": "boolean", "description": "[Optional] Whether this is a recurring/subscription payment (\"true\"/\"false\").
", "example": false }, { "name": "orderMessage", "kind": "optional", "type": "string", "description": "[Optional] Personal message or order instruction associated with the transaction.
", "example": "Rush shipping requested" } ] }, { "name": "addresses", "kind": "optional", "type": "array", "description": "", "example": "[{\"addressType\":\"shipping\",\"addressID\":\"23l4jk23klj23\",\"firstName\":\"Jane\",\"lastName\":\"Doe\",\"phone\":\"3125555555\",\"phoneCountryCode\":\"001\",\"address1\":\"1863 Main Street\",\"city\":\"Anaheim\",\"region\":\"CA\",\"postCode\":\"92802\",\"country\":\"US\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "addressID", "kind": "required", "type": "string", "description": "[Required] Merchant-assigned identifier for this address record.
", "example": "23l4jk23klj23" }, { "name": "addressType", "kind": "required", "type": "string[Required] Role of this address in the order.
", "example": "shipping", "enum": [ "account", "billing", "bopis", "curbside", "departure", "destination", "fulfillment", "listing", "lodging", "pickup", "return", "shipping", "venue", "other" ] }, { "name": "primaryFlag", "kind": "optional", "type": "boolean", "description": "[Optional] Marks this as the account's primary address (true/false).
", "example": true }, { "name": "isAddressOnFile", "kind": "optional", "type": "boolean", "description": "[Optional] Whether this address was previously saved to the account (\"true\"/\"false\").
", "example": false }, { "name": "firstName", "kind": "required", "type": "string", "description": "[Required] Recipient's first name at this address.
", "example": "Jane" }, { "name": "middleName", "kind": "optional", "type": "string", "description": "[Optional] Recipient's middle name at this address.
", "example": "Marie" }, { "name": "lastName", "kind": "required", "type": "string", "description": "[Required] Recipient's last name at this address.
", "example": "Doe" }, { "name": "emailAddress", "kind": "optional", "type": "string", "description": "[Conditional] Recipient's email address; required when addressType is account or billing.
", "example": "jane.doe123@example.com" }, { "name": "phone", "kind": "required", "type": "string", "description": "[Required] Recipient's phone number.
", "example": "3125555555" }, { "name": "phoneCountryCode", "kind": "required", "type": "string", "description": "[Required] International dial prefix for the phone number (for example, \"001\").
", "example": "001" }, { "name": "address1", "kind": "required", "type": "string", "description": "[Required] Primary street address line.
", "example": "1863 Main Street" }, { "name": "address2", "kind": "optional", "type": "string", "description": "[Optional] Secondary address line (suite, apartment, etc.).
", "example": "Apt 7" }, { "name": "city", "kind": "required", "type": "string", "description": "[Required] City component of the address.
", "example": "Anaheim" }, { "name": "region", "kind": "required", "type": "string", "description": "[Required] State or region component of the address.
", "example": "CA" }, { "name": "postCode", "kind": "required", "type": "string", "description": "[Required] Postal or ZIP code.
", "example": "92802" }, { "name": "country", "kind": "required", "type": "string", "description": "[Required] ISO 3166-1 alpha-2 country code.
", "example": "US" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "[Optional] Business name at this address.
", "example": "Accertify, Inc" }, { "name": "addressCreatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of when this address was saved.
", "example": "2020-03-28T17:07:24-07:00", "format": "date-time" }, { "name": "addressUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last modification to this address.
", "example": "2021-03-28T17:07:24-07:00", "format": "date-time" } ] }, { "name": "shippingAddresses", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "addressID", "kind": "required", "type": "string", "description": "[Required] Merchant-assigned identifier for this address record.
", "example": "23l4jk23klj23" }, { "name": "primaryFlag", "kind": "optional", "type": "boolean", "description": "[Optional] Marks this as the account's primary address (\"true\"/\"false\").
", "example": true }, { "name": "isAddressOnFile", "kind": "optional", "type": "boolean", "description": "[Optional] Whether this address was previously saved to the account (\"true\"/\"false\").
", "example": false }, { "name": "firstName", "kind": "required", "type": "string", "description": "[Required] Recipient's first name at this address.
", "example": "Jane" }, { "name": "middleName", "kind": "optional", "type": "string", "description": "[Optional] Recipient's middle name at this address.
", "example": "Marie" }, { "name": "lastName", "kind": "required", "type": "string", "description": "[Required] Recipient's last name at this address.
", "example": "Doe" }, { "name": "emailAddress", "kind": "optional", "type": "string", "description": "[Optional] Recipient's email address for order communications.
", "example": "jane.doe123@example.com" }, { "name": "phone", "kind": "required", "type": "string", "description": "[Required] Recipient's phone number.
", "example": "3125555555" }, { "name": "phoneCountryCode", "kind": "required", "type": "string", "description": "[Required] International dial prefix for the phone number (e.g., \"001\").
", "example": "001" }, { "name": "address1", "kind": "required", "type": "string", "description": "[Required] Primary street address line.
", "example": "1863 Main Street" }, { "name": "address2", "kind": "optional", "type": "string", "description": "[Optional] Secondary address line (suite, apartment, etc.).
", "example": "Apt 7" }, { "name": "city", "kind": "required", "type": "string", "description": "[Required] City component of the address.
", "example": "Anaheim" }, { "name": "region", "kind": "required", "type": "string", "description": "[Required] State or region component of the address.
", "example": "CA" }, { "name": "postCode", "kind": "required", "type": "string", "description": "[Required] Postal or ZIP code.
", "example": "92802" }, { "name": "country", "kind": "required", "type": "string", "description": "[Required] ISO 3166-1 alpha-2 country code.
", "example": "US" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "[Optional] Business name at this address.
", "example": "Accertify, Inc" }, { "name": "addressCreatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of when this address was saved.
", "example": "2020-03-28T17:07:24-07:00", "format": "date-time" }, { "name": "addressUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last modification to this address.
", "example": "2021-03-28T17:07:24-07:00", "format": "date-time" } ] }, { "name": "billingAddresses", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "addressID", "kind": "required", "type": "string", "description": "[Required] Merchant-assigned identifier for this address record.
", "example": "23l4jk23klj23" }, { "name": "primaryFlag", "kind": "optional", "type": "boolean", "description": "[Optional] Marks this as the account's primary address (\"true\"/\"false\").
", "example": true }, { "name": "isAddressOnFile", "kind": "optional", "type": "boolean", "description": "[Optional] Whether this address was previously saved to the account (\"true\"/\"false\").
", "example": false }, { "name": "firstName", "kind": "required", "type": "string", "description": "[Required] Recipient's first name at this address.
", "example": "Jane" }, { "name": "middleName", "kind": "optional", "type": "string", "description": "[Optional] Recipient's middle name at this address.
", "example": "Marie" }, { "name": "lastName", "kind": "required", "type": "string", "description": "[Required] Recipient's last name at this address.
", "example": "Doe" }, { "name": "emailAddress", "kind": "optional", "type": "string", "description": "[Optional] Recipient's email address for order communications.
", "example": "jane.doe123@example.com" }, { "name": "phone", "kind": "required", "type": "string", "description": "[Required] Recipient's phone number.
", "example": "3125555555" }, { "name": "phoneCountryCode", "kind": "required", "type": "string", "description": "[Required] International dial prefix for the phone number (e.g., \"001\").
", "example": "001" }, { "name": "address1", "kind": "required", "type": "string", "description": "[Required] Primary street address line.
", "example": "1863 Main Street" }, { "name": "address2", "kind": "optional", "type": "string", "description": "[Optional] Secondary address line (suite, apartment, etc.).
", "example": "Apt 7" }, { "name": "city", "kind": "required", "type": "string", "description": "[Required] City component of the address.
", "example": "Anaheim" }, { "name": "region", "kind": "required", "type": "string", "description": "[Required] State or region component of the address.
", "example": "CA" }, { "name": "postCode", "kind": "required", "type": "string", "description": "[Required] Postal or ZIP code.
", "example": "92802" }, { "name": "country", "kind": "required", "type": "string", "description": "[Required] ISO 3166-1 alpha-2 country code.
", "example": "US" }, { "name": "companyName", "kind": "optional", "type": "string", "description": "[Optional] Business name at this address.
", "example": "Accertify, Inc" }, { "name": "addressCreatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of when this address was saved.
", "example": "2020-03-28T17:07:24-07:00", "format": "date-time" }, { "name": "addressUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last modification to this address.
", "example": "2021-03-28T17:07:24-07:00", "format": "date-time" } ] }, { "name": "paymentMethods", "kind": "optional", "type": "array", "description": "", "example": "[{\"paymentType\":\"creditCard\",\"paymentMethodID\":\"2ljr9vxsdfew\",\"paymentMethodAmount\":532.7,\"expirationMonth\":\"11\",\"expirationYear\":\"2027\",\"nameOnCreditCard\":\"Jane Doe\",\"cardBin\":\"345678\",\"cardLastFour\":\"1111\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "paymentType", "kind": "optional", "type": "string[Conditional] Type of payment instrument. Required when paymentMethodID is present.
", "example": "creditCard", "enum": [ "bankAccount", "cash", "check", "creditCard", "cryptoCurrency", "digitalWallet", "electronicFundTransfer", "giftCard", "invoice", "loan", "loyaltyPoints", "moneyOrder", "secCard", "storeCredit", "thirdParty", "voucher" ] }, { "name": "paymentMethodID", "kind": "optional", "type": "string", "description": "[Optional] Merchant-assigned identifier for this payment method.
", "example": "2ljr9vxsdfew" }, { "name": "paymentMethodAmount", "kind": "optional", "type": "number", "description": "[Optional] Amount charged to this payment method.
", "example": 532.7, "minimum": 0 }, { "name": "isPaymentStoredOnFile", "kind": "optional", "type": "boolean", "description": "[Optional] Whether this instrument is saved to the account (\"true\"/\"false\").
", "example": true }, { "name": "cardNumber", "kind": "optional", "type": "string", "description": "[Optional] Full card number (PAN) for credit card payments, validated using the Luhn algorithm.
", "example": "4111111111111111" }, { "name": "cardToken", "kind": "optional", "type": "string", "description": "[Optional] Tokenized representation of the card number.
", "example": "6f7%gf38hfUa" }, { "name": "expirationMonth", "kind": "optional", "type": "string<01 | 02 | 03 | 04 | 05 | 06 | 07 | 8 | 9 | 10 | 11 | 12>", "description": "[Conditional] Zero-padded two-digit card expiration month (\"01\"..\"12\"); required when paymentType = creditCard.
", "example": "11", "enum": [ "01", "02", "03", "04", "05", "06", "07", "8", "9", "10", "11", "12" ] }, { "name": "expirationYear", "kind": "optional", "type": "string", "description": "[Conditional] Card expiration year (4-digit); required when paymentType = creditCard.
", "example": "2027" }, { "name": "nameOnCreditCard", "kind": "optional", "type": "string", "description": "[Conditional] Cardholder name as embossed on the card; required when paymentType = creditCard.
", "example": "Jane Doe" }, { "name": "cardBin", "kind": "optional", "type": "string", "description": "[Optional] Bank Identification Number (6 to 11 digits) of the card.
", "example": "345678" }, { "name": "cardLastFour", "kind": "optional", "type": "string", "description": "[Optional] Last four digits of the card number.
", "example": "1111" }, { "name": "totalFailedAttempts", "kind": "optional", "type": "integer", "description": "[Optional] Number of failed payment attempts for this method.
", "example": 1, "minimum": 0 }, { "name": "paymentMethodCreatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of when this payment method was saved.
", "example": "2020-03-28T17:07:24-07:00", "format": "date-time" }, { "name": "paymentMethodUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the last update to this payment method.
", "example": "2020-03-28T17:07:24-07:00", "format": "date-time" }, { "name": "addressID", "kind": "optional", "type": "string", "description": "[Optional] Reference to the billing address record for this payment method.
", "example": "23kl4l32l" }, { "name": "nameOnAccount", "kind": "optional", "type": "string", "description": "[Optional] Name on file for a wallet or account-based payment method.
", "example": "Jane Doe" }, { "name": "walletType", "kind": "optional", "type": "string", "description": "[Optional] Digital wallet provider.
", "example": "Apple Pay" }, { "name": "walletStatus", "kind": "optional", "type": "string[Optional] Current status of the wallet.
", "example": "active", "enum": [ "active", "pending", "inactive" ] }, { "name": "isWalletProtectionEligible", "kind": "optional", "type": "boolean", "description": "[Optional] Whether the wallet is eligible for purchase protection (\"true\"/\"false\").
", "example": true }, { "name": "paymentMethodBalanceAmount", "kind": "optional", "type": "number", "description": "[Optional] Remaining balance available on this payment method.
", "example": 4000.32, "minimum": 0, "exclusiveMinimum": true }, { "name": "giftCardNumber", "kind": "optional", "type": "string", "description": "[Optional] Full gift card number.
", "example": "5555444433332222" }, { "name": "giftCardLastFour", "kind": "optional", "type": "string", "description": "[Optional] Last four digits of the gift card number.
", "example": "2222" }, { "name": "giftCardBIN", "kind": "optional", "type": "string", "description": "[Optional] Bank Identification Number (first 6 digits) of the gift card.
", "example": "654678" }, { "name": "expirationDay", "kind": "optional", "type": "string", "description": "[Optional] Card expiration day, for payment types that include a day component.
", "example": 9 }, { "name": "points", "kind": "optional", "type": "integer", "description": "[Optional] Loyalty or reward points balance associated with this payment method.
", "example": 50000 }, { "name": "loyaltyProgramName", "kind": "optional", "type": "string", "description": "[Optional] Name of the loyalty program associated with this payment method.
", "example": "Members Plus" }, { "name": "accountType", "kind": "optional", "type": "string[Conditional] Bank account type; required when paymentType = bankAccount.
", "example": "checking", "enum": [ "checking", "saving", "moneyMarket", "other" ] } ] }, { "name": "items", "kind": "optional", "type": "array", "description": "", "example": "[{\"itemType\":\"ticket\",\"description\":\"Macbook Pro\",\"itemID\":\"af877wernnasnfes\",\"isHighRiskItem\":true,\"price\":1199.99,\"quantity\":2,\"shippingMethod\":\"storePickup\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "itemType", "kind": "optional", "type": "string[Optional] Category of item; one of: giftCard, parking, physicalGood, reservation, subscription, ticket, other.
", "example": "ticket", "enum": [ "giftCard", "parking", "physicalGood", "reservation", "subscription", "ticket", "other" ] }, { "name": "brandName", "kind": "optional", "type": "string", "description": "[Optional] Brand or manufacturer of the item.
", "example": "Apple" }, { "name": "description", "kind": "optional", "type": "string", "description": "[Optional] Short description or name of the item.
", "example": "Macbook Pro" }, { "name": "category", "kind": "optional", "type": "string", "description": "[Optional] Merchant-defined product category.
", "example": "Computers" }, { "name": "itemID", "kind": "optional", "type": "string", "description": "[Optional] Merchant's unique product or SKU identifier.
", "example": "af877wernnasnfes" }, { "name": "isHighRiskItem", "kind": "required", "type": "boolean", "description": "[Required] Whether the item is flagged as high risk (\"true\"/\"false\").
", "example": true }, { "name": "price", "kind": "required", "type": "number", "description": "[Required] Unit price of the item; positive number.
", "example": 1199.99, "minimum": 0 }, { "name": "faceValueAmount", "kind": "optional", "type": "number", "description": "[Optional] Face or retail value of the item; zero or positive.
", "example": 1599.99, "minimum": 0 }, { "name": "quantity", "kind": "optional", "type": "number", "description": "[Optional] Number of units of this item in the order.
", "example": 2 }, { "name": "addressID", "kind": "optional", "type": "string", "description": "[Conditional] Delivery address reference for this line item; required when shippingMethod is present.
", "example": "2lkj34jldsoufsous82df" }, { "name": "productCondition", "kind": "optional", "type": "string[Optional] Condition of the item; one of: new, openPackage, other, refurbished, used.
", "example": "new", "enum": [ "new", "openPackage", "other", "refurbished", "used" ] }, { "name": "shippingCompany", "kind": "optional", "type": "string[Optional] Carrier for this item; one of: dhl, fedex, ups, usps, other.
", "example": "ups", "enum": [ "dhl", "fedex", "ups", "usps", "other" ] }, { "name": "companyName", "kind": "optional", "type": "string", "description": "[Optional] Shipping company name for this item, when not one of the standard carriers (max 50 chars).
", "example": "Regional Courier Co", "maxLength": 50 }, { "name": "shippingMethod", "kind": "required", "type": "string[Required] Shipping speed or method.
", "example": "storePickup", "enum": [ "digital", "ground", "international", "other", "nextDay", "sameDay", "storePickup", "twoDay", "threeDay" ] }, { "name": "shippingTrackingNumber", "kind": "optional", "type": "string", "description": "[Optional] Carrier tracking number for this item (max 30 chars).
", "example": "23l4fdswerea02", "maxLength": 30 }, { "name": "promoCode", "kind": "optional", "type": "string", "description": "[Optional] Promotion code applied specifically to this item (max 40 chars).
", "example": "ABC12", "maxLength": 40 }, { "name": "promoAmount", "kind": "optional", "type": "number", "description": "[Optional] Discount applied to this item; zero or positive.
", "example": 50, "minimum": 0 }, { "name": "promoType", "kind": "optional", "type": "string[Optional] Category of the item-level promotion.
", "example": "employeeDiscount", "enum": [ "bogo", "bundle", "employeeDiscount", "freeShipping", "loyaltyDiscount", "newMemberDiscount", "percentage", "quantityPromotion", "other" ] }, { "name": "pickupLocation", "kind": "optional", "type": "string[Optional] In-store or curbside pickup method; one of: curbside, dropBox, inStore, other.
", "example": "curbside", "enum": [ "curbside", "dropBox", "inStore", "other" ] }, { "name": "pickupDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 timestamp of the scheduled pickup.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "pickupPersonFirstName", "kind": "optional", "type": "string", "description": "[Optional] First name of the person collecting the order (max 40 chars).
", "example": "Betty", "maxLength": 40 }, { "name": "pickupPersonLastName", "kind": "optional", "type": "string", "description": "[Optional] Last name of the person collecting the order (max 40 chars).
", "example": "Smith", "maxLength": 40 } ] }, { "name": "promotions", "kind": "optional", "type": "array", "description": "", "example": "[{\"promoCode\":\"ABC12\",\"promoAmount\":50,\"promoType\":\"employeeDiscount\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "promoCode", "kind": "optional", "type": "string", "description": "[Optional] Promotional code applied to the order.
", "example": "ABC12" }, { "name": "promoAmount", "kind": "required", "type": "number", "description": "[Required] Discount amount granted by this promotion; zero or positive.
", "example": 50, "minimum": 0 }, { "name": "promoType", "kind": "optional", "type": "string[Optional] Category of the promotion (e.g., employeeDiscount, freeShipping).
", "example": "employeeDiscount", "enum": [ "bogo", "bundle", "employeeDiscount", "freeShipping", "loyaltyDiscount", "newMemberDiscount", "percentage", "quantityPromotion", "other" ] } ] }, { "name": "ticketDetails", "kind": "optional", "type": "array", "description": "", "example": "[{\"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\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "guestFirstName", "kind": "optional", "type": "string", "description": "[Optional] Guest first name.
", "example": "John" }, { "name": "guestMiddleName", "kind": "optional", "type": "string", "description": "[Optional] Guest middle name.
", "example": "Edward" }, { "name": "guestLastName", "kind": "optional", "type": "string", "description": "[Optional] Guest last name.
", "example": "Smith" }, { "name": "guestAdultOrChild", "kind": "optional", "type": "string[Optional] Guest age category.
", "example": "adult", "enum": [ "adult", "child", "infant", "senior" ] }, { "name": "ticketPLU", "kind": "optional", "type": "string", "description": "[Optional] Ticket product lookup identifier.
", "example": "234jl234jl324jl23kl23" }, { "name": "ticketPrice", "kind": "optional", "type": "number", "description": "[Optional] Ticket purchase price.
", "example": 99.92, "minimum": 0 }, { "name": "ticketCurrencyCode", "kind": "optional", "type": "string", "description": "[Optional] ISO-4217 currency code.
", "example": "USD" }, { "name": "ticketStartDateTime", "kind": "required", "type": "string[Required] Ticket start date and time.
", "example": "2020-02-22T17:07:24-07:00", "format": "date-time" }, { "name": "ticketExpirationDateTime", "kind": "optional", "type": "string[Optional] Ticket expiration date and time.
", "example": "2020-02-22T17:07:24-07:00", "format": "date-time" }, { "name": "ticketClass", "kind": "optional", "type": "string[Optional] Ticket class.
", "example": "premium", "enum": [ "economy", "premium", "business", "first" ] } ] }, { "name": "event", "kind": "optional", "type": "object", "description": "Nested object containing information about the event and the tickets associated with the event.", "example": "{\"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\"}}", "schema": [ { "name": "eventID", "kind": "optional", "type": "string", "description": "[Optional] Event identifier (max 30 chars).
", "example": "234kl5jkl523jkl423jkl", "maxLength": 30 }, { "name": "eventType", "kind": "optional", "type": "string[Conditional] Type of event; required when eventID is present.
", "example": "concert", "enum": [ "activity", "comedy", "concert", "sports", "theater" ] }, { "name": "eventName", "kind": "optional", "type": "string", "description": "[Optional] Event name (max 30 chars).
", "example": "Fleetwood Mac", "maxLength": 30 }, { "name": "eventDateTime", "kind": "optional", "type": "string[Conditional] ISO 8601 date and time of the event; required when eventID is present.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "eventOnSaleDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when tickets for the event went on sale.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "eventGenre", "kind": "optional", "type": "string[Optional] Event genre classification.
", "example": "country", "enum": [ "alternative", "country", "dance", "jazz", "other", "pop", "rap", "rock" ] }, { "name": "venueID", "kind": "optional", "type": "string", "description": "[Optional] Identifier of the venue where the event is held (max 20 chars).
", "example": "223jklk234j3l4", "maxLength": 20 }, { "name": "venueAddressID", "kind": "optional", "type": "string", "description": "[Optional] Reference to the address record for the event venue (max 10 chars).
", "example": "3243324232", "maxLength": 10 }, { "name": "eventCreatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when the event record was created.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "eventLastUpdatedDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when the event record was last updated.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "tickets", "kind": "optional", "type": "object", "description": "[Optional] Seating and ticket quantity information associated with the event.
", "example": "{\"sectionNumber\":\"401\",\"sectionName\":\"home\",\"row\":\"24\",\"rowName\":\"upper\",\"numberOfTickets\":2,\"startSeat\":\"2\",\"endSeat\":\"3\"}", "schema": [ { "name": "sectionNumber", "kind": "optional", "type": "string", "description": "[Optional] Section number associated with the tickets (max 5 chars).
", "example": "401", "maxLength": 5 }, { "name": "sectionName", "kind": "optional", "type": "string", "description": "[Optional] Section name associated with the tickets (max 40 chars).
", "example": "home", "maxLength": 40 }, { "name": "row", "kind": "optional", "type": "string", "description": "[Optional] Row identifier associated with the tickets (max 5 chars).
", "example": "24", "maxLength": 5 }, { "name": "rowName", "kind": "optional", "type": "string", "description": "[Optional] Row name associated with the tickets (max 5 chars).
", "example": "upper", "maxLength": 5 }, { "name": "numberOfTickets", "kind": "optional", "type": "integer", "description": "[Optional] Number of tickets associated with the event purchase; must be greater than zero.
", "example": 2, "minimum": 0, "exclusiveMinimum": true }, { "name": "startSeat", "kind": "optional", "type": "string", "description": "[Optional] Starting seat number associated with the tickets (max 5 chars).
", "example": "2", "maxLength": 5 }, { "name": "endSeat", "kind": "optional", "type": "string", "description": "[Optional] Ending seat number associated with the tickets (max 5 chars).
", "example": "3", "maxLength": 5 } ] } ] }, { "name": "agencyInformation", "kind": "optional", "type": "object", "description": "Nested object containing agency information associated with the transaction.", "example": "{\"agencyDetails\":[{\"agencyCode\":\"01234ABC\",\"agencyName\":\"Acme Travel inc\",\"agencyConfirmationNumber\":\"ABC123\",\"agencyCountryCode\":\"AU\"}]}", "schema": [ { "name": "agencyDetails", "kind": "optional", "type": "array", "description": "[Optional] Agency records associated with the transaction.
", "example": "[{\"agencyCode\":\"01234ABC\",\"agencyName\":\"Acme Travel inc\",\"agencyConfirmationNumber\":\"ABC123\",\"agencyCountryCode\":\"AU\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "agencyCode", "kind": "optional", "type": "string", "description": "[Optional] Agency code (max 20 chars).
", "example": "01234ABC", "maxLength": 20 }, { "name": "agencyName", "kind": "optional", "type": "string", "description": "[Optional] Agency name (max 50 chars).
", "example": "Acme Travel inc", "maxLength": 50 }, { "name": "agencySalesRepresentativeID", "kind": "optional", "type": "string", "description": "[Optional] Identifier of the agency sales representative (max 20 chars).
", "example": "232324521", "maxLength": 20 }, { "name": "agencyConfirmationNumber", "kind": "optional", "type": "string", "description": "[Optional] Confirmation number assigned by the agency (max 25 chars).
", "example": "ABC123", "maxLength": 25 }, { "name": "agencyCountryCode", "kind": "optional", "type": "string", "description": "[Optional] ISO 3166-1 alpha-2 country code associated with the agency.
", "example": "AU" }, { "name": "agencyEmail", "kind": "optional", "type": "string", "description": "[Optional] Agency email address.
", "example": "agency123@gmail.com" }, { "name": "agencyHeadOffice", "kind": "optional", "type": "string", "description": "[Optional] Location of the agency head office (max 50 chars).
", "example": "Chicago", "maxLength": 50 }, { "name": "agencyPhone", "kind": "optional", "type": "string", "description": "[Optional] Agency phone number (max 25 chars).
", "example": "19876543211", "maxLength": 25 } ] } ] }, { "name": "insuranceInformation", "kind": "optional", "type": "object", "description": "Nested object containing insurance information associated with the transaction.", "example": "{\"insuranceDetails\":[{\"insuranceType\":\"travel\",\"insuranceCity\":\"Sydney\",\"insuranceCountryCode\":\"AU\",\"insuranceName\":\"Acme Insurance Full Cover\",\"insuranceReservationName\":\"Jane Doe\",\"insuranceTotalAmount\":399.04,\"insuranceCurrencyCode\":\"AUD\"}]}", "schema": [ { "name": "insuranceDetails", "kind": "optional", "type": "array", "description": "[Optional] Insurance records associated with the transaction.
", "example": "[{\"insuranceType\":\"travel\",\"insuranceCity\":\"Sydney\",\"insuranceCountryCode\":\"AU\",\"insuranceName\":\"Acme Insurance Full Cover\",\"insuranceReservationName\":\"Jane Doe\",\"insuranceTotalAmount\":399.04,\"insuranceCurrencyCode\":\"AUD\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "insuranceType", "kind": "optional", "type": "string", "description": "[Optional] Type of insurance associated with the transaction (max 30 chars).
", "example": "travel", "maxLength": 30 }, { "name": "insuranceCity", "kind": "optional", "type": "string", "description": "[Optional] City associated with the insurance coverage (max 40 chars).
", "example": "Sydney", "maxLength": 40 }, { "name": "insuranceCountryCode", "kind": "optional", "type": "string", "description": "[Optional] ISO 3166-1 alpha-2 country code associated with the insurance coverage.
", "example": "AU" }, { "name": "insuranceStartDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when the insurance coverage begins.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "insuranceEndDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when the insurance coverage ends.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" }, { "name": "insuranceName", "kind": "optional", "type": "string", "description": "[Optional] Name of the insurance product (max 50 chars).
", "example": "Acme Insurance Full Cover", "maxLength": 50 }, { "name": "insuranceReservationName", "kind": "optional", "type": "string", "description": "[Optional] Name associated with the insured reservation (max 100 chars).
", "example": "Jane Doe", "maxLength": 100 }, { "name": "insuranceTotalAmount", "kind": "optional", "type": "number", "description": "[Optional] Total amount charged for the insurance coverage; zero or positive.
", "example": 399.04, "minimum": 0 }, { "name": "insuranceCurrencyCode", "kind": "optional", "type": "string", "description": "[Optional] ISO 4217 three-letter currency code for the insurance amount.
", "example": "AUD" } ] } ] }, { "name": "activityInformation", "kind": "optional", "type": "object", "description": "Ticketing activity information object", "example": "{\"activityDetails\":[{\"activitySupplier\":\"Chicago Segways\",\"activityName\":\"Lincoln Park Food Tour\",\"activityAmount\":149.99,\"activityAmountCurrencyCode\":\"USD\",\"activityAddressID\":\"23kl4l32l\",\"activityStartDateTime\":\"2022-03-11T17:07:24-07:00\"}]}", "schema": [ { "name": "activityDetails", "kind": "optional", "type": "array", "description": "[Optional] Collection of activity records associated with the ticketing transaction.
", "example": "[{\"activitySupplier\":\"Chicago Segways\",\"activityName\":\"Lincoln Park Food Tour\",\"activityAmount\":149.99,\"activityAmountCurrencyCode\":\"USD\",\"activityAddressID\":\"23kl4l32l\",\"activityStartDateTime\":\"2022-03-11T17:07:24-07:00\"}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "activitySupplier", "kind": "required", "type": "string", "description": "[Required] Supplier or operator of the activity (max 30 chars).
", "example": "Chicago Segways", "maxLength": 30 }, { "name": "activityName", "kind": "required", "type": "string", "description": "[Required] Name of the activity (max 50 chars).
", "example": "Lincoln Park Food Tour", "maxLength": 50 }, { "name": "activityAmount", "kind": "optional", "type": "number", "description": "[Optional] Total amount charged for the activity; zero or positive.
", "example": 149.99, "minimum": 0 }, { "name": "activityAmountCurrencyCode", "kind": "optional", "type": "string", "description": "[Optional] ISO 4217 three-letter currency code for the activity amount.
", "example": "USD" }, { "name": "activityAddressID", "kind": "optional", "type": "string", "description": "[Optional] Reference to the address record for the activity location (max 40 chars).
", "example": "23kl4l32l", "maxLength": 40 }, { "name": "activityStartDateTime", "kind": "optional", "type": "string[Optional] ISO 8601 date and time when the activity begins.
", "example": "2022-03-11T17:07:24-07:00", "format": "date-time" } ] } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "oauthBearer", "name": "Authorization", "kind": "optional", "type": "apiKey", "description": "OAuth 2.0 Bearer token, e.g. 'Bearer '.
", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Successful response.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Successful response.", "customType": "scoredPreAuthResult", "schema": [ { "name": "eventID", "kind": "optional", "type": "string", "description": "" }, { "name": "eventDetails", "kind": "optional", "type": "object", "description": "Device and connection risk signals (scored responses only)
", "modelRef": "#/definitions/eventDetails", "customType": "eventDetails", "schema": [ { "name": "deviceDetails", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "browserSpoofRisk", "kind": "optional", "type": "string", "description": "[Optional] Risk indicator for browser spoofing detected during device collection.
", "example": "HIGH_RISK" }, { "name": "deviceIDNew", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the device ID was observed for the first time (\"true\"/\"false\").
", "example": "true" }, { "name": "browserIsMobile", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the browser is running on a mobile device (\"true\"/\"false\").
", "example": "true" }, { "name": "mobileIsRooted", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the mobile device is rooted or jailbroken (\"true\"/\"false\").
", "example": "true" }, { "name": "deviceIDFirstSeen", "kind": "optional", "type": "number", "description": "[Optional] Number of days since this device ID was first observed.
", "example": 97 }, { "name": "browserNewCookie", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating a new browser cookie was set during this session (\"true\"/\"false\").
", "example": "false" }, { "name": "deviceIDTimesSeen", "kind": "optional", "type": "number", "description": "[Optional] Total number of times this device ID has been seen.
", "example": 123 }, { "name": "mobileApp", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the event originated from a mobile app.
", "example": "true" }, { "name": "browserReplayTagStatus", "kind": "optional", "type": "string", "description": "[Optional] Status of the UBA replay tag detected in the session.
", "example": "VALID" }, { "name": "deviceID", "kind": "optional", "type": "string", "description": "[Optional] Unique persistent identifier assigned to the device.
", "example": "63dc80b4-e585-4ae8-8004-e24fb0d1fa84" } ] }, { "name": "connectionDetails", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "hostingIndicator", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the client IP address belongs to a hosting provider (\"true\"/\"false\").
", "example": "true" }, { "name": "isTor", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the client IP address is a Tor exit node (\"true\"/\"false\").
", "example": "true" }, { "name": "hostingIndicatorReal", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the client real IP address belongs to a hosting provider (\"true\"/\"false\").
", "example": "true" }, { "name": "realIPMatch", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the stated IP address matches the detected real IP address (\"true\"/\"false\").
", "example": "true" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "[Optional] ISO 3166-1 alpha-2 country code of the client IP address.
", "example": "us" }, { "name": "countryCodeReal", "kind": "optional", "type": "string", "description": "[Optional] ISO 3166-1 alpha-2 country code of the real IP address when a proxy is detected.
", "example": "de" }, { "name": "isProxy", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the client IP address is a known proxy (\"true\"/\"false\").
", "example": "false" } ] } ] }, { "name": "paymentOptimization", "kind": "optional", "type": "object", "description": "3-D Secure optimization output (preAuth scored responses only)
", "modelRef": "#/definitions/paymentOptimization", "customType": "paymentOptimization", "schema": [ { "name": "3DSModule", "kind": "optional", "type": "string", "description": "[Optional] The 3DS module selected for this transaction.
", "example": "active" }, { "name": "3DSRun", "kind": "optional", "type": "string", "description": "[Optional] A flag indicating the 3DS module was invoked (\"true\"/\"false\").
", "example": "true" }, { "name": "3DSRecommendation", "kind": "optional", "type": "string<00 | 01 | 02 | 03 | 04 | 05 | 06 | >", "description": "[Optional] Recommended 3DS action code, which may be blank.
", "example": "06", "enum": [ "00", "01", "02", "03", "04", "05", "06", "" ] }, { "name": "SCAResult", "kind": "optional", "type": "string[Optional] Strong customer authentication result from the 3DS evaluation.
", "example": "In Scope Not Exempt", "enum": [ "In Scope Exempt TRA", "In Scope Exempt LVT", "In Scope Exempt SCP", "In Scope Not Exempt", "Out of Scope" ] } ] }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "modelRef": "#/definitions/apiMessages", "customType": "apiMessages", "schema": [ { "name": "error", "kind": "optional", "type": "array", "description": "", "modelRef": "#/definitions/apiMessage", "customType": "apiMessage[]", "schema": [ { "name": "code", "kind": "required", "type": "string", "description": "Machine-readable message code
", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "Human-readable message
", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "mapMachine-readable message code
", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "Human-readable message
", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "mapMachine-readable message code
", "example": "FIELD_REQUIRED_MISSING" }, { "name": "message", "kind": "required", "type": "string", "description": "Human-readable message
", "example": "transactionID is required and was not provided" }, { "name": "field", "kind": "optional", "type": "string", "description": "Name of the field this message applies to", "example": "transactionID" }, { "name": "details", "kind": "optional", "type": "map", "description": "Structured detail keys.", "example": "", "customType": "mapHuman-readable summary of the validation error.
", "example": "Validation Failed" }, { "name": "errors", "kind": "optional", "type": "array", "description": "Validation error details for the request.", "example": "[\"Missing required field: transactionID\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/definitions/validationFailedError", "isExpanded": true } ] }, { "statusCode": "401", "description": "Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.", "customType": "notAuthorizedError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the authentication or authorization error.", "example": 401 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "Human-readable summary of the authentication or authorization error.
", "example": "Not Authorized" } ], "modelRef": "#/definitions/notAuthorizedError", "isExpanded": true } ] }, { "statusCode": "429", "description": "Error response when the request rate limit has been exceeded for the API user or API configuration.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response when the request rate limit has been exceeded for the API user or API configuration.", "customType": "rateLimitError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the rate-limit error.
", "example": 429 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "Human-readable summary of the rate-limit error.
", "example": "Rate Limit Exceeded" } ], "modelRef": "#/definitions/rateLimitError", "isExpanded": true } ] }, { "statusCode": "500", "description": "Error response when the request cannot be processed due to an unexpected internal error.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Error response when the request cannot be processed due to an unexpected internal error.", "customType": "internalServerError", "schema": [ { "name": "errorCode", "kind": "optional", "type": "integer", "description": "HTTP status code for the internal server error.", "example": 500 }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "Human-readable summary of the internal server error.
", "example": "Internal Server Error" } ], "modelRef": "#/definitions/internalServerError", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.accertify.net/api/v1/unified-risk/preAuthTicketing \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data-raw '{\n \"transactionID\": \"ABC123456\",\n \"transactionDateTime\": \"2022-03-11T17:07:24-07:00\",\n \"eventSource\": \"web\",\n \"isGuestCheckout\": false,\n \"paymentAmount\": 1082.91,\n \"taxAmount\": 1.23,\n \"deliveryAmount\": 5.99,\n \"currencyCode\": \"USD\",\n \"success\": false,\n \"emailAddress\": \"a@example.com\",\n \"purchaseType\": \"physicalItems\",\n \"addresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"addressType\": \"shipping\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"billingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"items\": [\n {\n \"isHighRiskItem\": true,\n \"price\": 1199.99,\n \"shippingMethod\": \"storePickup\"\n }\n ],\n \"promotions\": [\n {\n \"promoAmount\": 50\n }\n ],\n \"ticketDetails\": [\n {\n \"ticketStartDateTime\": \"2020-02-22T17:07:24-07:00\"\n }\n ],\n \"activityInformation\": {\n \"activityDetails\": [\n {\n \"activitySupplier\": \"Chicago Segways\",\n \"activityName\": \"Lincoln Park Food Tour\"\n }\n ]\n }\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"transactionID\": \"ABC123456\",\n \"transactionDateTime\": \"2022-03-11T17:07:24-07:00\",\n \"eventSource\": \"web\",\n \"isGuestCheckout\": false,\n \"paymentAmount\": 1082.91,\n \"taxAmount\": 1.23,\n \"deliveryAmount\": 5.99,\n \"currencyCode\": \"USD\",\n \"success\": false,\n \"emailAddress\": \"a@example.com\",\n \"purchaseType\": \"physicalItems\",\n \"addresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"addressType\": \"shipping\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"billingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"items\": [\n {\n \"isHighRiskItem\": true,\n \"price\": 1199.99,\n \"shippingMethod\": \"storePickup\"\n }\n ],\n \"promotions\": [\n {\n \"promoAmount\": 50\n }\n ],\n \"ticketDetails\": [\n {\n \"ticketStartDateTime\": \"2020-02-22T17:07:24-07:00\"\n }\n ],\n \"activityInformation\": {\n \"activityDetails\": [\n {\n \"activitySupplier\": \"Chicago Segways\",\n \"activityName\": \"Lincoln Park Food Tour\"\n }\n ]\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.accertify.net/api/v1/unified-risk/preAuthTicketing\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.accertify.net/api/v1/unified-risk/preAuthTicketing\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"transactionID\": \"ABC123456\",\n \"transactionDateTime\": \"2022-03-11T17:07:24-07:00\",\n \"eventSource\": \"web\",\n \"isGuestCheckout\": false,\n \"paymentAmount\": 1082.91,\n \"taxAmount\": 1.23,\n \"deliveryAmount\": 5.99,\n \"currencyCode\": \"USD\",\n \"success\": false,\n \"emailAddress\": \"a@example.com\",\n \"purchaseType\": \"physicalItems\",\n \"addresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"addressType\": \"shipping\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"billingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"items\": [\n {\n \"isHighRiskItem\": true,\n \"price\": 1199.99,\n \"shippingMethod\": \"storePickup\"\n }\n ],\n \"promotions\": [\n {\n \"promoAmount\": 50\n }\n ],\n \"ticketDetails\": [\n {\n \"ticketStartDateTime\": \"2020-02-22T17:07:24-07:00\"\n }\n ],\n \"activityInformation\": {\n \"activityDetails\": [\n {\n \"activitySupplier\": \"Chicago Segways\",\n \"activityName\": \"Lincoln Park Food Tour\"\n }\n ]\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.accertify.net/api/v1/unified-risk/preAuthTicketing\"\n\npayload = json.dumps({\n \"transactionID\": \"ABC123456\",\n \"transactionDateTime\": \"2022-03-11T17:07:24-07:00\",\n \"eventSource\": \"web\",\n \"isGuestCheckout\": False,\n \"paymentAmount\": 1082.91,\n \"taxAmount\": 1.23,\n \"deliveryAmount\": 5.99,\n \"currencyCode\": \"USD\",\n \"success\": False,\n \"emailAddress\": \"a@example.com\",\n \"purchaseType\": \"physicalItems\",\n \"addresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"addressType\": \"shipping\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"shippingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"billingAddresses\": [\n {\n \"addressID\": \"23l4jk23klj23\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"phone\": \"3125555555\",\n \"phoneCountryCode\": \"001\",\n \"address1\": \"1863 Main Street\",\n \"city\": \"Anaheim\",\n \"region\": \"CA\",\n \"postCode\": \"92802\",\n \"country\": \"US\"\n }\n ],\n \"items\": [\n {\n \"isHighRiskItem\": True,\n \"price\": 1199.99,\n \"shippingMethod\": \"storePickup\"\n }\n ],\n \"promotions\": [\n {\n \"promoAmount\": 50\n }\n ],\n \"ticketDetails\": [\n {\n \"ticketStartDateTime\": \"2020-02-22T17:07:24-07:00\"\n }\n ],\n \"activityInformation\": {\n \"activityDetails\": [\n {\n \"activitySupplier\": \"Chicago Segways\",\n \"activityName\": \"Lincoln Park Food Tour\"\n }\n ]\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful response.\n{\n \"eventID\": \"\",\n \"eventDetails\": {\n \"deviceDetails\": {\n \"browserSpoofRisk\": \"HIGH_RISK\",\n \"deviceIDNew\": \"true\",\n \"browserIsMobile\": \"true\",\n \"mobileIsRooted\": \"true\",\n \"deviceIDFirstSeen\": 97,\n \"browserNewCookie\": \"false\",\n \"deviceIDTimesSeen\": 123,\n \"mobileApp\": \"true\",\n \"browserReplayTagStatus\": \"VALID\",\n \"deviceID\": \"63dc80b4-e585-4ae8-8004-e24fb0d1fa84\"\n },\n \"connectionDetails\": {\n \"hostingIndicator\": \"true\",\n \"isTor\": \"true\",\n \"hostingIndicatorReal\": \"true\",\n \"realIPMatch\": \"true\",\n \"countryCode\": \"us\",\n \"countryCodeReal\": \"de\",\n \"isProxy\": \"false\"\n }\n },\n \"paymentOptimization\": {\n \"3DSModule\": \"active\",\n \"3DSRun\": \"true\",\n \"3DSRecommendation\": \"06\",\n \"SCAResult\": \"In Scope Not Exempt\"\n },\n \"messages\": {\n \"error\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ],\n \"warning\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ],\n \"info\": [\n {\n \"code\": \"FIELD_REQUIRED_MISSING\",\n \"message\": \"transactionID is required and was not provided\",\n \"field\": \"transactionID\",\n \"details\": \"\"\n }\n ]\n },\n \"status\": false\n}" }, { "id": "response-1-400", "language": "400", "code": "// Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.\n{\n \"errorCode\": 400,\n \"errorMessage\": \"Validation Failed\",\n \"errors\": [\n \"\"\n ]\n}" }, { "id": "response-2-401", "language": "401", "code": "// Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.\n{\n \"errorCode\": 401,\n \"errorMessage\": \"Not Authorized\"\n}" }, { "id": "response-3-429", "language": "429", "code": "// Error response when the request rate limit has been exceeded for the API user or API configuration.\n{\n \"errorCode\": 429,\n \"errorMessage\": \"Rate Limit Exceeded\"\n}" }, { "id": "response-4-500", "language": "500", "code": "// Error response when the request cannot be processed due to an unexpected internal error.\n{\n \"errorCode\": 500,\n \"errorMessage\": \"Internal Server Error\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }