On This Page

Checking Enrollment with a Network Token/Tokenized Card

Running the Check Enrollment service identifies the customer's bank and collects data about the device that the customer is using to place the order. This instance demonstrates this process with a network token/tokenized card.

Card-Specific Requirements

Some payment cards require additional information to be collected during a transaction.

consumerAuthenticationInformation. defaultCard
consumerAuthenticationInformation.mcc
consumerAuthenticationInformation. productCode: This field is required for American Express SafeKey (US) when the product code is
AIR
for an airline purchase.
merchantInformation.merchantDescriptor. name: This field is required for Visa Secure travel.
orderInformation.shipTo.addess1: This field is required only for American Express SafeKey (US).

orderInformation.shipTo.address2: This field is required only for American Express SafeKey (US.)
orderInformation.shipTo.administrativeArea: This field is required only for American Express SafeKey (US).
orderInformation.shipTo.country: This field is required only for American Express SafeKey (US).
orderInformation.shipTo.postalCode: This field is required for American Express SafeKey (US).

paymentInformation.card.type: This field is required when the card type is
JCB
.

Country-Specific Requirements

These fields are required for transactions in specific countries.

consumerAuthenticationInformation. merchantScore: This field is required for transactions processed in France.
consumerAuthenticationInformation. overrideCountryCode
merchantInformation.merchantDescriptor. country
orderInformation.billTo.administrativeArea: This field is required for transactions in the US and Canada.
orderinformation.billTo.locality: This field is required for transactions in the US and Canada.
orderInformation.billTo.postalCode: This field is required when the
orderInformation.billTo.country
field value is
US
or
CA
.

orderInformation.shipTo.administrativeArea: This field is required when the
orderInformation.shipTo.country
field value is
CA
or
US
.

orderInformation.shipTo.postalCode: This field is required when the
orderInformation.shipTo.country
field value is
US
or
CA
.

Processor-Specific Requirements

These fields are required by specific processors for transactions.

processingInformation.authorizationOptions. transactionMode: This field is required only for merchants in Saudi Arabia.

Endpoint

Production:

POST https://nabgateway-api.nab.com.au/risk/v1/authentications

Test:

POST https://nabgateway-api-test.nab.com.au/risk/v1/authentications

Required Fields for Checking Enrollment When Using a Network Token/Tokenized Card

These fields are the minimum fields required for verifying that a customer is enrolled in a payer authentation program when using a tokenized card.

Required Fields


consumerAuthenticationInformation.deviceChannel
consumerAuthenticationInformation.referenceId
customer.customerId
orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount: This field is required when the
orderInformation.lineItems.unitPrice
field is not used.
orderInformation.billTo.address1
orderInformation.billTo.address2
orderInformation.billTo.administrativeArea: This field is required for the US and Canada.
orderInformation.billTo.country: This field is required for the US and Canada.
orderInformation.billTo.email
orderInformation.billTo.firstName
orderInformation.billTo.lastName
orderinformation.billTo.locality
orderInformation.billTo.phoneNumber
orderInformation.billTo.postalCode
paymentInformation.tokenizedCard. expirationMonth
paymentInformation.tokenizedCard. expirationYea
paymentInformation.tokenizedCard.number
paymentInformation.tokenizedCard. transactionType
paymentInformation.tokenizedCard.type

REST Example: Checking Enrollment When Using a Network Token/Tokenized Card (Frictionless)

Request

{
  "orderInformation": {
    "amountDetails": {
      "currency": "USD",
      "totalAmount": "10.99"
    },
    "billTo": {
      "address1": "1 Market St",
      "address2": "Address 2",
      "administrativeArea": "CA",
      "country": "US",
      "locality": "san francisco",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "4158880000",
      "email": "[email protected]",
      "postalCode": "94105"
    }
  },
  "paymentInformation": {
    "tokenizedCard": {
      "transactionType": "1",
      "type": "001",
      "expirationMonth": "11",
      "expirationYear": "2025",
      "number": "4111111111111111"
    }
  },
  "deviceInformation": {
    "ipAddress": "139.130.4.5",
    "httpAcceptContent": "test",
    "httpBrowserLanguage": "en_us",
    "httpBrowserJavaEnabled": "N",
    "httpBrowserJavaScriptEnabled": "Y",
    "httpBrowserColorDepth": "24",
    "httpBrowserScreenHeight": "100000",
    "httpBrowserScreenWidth": "100000",
    "httpBrowserTimeDifference": "300",
    "userAgentBrowserValue": "GxKnLy8TFDUFxJP1t"
  },
  "consumerAuthenticationInformation": {
    "deviceChannel": "BROWSER",
    "referenceId": "CybsCruiseTester-a8a8eeaf"
  }
}

Response to Successful Request

{
    "clientReferenceInformation": {
        "code": "1725450267324"
    },
    "consumerAuthenticationInformation": {
        "eciRaw": "05",
        "authenticationTransactionId": "o9spMK5vH7MK5lAPku60",
        "strongAuthentication": {
            "OutageExemptionIndicator": "0"
            },
        "eci": "05",
        "token": "AxjzbwSTiURy4Xhjhs+lABEBTyDYGCNvSBcS0JiGTSTL0YrmYUwEwAAASAVA",
        "cavv": "AJkBBkhgQQAAAE4gSEJydQAAAAA=",
        "paresStatus": "Y",
        "acsReferenceNumber": "Cardinal ACS",
        "xid": "AJkBBkhgQQAAAE4gSEJydQAAAAA=",
        "directoryServerTransactionId": "51a3b89b-10c4-4718-8300-4cdc779d1434",
        "veresEnrolled": "Y",
        "threeDSServerTransactionId": "1a9c8944-6d0b-46d4-a964-5e986cff9c1b",
        "acsOperatorID": "MerchantACS",
        "ecommerceIndicator": "vbv",
        "specificationVersion": "2.1.0",
        "acsTransactionId": "b022828d-7440-4815-a5f8-28cf3f568f02"
    },
    "id": "7254502673416960004005",
    "paymentInformation": {
        "card": {
            "bin": "411111",
            "type": "VISA"
        }
    },
    "status": "AUTHENTICATION_SUCCESSFUL",
    "submitTimeUtc": "2024-09-04T11:44:27Z"
}