iGaming preAuth risk scoring

1 min

POST

https://api.accertify.net/api/v1/unified-risk/preAuthIGaming

Scores a pre-authorization transaction for iGaming and returns device and connection signals plus payment optimization.

Body Parameters

preAuthobjectrequired
Example
```
{
  "transactionID": "IGM-12345678",
  "transactionDateTime": "2022-06-10T14:30:00-05:00",
  "eventSource": "web",
  "accountID": "98712345678",
  "isGuestCheckout": false,
  "paymentAmount": 500,
  "deliveryAmount": 0,
  "success": false,
  "ipAddress": "10.12.12.123",
  "emailAddress": "[email protected]",
  "authenticationMethod": "password",
  "failureCode": "authFailed",
  "brand": "acme",
  "phoneNumber": "3125555555",
  "latitude": 41.878,
  "longitude": -87.629,
  "accountStatus": "active",
  "firstName": "Jane",
  "middleName": "Marie",
  "lastName": "Doe",
  "purchaseType": "services",
  "listingID": "abcd1234",
  "isPaymentOptimization": false,
  "account": {
    "isEnrolledInLoyaltyProgram": true,
    "loyaltyNumber": "Id1234",
    "accountLocale": "en-US",
    "accountLevel": "Gold",
    "accountType": "individual",
    "loyaltyProgramName": "Members Plus",
    "loyaltyPointsBalance": 987654321
  },
  "payment": {
    "isGift": false,
    "orderMessage": "Enjoy the gift",
    "isPaymentInInstallments": false,
    "isPaymentRecurring": false
  },
  "addresses": [
    {
      "addressType": "billing",
      "addressID": "23l4jk23klj23",
      "primaryFlag": true,
      "isAddressOnFile": true,
      "firstName": "Jane",
      "middleName": "Marie",
      "lastName": "Doe",
      "emailAddress": "[email protected]",
      "phone": "3125555555",
      "phoneCountryCode": "001",
      "address1": "1863 Main Street",
      "address2": "Apt 7",
      "city": "Chicago",
      "region": "IL",
      "postCode": "60601",
      "country": "US"
    }
  ],
  "paymentMethods": [
    {
      "paymentType": "creditCard",
      "paymentMethodID": "2ljr9vxsdfew",
      "paymentMethodAmount": 500,
      "isPaymentStoredOnFile": true,
      "cardToken": "6f7%gf38hfUa",
      "expirationMonth": "11",
      "expirationYear": "2027",
      "nameOnCreditCard": "Jane Doe",
      "cardBin": "345678",
      "cardLastFour": "1111",
      "totalFailedAttempts": 0,
      "addressID": "23kl4l32l"
    }
  ],
  "memberStats": {
    "wagersLast7Days": 42,
    "wagersAmountLast7Days": 850,
    "wagersWonLast7Days": 18,
    "averageWager7Days": 25.5,
    "houseLimit": 5000
  },
  "deposit": {
    "depositID": "DEP1234567",
    "depositDateTime": "2022-06-10T14:28:00-05:00",
    "depositTotalAmount": 500,
    "taxAmount": 0,
    "currencyCode": "USD",
    "salesRepID": "SR#46k90",
    "referralCode": "API 210315"
  }
}
```
Description
Top-level scalar fields shared by iGaming preAuth and postAuth. Tax and currency values are carried inside deposit or withdrawal. iGaming-specific top-level deposit, withdrawal, and member-statistics data.
- transactionIDstringrequired
  Example
  IGM-12345678
  Description
  [Required] Unique transaction identifier (max 40 chars).
  Max Length
  40
- transactionDateTimestring<date-time>required
  Example
  2022-06-10T14:30:00-05:00
  Description
  [Required] ISO 8601 timestamp of when the transaction occurred.
  Format
  date-time
- eventSourcestring<agentPhone | agentStore | affiliate | kiosk | mobileApp | other | web>required
  Example
  web
  Description
  [Required] Originating channel.
  Allowed
  agentPhoneagentStoreaffiliatekioskmobileAppotherweb
- accountIDstring
  Example
  98712345678
  Description
  [Conditional] Merchant internal account identifier; required when isGuestCheckout is false.
- isGuestCheckoutbooleanrequired
  Description
  [Required] Whether the customer checked out without an account.
- isAgenticCheckoutboolean
  Description
  [Optional] String "true"/"false" also accepted.
- paymentAmountnumberrequired
  Example
  500
  Description
  [Required] Total payment amount; zero or positive.
  Minimum
  0
- deliveryAmountnumberrequired
  Description
  [Required] Delivery amount; zero or positive.
  Minimum
  0
- successbooleanrequired
  Description
  [Required] Outcome of the transaction attempt.
- ipAddressstring
  Example
  10.12.12.123
  Description
  [Conditional] Client IP address; required for mobileApp or web.
- userAgentstring
  Example
  Mozilla/5.0
  Description
  [Conditional] Browser User-Agent; required when eventSource is web.
  Max Length
  250
- deviceTransactionIDstring
  Example
  e1a1aade06e2557f34036eeb06173faf1fa05c64959383
  Description
  [Optional] Device session token.
- devicePayloadstring
  Example
  afklasdjlasdjl3l23j23423klj
  Description
  [Optional] Device fingerprint payload.
- ubaIDstring
  Example
  3143e969395de649c48c1c9f3e363a3e7ae7
  Description
  [Optional] UBA session ID.
  Max Length
  100
- ubaEventsstring
  Example
  lasjdlkfdsljelkrrjwl3kl324j32k432
  Description
  [Optional] Serialized UBA events.
- emailAddressstringrequired
  Example
  [email protected]
  Description
  [Required] Customer email address.
- authenticationMethodstring<appAuthenticator | appPush | other | password | passkey | magicLink | SMS>
  Example
  password
  Description
  [Optional] Customer authentication method.
  Allowed
  appAuthenticatorappPushotherpasswordpasskeymagicLinkSMS
- failureCodestring<authFailed | exportCompliance | other>
  Example
  authFailed
  Description
  [Conditional] Required when success is false.
  Allowed
  authFailedexportComplianceother
- brandstring
  Example
  acme
  Description
  [Optional] Merchant sub-brand.
  Max Length
  50
- phoneNumberstring
  Example
  3125555555
  Description
  [Optional] Customer billing phone.
  Max Length
  25
- latitudenumber
  Example
  41.878
  Description
  [Optional] Transaction latitude.
- longitudenumber
  Example
  -87.629
  Description
  [Optional] Transaction longitude.
- accountStatusstring<active | dormant | suspended | terminated | trial | other>
  Example
  active
  Description
  [Optional] Current account status.
  Allowed
  activedormantsuspendedterminatedtrialother
- firstNamestring
  Example
  Jane
  Description
  [Optional] Customer billing first name.
- middleNamestring
  Example
  Marie
  Description
  [Optional] Customer billing middle name.
- lastNamestring
  Example
  Doe
  Description
  [Optional] Customer billing last name.
- purchaseTypestring<physicalItems | digitalItems | services | other>required
  Example
  services
  Description
  [Required] Nature of the purchase.
  Allowed
  physicalItemsdigitalItemsservicesother
- listingIDstring
  Example
  abcd1234
  Description
  [Optional] Marketplace listing identifier.
  Max Length
  50
- isPaymentOptimizationboolean
  Description
  [Optional] Whether payment optimization is enabled.
- depositobject
  Example
```
{
  "depositID": "DEP1234567",
  "depositDateTime": "2022-06-10T14:28:00-05:00",
  "depositTotalAmount": 500,
  "taxAmount": 0,
  "currencyCode": "USD",
  "salesRepID": "SR#46k90",
  "referralCode": "API 210315"
}
```
  Description
  Deposit details. Send either deposit or withdrawal, never both.
  - depositIDstring
    Example
    DEP1234567
    Description
    [Optional] Deposit identifier.
  - depositDateTimestring<date-time>
    Example
    2022-06-10T14:28:00-05:00
    Description
    [Conditional] Required when depositID is present.
    Format
    date-time
  - depositTotalAmountnumber
    Example
    500
    Description
    [Conditional] Total deposited amount.
    Minimum
    0
  - taxAmountnumber
    Description
    [Conditional] Deposit tax amount.
    Minimum
    0
  - currencyCodestring
    Example
    USD
    Description
    [Conditional] Deposit currency code.
  - salesRepIDstring
    Example
    SR#46k90
    Description
    [Optional] Sales representative identifier.
  - referralCodestring
    Example
    API 210315
    Description
    [Optional] Referral code.
- withdrawalobject
  Description
  Withdrawal details. Send either deposit or withdrawal, never both.
  - withdrawalIDstring
    Example
    WD1234567
    Description
    [Optional] Withdrawal identifier.
  - withdrawalDateTimestring<date-time>
    Example
    2022-03-11T17:07:24-07:00
    Description
    [Conditional] Required when withdrawalID is present.
    Format
    date-time
  - withdrawalTotalAmountnumber
    Example
    250
    Description
    [Conditional] Total withdrawn amount.
    Minimum
    0
  - taxAmountnumber
    Description
    [Conditional] Withdrawal tax amount.
    Minimum
    0
  - currencyCodestring
    Example
    USD
    Description
    [Conditional] Withdrawal currency code.
- memberStatsobject
  Example
```
{
  "wagersLast7Days": 42,
  "wagersAmountLast7Days": 850,
  "wagersWonLast7Days": 18,
  "averageWager7Days": 25.5,
  "houseLimit": 5000
}
```
  Description
  Rolling-window wagering statistics for the member account.
  - wagersLastDayinteger
    Example
    42
    Description
    [Optional] Number of wagers over the last day.
    Minimum
    0
  - wagersAmountLastDaynumber
    Example
    850
    Description
    [Optional] Total amount wagered over the last day.
    Minimum
    0
  - wagersWonLastDayinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the last day.
    Minimum
    0
  - wagersAmountWonLastDaynumber
    Example
    1200
    Description
    [Optional] Total amount won over the last day.
    Minimum
    0
  - averageOddsLastDaynumber
    Example
    2.15
    Description
    [Optional] Average odds over the last day.
    Minimum
    0
  - wagersLast7Daysinteger
    Example
    42
    Description
    [Optional] Number of wagers over the last 7 days.
    Minimum
    0
  - wagersAmountLast7Daysnumber
    Example
    850
    Description
    [Optional] Total amount wagered over the last 7 days.
    Minimum
    0
  - wagersWonLast7Daysinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the last 7 days.
    Minimum
    0
  - wagersAmountWonLast7Daysnumber
    Example
    1200
    Description
    [Optional] Total amount won over the last 7 days.
    Minimum
    0
  - averageOddsLast7Daysnumber
    Example
    2.15
    Description
    [Optional] Average odds over the last 7 days.
    Minimum
    0
  - wagersLast30Daysinteger
    Example
    42
    Description
    [Optional] Number of wagers over the last 30 days.
    Minimum
    0
  - wagersAmountLast30Daysnumber
    Example
    850
    Description
    [Optional] Total amount wagered over the last 30 days.
    Minimum
    0
  - wagersWonLast30Daysinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the last 30 days.
    Minimum
    0
  - wagersAmountWonLast30Daysnumber
    Example
    1200
    Description
    [Optional] Total amount won over the last 30 days.
    Minimum
    0
  - averageOddsLast30Daysnumber
    Example
    2.15
    Description
    [Optional] Average odds over the last 30 days.
    Minimum
    0
  - wagersLast90Daysinteger
    Example
    42
    Description
    [Optional] Number of wagers over the last 90 days.
    Minimum
    0
  - wagersAmountLast90Daysnumber
    Example
    850
    Description
    [Optional] Total amount wagered over the last 90 days.
    Minimum
    0
  - wagersWonLast90Daysinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the last 90 days.
    Minimum
    0
  - wagersAmountWonLast90Daysnumber
    Example
    1200
    Description
    [Optional] Total amount won over the last 90 days.
    Minimum
    0
  - averageOddsLast90Daysnumber
    Example
    2.15
    Description
    [Optional] Average odds over the last 90 days.
    Minimum
    0
  - wagersLast365Daysinteger
    Example
    42
    Description
    [Optional] Number of wagers over the last 365 days.
    Minimum
    0
  - wagersAmountLast365Daysnumber
    Example
    850
    Description
    [Optional] Total amount wagered over the last 365 days.
    Minimum
    0
  - wagersWonLast365Daysinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the last 365 days.
    Minimum
    0
  - wagersAmountWonLast365Daysnumber
    Example
    1200
    Description
    [Optional] Total amount won over the last 365 days.
    Minimum
    0
  - averageOddsLast365Daysnumber
    Example
    2.15
    Description
    [Optional] Average odds over the last 365 days.
    Minimum
    0
  - wagersLifetimeinteger
    Example
    42
    Description
    [Optional] Number of wagers over the account's lifetime.
    Minimum
    0
  - wagersAmountLifetimenumber
    Example
    850
    Description
    [Optional] Total amount wagered over the account's lifetime.
    Minimum
    0
  - wagersWonLifetimeinteger
    Example
    18
    Description
    [Optional] Number of wagers won over the account's lifetime.
    Minimum
    0
  - wagersAmountWonLifetimenumber
    Example
    1200
    Description
    [Optional] Total amount won over the account's lifetime.
    Minimum
    0
  - averageOddsLifetimenumber
    Example
    2.15
    Description
    [Optional] Average odds over the account's lifetime.
    Minimum
    0
  - averageWagerLastDaynumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the last day.
    Minimum
    0
  - averageWager7Daysnumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the last 7 days.
    Minimum
    0
  - averageWager30Daysnumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the last 30 days.
    Minimum
    0
  - averageWager90Daysnumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the last 90 days.
    Minimum
    0
  - averageWager365Daysnumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the last 365 days.
    Minimum
    0
  - averageWagerLifetimenumber
    Example
    25.5
    Description
    [Optional] Average wager amount over the account's lifetime.
    Minimum
    0
  - maxWagerLastDaynumber
    Example
    500
    Description
    [Optional] Largest wager amount over the last day.
    Minimum
    0
  - maxWager7Daysnumber
    Example
    500
    Description
    [Optional] Largest wager amount over the last 7 days.
    Minimum
    0
  - maxWager30Daysnumber
    Example
    500
    Description
    [Optional] Largest wager amount over the last 30 days.
    Minimum
    0
  - maxWager90Daysnumber
    Example
    500
    Description
    [Optional] Largest wager amount over the last 90 days.
    Minimum
    0
  - maxWager365Daysnumber
    Example
    500
    Description
    [Optional] Largest wager amount over the last 365 days.
    Minimum
    0
  - maxWagerLifetimenumber
    Example
    500
    Description
    [Optional] Largest wager amount over the account's lifetime.
    Minimum
    0
  - minWagerLastDaynumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the last day.
    Minimum
    0
  - minWager7Daysnumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the last 7 days.
    Minimum
    0
  - minWager30Daysnumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the last 30 days.
    Minimum
    0
  - minWager90Daysnumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the last 90 days.
    Minimum
    0
  - minWager365Daysnumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the last 365 days.
    Minimum
    0
  - minWagerLifetimenumber
    Example
    1
    Description
    [Optional] Smallest wager amount over the account's lifetime.
    Minimum
    0
  - earlyCashoutsLastDayinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the last day.
    Minimum
    0
  - earlyCashoutsLast7Daysinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the last 7 days.
    Minimum
    0
  - earlyCashoutsLast30Daysinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the last 30 days.
    Minimum
    0
  - earlyCashoutsLast90Daysinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the last 90 days.
    Minimum
    0
  - earlyCashoutsLast365Daysinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the last 365 days.
    Minimum
    0
  - earlyCashoutsLifetimeinteger
    Example
    3
    Description
    [Optional] Number of early cashouts over the account's lifetime.
    Minimum
    0
  - earlyCashoutsAmountLastDaynumber
    Example
    75
    Description
    [Optional] Early cashout amount over the last day.
    Minimum
    0
  - earlyCashoutsAmountLast7Daysnumber
    Example
    75
    Description
    [Optional] Early cashout amount over the last 7 days.
    Minimum
    0
  - earlyCashoutsAmountLast30Daysnumber
    Example
    75
    Description
    [Optional] Early cashout amount over the last 30 days.
    Minimum
    0
  - earlyCashoutsAmountLast90Daysnumber
    Example
    75
    Description
    [Optional] Early cashout amount over the last 90 days.
    Minimum
    0
  - earlyCashoutsAmountLast365Daysnumber
    Example
    75
    Description
    [Optional] Early cashout amount over the last 365 days.
    Minimum
    0
  - earlyCashoutsAmountLifetimenumber
    Example
    75
    Description
    [Optional] Early cashout amount over the account's lifetime.
    Minimum
    0
  - liveWagersLastDayinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the last day.
    Minimum
    0
  - liveWagersLast7Daysinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the last 7 days.
    Minimum
    0
  - liveWagersLast30Daysinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the last 30 days.
    Minimum
    0
  - liveWagersLast90Daysinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the last 90 days.
    Minimum
    0
  - liveWagersLast365Daysinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the last 365 days.
    Minimum
    0
  - liveWagersLifetimeinteger
    Example
    5
    Description
    [Optional] Number of live wagers over the account's lifetime.
    Minimum
    0
  - averageTimeBeforeMatchnumber
    Example
    45
    Description
    [Optional] Average minutes between wager placement and match start.
    Minimum
    0
  - houseLimitnumber
    Example
    5000
    Description
    [Optional] Maximum wager amount the house permits.
    Minimum
    0
- accountobject
  Example
```
{
  "isEnrolledInLoyaltyProgram": true,
  "loyaltyNumber": "Id1234",
  "accountLocale": "en-US",
  "accountLevel": "Gold",
  "accountType": "individual",
  "loyaltyProgramName": "Members Plus",
  "loyaltyPointsBalance": 987654321
}
```
  Description
  Nested object containing account-level details for the transacting customer.
  - isEnrolledInLoyaltyProgramboolean
    Example
    true
    Description
    [Optional] Whether the account holds a loyalty membership ("true"/"false").
  - loyaltyNumberstring
    Example
    Id1234
    Description
    [Optional] Customer's loyalty program membership number.
  - accountLocalestring
    Example
    en-US
    Description
    [Optional] Account locale/language preference (e.g., "en-US").
  - accountLevelstring
    Example
    Gold
    Description
    [Optional] Customer tier within the loyalty or membership program (e.g., "Gold").
  - accountTypestring<individual | business | family | other>
    Example
    individual
    Description
    [Optional] Account category; one of: individual, business, family, other.
    Allowed
    individualbusinessfamilyother
  - accountRegistrationDateTimestring<date-time>
    Example
    2020-11-22T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of when the account was created.
    Format
    date-time
  - accountEmailUpdatedDateTimestring<date-time>
    Example
    2020-08-28T19:00:00-04:00
    Description
    [Optional] ISO 8601 timestamp of the last email address change on the account.
    Format
    date-time
  - accountPasswordUpdatedDateTimestring<date-time>
    Example
    2021-06-15T10:30:00-07:00
    Description
    [Optional] ISO 8601 timestamp of the last password change on the account.
    Format
    date-time
  - dateOfBirthstring<date>
    Example
    1985-11-15
    Description
    [Optional] Customer's date of birth in ISO 8601 date format (YYYY-MM-DD).
    Format
    date
  - loyaltyProgramNamestring
    Example
    Members Plus
    Description
    [Optional] Name of the loyalty program the account belongs to (max 100 chars).
    Max Length
    100
  - loyaltyPointsBalanceinteger
    Example
    987654321
    Description
    [Optional] Current point balance in the loyalty program; zero or positive.
    Minimum
    0
- paymentobject
  Example
```
{
  "isGift": false,
  "orderMessage": "Enjoy the gift",
  "isPaymentInInstallments": false,
  "isPaymentRecurring": false
}
```
  Description
  Additional iGaming payment-level details.
  - isGiftboolean
    Description
    [Optional] Whether the transaction is a gift.
  - orderMessagestring
    Example
    Enjoy the gift
    Description
    [Optional] Personal message or order instruction associated with the transaction.
  - isPaymentInInstallmentsboolean
    Description
    [Optional] Whether payment uses installments.
  - installmentAmountnumber
    Example
    99.99
    Description
    [Optional] Amount of each installment.
    Minimum (exclusive)
    0
  - installmentCurrencyCodestring
    Example
    USD
    Description
    [Conditional] Required when installments are used.
  - installmentCountinteger
    Example
    12
    Description
    [Conditional] Number of installments.
    Minimum (exclusive)
    0
  - isPaymentRecurringboolean
    Description
    [Optional] Whether payment recurs.
- addressesobject[]
  Example
```
[
  {
    "addressType": "billing",
    "addressID": "23l4jk23klj23",
    "primaryFlag": true,
    "isAddressOnFile": true,
    "firstName": "Jane",
    "middleName": "Marie",
    "lastName": "Doe",
    "emailAddress": "[email protected]",
    "phone": "3125555555",
    "phoneCountryCode": "001",
    "address1": "1863 Main Street",
    "address2": "Apt 7",
    "city": "Chicago",
    "region": "IL",
    "postCode": "60601",
    "country": "US"
  }
]
```
  - addressIDstringrequired
    Example
    23l4jk23klj23
    Description
    [Required] Merchant-assigned identifier for this address record.
  - addressTypestring<account | billing | bopis | curbside | departure | destination | fulfillment | listing | lodging | pickup | return | shipping | venue | other>required
    Example
    billing
    Description
    [Required] Role of this address in the order.
    Allowed
    accountbillingbopiscurbsidedeparturedestinationfulfillmentlistinglodgingpickupreturnshippingvenueother
  - primaryFlagboolean
    Example
    true
    Description
    [Optional] Marks this as the account's primary address (true/false).
  - isAddressOnFileboolean
    Example
    true
    Description
    [Optional] Whether this address was previously saved to the account ("true"/"false").
  - firstNamestringrequired
    Example
    Jane
    Description
    [Required] Recipient's first name at this address.
  - middleNamestring
    Example
    Marie
    Description
    [Optional] Recipient's middle name at this address.
  - lastNamestringrequired
    Example
    Doe
    Description
    [Required] Recipient's last name at this address.
  - emailAddressstring
    Example
    [email protected]
    Description
    [Conditional] Recipient's email address; required when addressType is account or billing.
  - phonestringrequired
    Example
    3125555555
    Description
    [Required] Recipient's phone number.
  - phoneCountryCodestringrequired
    Example
    001
    Description
    [Required] International dial prefix for the phone number (for example, "001").
  - address1stringrequired
    Example
    1863 Main Street
    Description
    [Required] Primary street address line.
  - address2string
    Example
    Apt 7
    Description
    [Optional] Secondary address line (suite, apartment, etc.).
  - citystringrequired
    Example
    Chicago
    Description
    [Required] City component of the address.
  - regionstringrequired
    Example
    IL
    Description
    [Required] State or region component of the address.
  - postCodestringrequired
    Example
    60601
    Description
    [Required] Postal or ZIP code.
  - countrystringrequired
    Example
    US
    Description
    [Required] ISO 3166-1 alpha-2 country code.
  - companyNamestring
    Example
    Accertify, Inc
    Description
    [Optional] Business name at this address.
  - addressCreatedDateTimestring<date-time>
    Example
    2020-03-28T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of when this address was saved.
    Format
    date-time
  - addressUpdatedDateTimestring<date-time>
    Example
    2021-03-28T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of the last modification to this address.
    Format
    date-time
- paymentMethodsobject[]
  Example
```
[
  {
    "paymentType": "creditCard",
    "paymentMethodID": "2ljr9vxsdfew",
    "paymentMethodAmount": 500,
    "isPaymentStoredOnFile": true,
    "cardToken": "6f7%gf38hfUa",
    "expirationMonth": "11",
    "expirationYear": "2027",
    "nameOnCreditCard": "Jane Doe",
    "cardBin": "345678",
    "cardLastFour": "1111",
    "totalFailedAttempts": 0,
    "addressID": "23kl4l32l"
  }
]
```
  - paymentTypestring<bankAccount | cash | check | creditCard | cryptoCurrency | digitalWallet | electronicFundTransfer | giftCard | invoice | loan | loyaltyPoints | moneyOrder | secCard | storeCredit | thirdParty | voucher>
    Example
    creditCard
    Description
    [Conditional] Type of payment instrument. Required when paymentMethodID is present.
    Allowed
    bankAccountcashcheckcreditCardcryptoCurrencydigitalWalletelectronicFundTransfergiftCardinvoiceloanloyaltyPointsmoneyOrdersecCardstoreCreditthirdPartyvoucher
  - paymentMethodIDstring
    Example
    2ljr9vxsdfew
    Description
    [Optional] Merchant-assigned identifier for this payment method.
  - paymentMethodAmountnumber
    Example
    500
    Description
    [Optional] Amount charged to this payment method.
    Minimum
    0
  - isPaymentStoredOnFileboolean
    Example
    true
    Description
    [Optional] Whether this instrument is saved to the account ("true"/"false").
  - cardNumberstring
    Example
    4111111111111111
    Description
    [Optional] Full card number (PAN) for credit card payments, validated using the Luhn algorithm.
  - cardTokenstring
    Example
    6f7%gf38hfUa
    Description
    [Optional] Tokenized representation of the card number.
  - expirationMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 8 | 9 | 10 | 11 | 12>
    Example
    11
    Description
    [Conditional] Zero-padded two-digit card expiration month ("01".."12"); required when paymentType = creditCard.
    Allowed
    0102030405060789101112
  - expirationYearstring
    Example
    2027
    Description
    [Conditional] Card expiration year (4-digit); required when paymentType = creditCard.
  - nameOnCreditCardstring
    Example
    Jane Doe
    Description
    [Conditional] Cardholder name as embossed on the card; required when paymentType = creditCard.
  - cardBinstring
    Example
    345678
    Description
    [Optional] Bank Identification Number (6 to 11 digits) of the card.
  - cardLastFourstring
    Example
    1111
    Description
    [Optional] Last four digits of the card number.
  - totalFailedAttemptsinteger
    Description
    [Optional] Number of failed payment attempts for this method.
    Minimum
    0
  - paymentMethodCreatedDateTimestring<date-time>
    Example
    2020-03-28T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of when this payment method was saved.
    Format
    date-time
  - paymentMethodUpdatedDateTimestring<date-time>
    Example
    2020-03-28T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of the last update to this payment method.
    Format
    date-time
  - addressIDstring
    Example
    23kl4l32l
    Description
    [Optional] Reference to the billing address record for this payment method.
  - nameOnAccountstring
    Example
    Jane Doe
    Description
    [Optional] Name on file for a wallet or account-based payment method.
  - walletTypestring
    Example
    Apple Pay
    Description
    [Optional] Digital wallet provider.
  - walletStatusstring<active | pending | inactive>
    Example
    active
    Description
    [Optional] Current status of the wallet.
    Allowed
    activependinginactive
  - isWalletProtectionEligibleboolean
    Example
    true
    Description
    [Optional] Whether the wallet is eligible for purchase protection ("true"/"false").
  - paymentMethodBalanceAmountnumber
    Example
    4000.32
    Description
    [Optional] Remaining balance available on this payment method.
    Minimum (exclusive)
    0
  - giftCardNumberstring
    Example
    5555444433332222
    Description
    [Optional] Full gift card number.
  - giftCardLastFourstring
    Example
    2222
    Description
    [Optional] Last four digits of the gift card number.
  - giftCardBINstring
    Example
    654678
    Description
    [Optional] Bank Identification Number (first 6 digits) of the gift card.
  - expirationDaystring
    Example
    9
    Description
    [Optional] Card expiration day, for payment types that include a day component.
  - pointsinteger
    Example
    50000
    Description
    [Optional] Loyalty or reward points balance associated with this payment method.
  - loyaltyProgramNamestring
    Example
    Members Plus
    Description
    [Optional] Name of the loyalty program associated with this payment method.
  - accountTypestring<checking | saving | moneyMarket | other>
    Example
    checking
    Description
    [Conditional] Bank account type; required when paymentType = bankAccount.
    Allowed
    checkingsavingmoneyMarketother
- itemsobject[]
  - itemTypestring<giftCard | parking | physicalGood | reservation | subscription | ticket | other>
    Example
    physicalGood
    Description
    [Optional] Category of item; one of: giftCard, parking, physicalGood, reservation, subscription, ticket, other.
    Allowed
    giftCardparkingphysicalGoodreservationsubscriptionticketother
  - brandNamestring
    Example
    Apple
    Description
    [Optional] Brand or manufacturer of the item.
  - descriptionstring
    Example
    Macbook Pro
    Description
    [Optional] Short description or name of the item.
  - categorystring
    Example
    Computers
    Description
    [Optional] Merchant-defined product category.
  - itemIDstring
    Example
    af877wernnasnfes
    Description
    [Optional] Merchant's unique product or SKU identifier.
  - isHighRiskItembooleanrequired
    Example
    true
    Description
    [Required] Whether the item is flagged as high risk ("true"/"false").
  - pricenumberrequired
    Example
    1199.99
    Description
    [Required] Unit price of the item; positive number.
    Minimum
    0
  - faceValueAmountnumber
    Example
    1599.99
    Description
    [Optional] Face or retail value of the item; zero or positive.
    Minimum
    0
  - quantitynumber
    Example
    2
    Description
    [Optional] Number of units of this item in the order.
  - addressIDstring
    Example
    2lkj34jldsoufsous82df
    Description
    [Conditional] Delivery address reference for this line item; required when shippingMethod is present.
  - productConditionstring<new | openPackage | other | refurbished | used>
    Example
    new
    Description
    [Optional] Condition of the item; one of: new, openPackage, other, refurbished, used.
    Allowed
    newopenPackageotherrefurbishedused
  - shippingCompanystring<dhl | fedex | ups | usps | other>
    Example
    ups
    Description
    [Optional] Carrier for this item; one of: dhl, fedex, ups, usps, other.
    Allowed
    dhlfedexupsuspsother
  - companyNamestring
    Example
    Regional Courier Co
    Description
    [Optional] Shipping company name for this item, when not one of the standard carriers (max 50 chars).
    Max Length
    50
  - shippingMethodstring<digital | ground | international | other | nextDay | sameDay | storePickup | twoDay | threeDay>required
    Example
    ground
    Description
    [Required] Shipping speed or method.
    Allowed
    digitalgroundinternationalothernextDaysameDaystorePickuptwoDaythreeDay
  - shippingTrackingNumberstring
    Example
    23l4fdswerea02
    Description
    [Optional] Carrier tracking number for this item (max 30 chars).
    Max Length
    30
  - promoCodestring
    Example
    ABC12
    Description
    [Optional] Promotion code applied specifically to this item (max 40 chars).
    Max Length
    40
  - promoAmountnumber
    Example
    50
    Description
    [Optional] Discount applied to this item; zero or positive.
    Minimum
    0
  - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
    Example
    employeeDiscount
    Description
    [Optional] Category of the item-level promotion.
    Allowed
    bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother
  - pickupLocationstring<curbside | dropBox | inStore | other>
    Example
    curbside
    Description
    [Optional] In-store or curbside pickup method; one of: curbside, dropBox, inStore, other.
    Allowed
    curbsidedropBoxinStoreother
  - pickupDateTimestring<date-time>
    Example
    2022-03-11T17:07:24-07:00
    Description
    [Optional] ISO 8601 timestamp of the scheduled pickup.
    Format
    date-time
  - pickupPersonFirstNamestring
    Example
    Betty
    Description
    [Optional] First name of the person collecting the order (max 40 chars).
    Max Length
    40
  - pickupPersonLastNamestring
    Example
    Smith
    Description
    [Optional] Last name of the person collecting the order (max 40 chars).
    Max Length
    40
- promotionsobject[]
  - promoCodestring
    Example
    ABC12
    Description
    [Optional] Promotional code applied to the order.
  - promoAmountnumberrequired
    Example
    50
    Description
    [Required] Discount amount granted by this promotion; zero or positive.
    Minimum
    0
  - promoTypestring<bogo | bundle | employeeDiscount | freeShipping | loyaltyDiscount | newMemberDiscount | percentage | quantityPromotion | other>
    Example
    employeeDiscount
    Description
    [Optional] Category of the promotion (e.g., employeeDiscount, freeShipping).
    Allowed
    bogobundleemployeeDiscountfreeShippingloyaltyDiscountnewMemberDiscountpercentagequantityPromotionother

Responses

200Successful response.

scoredPreAuthResult
Description
Successful response.
- eventIDstring
- eventDetailseventDetails
  Description
  Device and connection risk signals (scored responses only)
  - deviceDetailsobject
    - browserSpoofRiskstring
      Example
      HIGH_RISK
      Description
      [Optional] Risk indicator for browser spoofing detected during device collection.
    - deviceIDNewstring
      Example
      true
      Description
      [Optional] A flag indicating the device ID was observed for the first time ("true"/"false").
    - browserIsMobilestring
      Example
      true
      Description
      [Optional] A flag indicating the browser is running on a mobile device ("true"/"false").
    - mobileIsRootedstring
      Example
      true
      Description
      [Optional] A flag indicating the mobile device is rooted or jailbroken ("true"/"false").
    - deviceIDFirstSeennumber
      Example
      97
      Description
      [Optional] Number of days since this device ID was first observed.
    - browserNewCookiestring
      Example
      false
      Description
      [Optional] A flag indicating a new browser cookie was set during this session ("true"/"false").
    - deviceIDTimesSeennumber
      Example
      123
      Description
      [Optional] Total number of times this device ID has been seen.
    - mobileAppstring
      Example
      true
      Description
      [Optional] A flag indicating the event originated from a mobile app.
    - browserReplayTagStatusstring
      Example
      VALID
      Description
      [Optional] Status of the UBA replay tag detected in the session.
    - deviceIDstring
      Example
      63dc80b4-e585-4ae8-8004-e24fb0d1fa84
      Description
      [Optional] Unique persistent identifier assigned to the device.
  - connectionDetailsobject
    - hostingIndicatorstring
      Example
      true
      Description
      [Optional] A flag indicating the client IP address belongs to a hosting provider ("true"/"false").
    - isTorstring
      Example
      true
      Description
      [Optional] A flag indicating the client IP address is a Tor exit node ("true"/"false").
    - hostingIndicatorRealstring
      Example
      true
      Description
      [Optional] A flag indicating the client real IP address belongs to a hosting provider ("true"/"false").
    - realIPMatchstring
      Example
      true
      Description
      [Optional] A flag indicating the stated IP address matches the detected real IP address ("true"/"false").
    - countryCodestring
      Example
      us
      Description
      [Optional] ISO 3166-1 alpha-2 country code of the client IP address.
    - countryCodeRealstring
      Example
      de
      Description
      [Optional] ISO 3166-1 alpha-2 country code of the real IP address when a proxy is detected.
    - isProxystring
      Example
      false
      Description
      [Optional] A flag indicating the client IP address is a known proxy ("true"/"false").
- paymentOptimizationpaymentOptimization
  Description
  3-D Secure optimization output (preAuth scored responses only)
  - 3DSModulestring
    Example
    active
    Description
    [Optional] The 3DS module selected for this transaction.
  - 3DSRunstring
    Example
    true
    Description
    [Optional] A flag indicating the 3DS module was invoked ("true"/"false").
  - 3DSRecommendationstring<00 | 01 | 02 | 03 | 04 | 05 | 06 | >
    Example
    06
    Description
    [Optional] Recommended 3DS action code, which may be blank.
    Allowed
    00010203040506
  - SCAResultstring<In Scope Exempt TRA | In Scope Exempt LVT | In Scope Exempt SCP | In Scope Not Exempt | Out of Scope>
    Example
    In Scope Not Exempt
    Description
    [Optional] Strong customer authentication result from the 3DS evaluation.
    Allowed
    In Scope Exempt TRAIn Scope Exempt LVTIn Scope Exempt SCPIn Scope Not ExemptOut of Scope
- messagesapiMessages
  - errorapiMessage[]
    - codestringrequired
      Example
      FIELD_REQUIRED_MISSING
      Description
      Machine-readable message code
    - messagestringrequired
      Example
      transactionID is required and was not provided
      Description
      Human-readable message
    - fieldstring
      Example
      transactionID
      Description
      Name of the field this message applies to
    - detailsmap<string, string>
      Description
      Structured detail keys.
  - warningapiMessage[]
    - codestringrequired
      Example
      FIELD_REQUIRED_MISSING
      Description
      Machine-readable message code
    - messagestringrequired
      Example
      transactionID is required and was not provided
      Description
      Human-readable message
    - fieldstring
      Example
      transactionID
      Description
      Name of the field this message applies to
    - detailsmap<string, string>
      Description
      Structured detail keys.
  - infoapiMessage[]
    - codestringrequired
      Example
      FIELD_REQUIRED_MISSING
      Description
      Machine-readable message code
    - messagestringrequired
      Example
      transactionID is required and was not provided
      Description
      Human-readable message
    - fieldstring
      Example
      transactionID
      Description
      Name of the field this message applies to
    - detailsmap<string, string>
      Description
      Structured detail keys.
- statusbooleanrequired

400Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.

validationFailedError
Description
Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.
- errorCodeinteger
  Example
  400
  Description
  HTTP status code for the validation error.
- errorMessagestring
  Example
  Validation Failed
  Description
  Human-readable summary of the validation error.
- errorsstring[]
  Example
```
[
  "Missing required field: transactionID"
]
```
  Description
  Validation error details for the request.

401Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.

notAuthorizedError
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.
- errorCodeinteger
  Example
  401
  Description
  HTTP status code for the authentication or authorization error.
- errorMessagestring
  Example
  Not Authorized
  Description
  Human-readable summary of the authentication or authorization error.

429Error response when the request rate limit has been exceeded for the API user or API configuration.

rateLimitError
Description
Error response when the request rate limit has been exceeded for the API user or API configuration.
- errorCodeinteger
  Example
  429
  Description
  HTTP status code for the rate-limit error.
- errorMessagestring
  Example
  Rate Limit Exceeded
  Description
  Human-readable summary of the rate-limit error.

500Error response when the request cannot be processed due to an unexpected internal error.

internalServerError
Description
Error response when the request cannot be processed due to an unexpected internal error.
- errorCodeinteger
  Example
  500
  Description
  HTTP status code for the internal server error.
- errorMessagestring
  Example
  Internal Server Error
  Description
  Human-readable summary of the internal server error.

curl

curl --request POST \
     --url https://api.accertify.net/api/v1/unified-risk/preAuthIGaming \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "transactionID": "IGM-12345678",
     "transactionDateTime": "2022-06-10T14:30:00-05:00",
     "eventSource": "web",
     "isGuestCheckout": false,
     "paymentAmount": 500,
     "deliveryAmount": 0,
     "success": false,
     "emailAddress": "[email protected]",
     "purchaseType": "services",
     "addresses": [
     {
     "addressID": "23l4jk23klj23",
     "addressType": "billing",
     "firstName": "Jane",
     "lastName": "Doe",
     "phone": "3125555555",
     "phoneCountryCode": "001",
     "address1": "1863 Main Street",
     "city": "Chicago",
     "region": "IL",
     "postCode": "60601",
     "country": "US"
     }
     ],
     "items": [
     {
     "isHighRiskItem": true,
     "price": 1199.99,
     "shippingMethod": "ground"
     }
     ],
     "promotions": [
     {
     "promoAmount": 50
     }
     ]
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "transactionID": "IGM-12345678",
   "transactionDateTime": "2022-06-10T14:30:00-05:00",
   "eventSource": "web",
   "isGuestCheckout": false,
   "paymentAmount": 500,
   "deliveryAmount": 0,
   "success": false,
   "emailAddress": "[email protected]",
   "purchaseType": "services",
   "addresses": [
      {
         "addressID": "23l4jk23klj23",
         "addressType": "billing",
         "firstName": "Jane",
         "lastName": "Doe",
         "phone": "3125555555",
         "phoneCountryCode": "001",
         "address1": "1863 Main Street",
         "city": "Chicago",
         "region": "IL",
         "postCode": "60601",
         "country": "US"
      }
   ],
   "items": [
      {
         "isHighRiskItem": true,
         "price": 1199.99,
         "shippingMethod": "ground"
      }
   ],
   "promotions": [
      {
         "promoAmount": 50
      }
   ]
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.accertify.net/api/v1/unified-risk/preAuthIGaming", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.accertify.net/api/v1/unified-risk/preAuthIGaming")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "transactionID": "IGM-12345678",
   "transactionDateTime": "2022-06-10T14:30:00-05:00",
   "eventSource": "web",
   "isGuestCheckout": false,
   "paymentAmount": 500,
   "deliveryAmount": 0,
   "success": false,
   "emailAddress": "[email protected]",
   "purchaseType": "services",
   "addresses": [
      {
         "addressID": "23l4jk23klj23",
         "addressType": "billing",
         "firstName": "Jane",
         "lastName": "Doe",
         "phone": "3125555555",
         "phoneCountryCode": "001",
         "address1": "1863 Main Street",
         "city": "Chicago",
         "region": "IL",
         "postCode": "60601",
         "country": "US"
      }
   ],
   "items": [
      {
         "isHighRiskItem": true,
         "price": 1199.99,
         "shippingMethod": "ground"
      }
   ],
   "promotions": [
      {
         "promoAmount": 50
      }
   ]
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.accertify.net/api/v1/unified-risk/preAuthIGaming"

payload = json.dumps({
   "transactionID": "IGM-12345678",
   "transactionDateTime": "2022-06-10T14:30:00-05:00",
   "eventSource": "web",
   "isGuestCheckout": False,
   "paymentAmount": 500,
   "deliveryAmount": 0,
   "success": False,
   "emailAddress": "[email protected]",
   "purchaseType": "services",
   "addresses": [
      {
         "addressID": "23l4jk23klj23",
         "addressType": "billing",
         "firstName": "Jane",
         "lastName": "Doe",
         "phone": "3125555555",
         "phoneCountryCode": "001",
         "address1": "1863 Main Street",
         "city": "Chicago",
         "region": "IL",
         "postCode": "60601",
         "country": "US"
      }
   ],
   "items": [
      {
         "isHighRiskItem": True,
         "price": 1199.99,
         "shippingMethod": "ground"
      }
   ],
   "promotions": [
      {
         "promoAmount": 50
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful response.
{
  "eventID": "",
  "eventDetails": {
    "deviceDetails": {
      "browserSpoofRisk": "HIGH_RISK",
      "deviceIDNew": "true",
      "browserIsMobile": "true",
      "mobileIsRooted": "true",
      "deviceIDFirstSeen": 97,
      "browserNewCookie": "false",
      "deviceIDTimesSeen": 123,
      "mobileApp": "true",
      "browserReplayTagStatus": "VALID",
      "deviceID": "63dc80b4-e585-4ae8-8004-e24fb0d1fa84"
    },
    "connectionDetails": {
      "hostingIndicator": "true",
      "isTor": "true",
      "hostingIndicatorReal": "true",
      "realIPMatch": "true",
      "countryCode": "us",
      "countryCodeReal": "de",
      "isProxy": "false"
    }
  },
  "paymentOptimization": {
    "3DSModule": "active",
    "3DSRun": "true",
    "3DSRecommendation": "06",
    "SCAResult": "In Scope Not Exempt"
  },
  "messages": {
    "error": [
      {
        "code": "FIELD_REQUIRED_MISSING",
        "message": "transactionID is required and was not provided",
        "field": "transactionID",
        "details": ""
      }
    ],
    "warning": [
      {
        "code": "FIELD_REQUIRED_MISSING",
        "message": "transactionID is required and was not provided",
        "field": "transactionID",
        "details": ""
      }
    ],
    "info": [
      {
        "code": "FIELD_REQUIRED_MISSING",
        "message": "transactionID is required and was not provided",
        "field": "transactionID",
        "details": ""
      }
    ]
  },
  "status": false
}

400

// Error response for invalid or missing request inputs. Returned when one or more required fields are absent or fail validation.
{
  "errorCode": 400,
  "errorMessage": "Validation Failed",
  "errors": [
    ""
  ]
}

401

// Error response for authentication or authorization failures. Returned when credentials are invalid or the authenticated user has no matching API configuration for this endpoint.
{
  "errorCode": 401,
  "errorMessage": "Not Authorized"
}

429

// Error response when the request rate limit has been exceeded for the API user or API configuration.
{
  "errorCode": 429,
  "errorMessage": "Rate Limit Exceeded"
}

500

// Error response when the request cannot be processed due to an unexpected internal error.
{
  "errorCode": 500,
  "errorMessage": "Internal Server Error"
}