Mastercard · Schema

TransactionInsightsData

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name Type Description
purchaseDate string The purchase date in format YYYYMMDDHHMMSS
purchaseAmount string The amount of the transaction in the currency's basic unit. If the purchase amount is USD 123.45, element will contain the value 12345. Max value is MAX_LONG (9223372036854775807)
purchaseCurrencyExponent string The Purchase currency Exponent. If the purchase amount is USD 123.45, then the exponent will contain 2.
purchaseCurrency string The currency of the transaction amount, as an ISO-4217 currency code. See: [ISO-4217](https://www.nationsonline.org/oneworld/currencies.htm)
merchantName string The name of the business.
merchantCountryCode string The ISO-3166 numeric country code of the merchant associated with the transaction. See: [ISO-3166](https://www.nationsonline.org/oneworld/country_code_list.htm).
mcc string The Merchant Category Code associated with the transaction.
ipAddress string IPv4 address is represented in the dotted decimal format of 4 sets of decimal numbers separated by dots. The decimal number in each and every set is in the range 0 to 255. IPv6 address is represented
userAgent string The user-agent string of the consumer device attempting to authorize with your product or service. The user-agent must represent the HTTP client of the service consumer with details on the software or
canvas string The canvas signature of the browser installed on the consumer device.
webGl string The webGL signature of the browser installed on the consumer device.
timeZone string Time-zone of the consumer device. The timezone must be a number of the time-zone offset, in minutes, from the date based on current host system settings to UTC.
screenResolution string The screen resolution of the consumer device attempting to authorize with your product or service.
localStorage boolean Flag to local storage is enabled on the consumer device.
language string The language of the consumer device. The language must be a string representing the language version as defined in BCP-47.
colorDepth integer The device screen color depth value.
buildManufacturer string Manufacturer of the product/hardware.
placement string This optional field contains the placement identifier within the application.
androidBuildVersion string Build is used to determine information about the current build, extracted from system properties.
androidSdkInt string The user-visible SDK version of the framework; its possible values are defined in Build.VERSION_CODES.
buildFingerprint string String that uniquely identifies this build.
buildBrand string Consumer-visible brand with which the product/hardware will be associated, if any.
supportedFeatures array List of the supported features on the consumer device.
model string Mobile device manufacturer and modelAndroid: Build.MANUFACTURER + " " + Build.MODEL returns the mobile device manufacturer and model, For example,"samsung SM-G960U1", iOS: utsname.machine returns the
sdkUserAgent string The unique package name/bundle identifier of the client's application. Android: obtained from the applicationContext.getPackageName() method. iOS: obtained from the [NSBundle mainBundle] bundleIdentif
majorOsVersion integer Major operating system version.
minorOsVersion integer Minor operating system version.
simCountryIso string ISO country code equivalent for the SIM provider's country code.
simOperator string MCC+MNC (mobile country code + mobile network code) of the SIM provider.
primaryStorage integer Device primary storage size.
systemMemory integer Device System memory size.
buildProduct string Name of the overall product.
vendorAppId string Alphanumeric string that uniquely identifies a device to the app vendor.
storedDeviceId string Optional unique device identifier that merchant can store on consumer device. E.g with cookie in web flow.
androidId string Google's unique device identifier. A 64-bit number (as a hex string) that is randomly generated when the end user first sets up the device.
hashedAccountId string The hashed account identifier used during the authorization attempt.
endCustomerRefId string The End Customer Reference identifier is used during the reseller transaction request.
cookiesEnabled boolean Flag to indicate cookies are enabled on the consumer device.
plugins array A list of browser plugins.
acquirerMerchantId string The merchant ID that the transaction was processed under, as assigned by the acquirer.
acquirerBin string The BIN (Bank Identification Number) of the acquirer.
cardHolderName string The full name of the person.
secondaryName string The full name of the person.
primaryEmail string The primary contact detail - Email id
secondaryEmail string Secondary email to contact if primary details are not reachable
View JSON Schema on GitHub

JSON Schema

mastercard-identity-insights-for-transactions-transaction-insights-data-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "TransactionInsightsData",
  "type": "object",
  "properties": {
    "purchaseDate": {
      "type": "string",
      "description": "The purchase date in format YYYYMMDDHHMMSS"
    },
    "purchaseAmount": {
      "type": "string",
      "description": "The amount of the transaction in the currency's basic unit. If the purchase amount is USD 123.45, element will contain the value 12345. Max value is MAX_LONG (9223372036854775807)"
    },
    "purchaseCurrencyExponent": {
      "type": "string",
      "description": "The Purchase currency Exponent. If the purchase amount is USD 123.45, then the exponent will contain 2."
    },
    "purchaseCurrency": {
      "type": "string",
      "description": "The currency of the transaction amount, as an ISO-4217 currency code. See: [ISO-4217](https://www.nationsonline.org/oneworld/currencies.htm)"
    },
    "merchantName": {
      "type": "string",
      "description": "The name of the business."
    },
    "merchantCountryCode": {
      "type": "string",
      "description": "The ISO-3166 numeric country code of the merchant associated with the transaction. See: [ISO-3166](https://www.nationsonline.org/oneworld/country_code_list.htm)."
    },
    "mcc": {
      "type": "string",
      "description": "The Merchant Category Code associated with the transaction."
    },
    "ipAddress": {
      "type": "string",
      "description": "IPv4 address is represented in the dotted decimal format of 4 sets\nof decimal numbers separated by dots. The decimal number in each and\nevery set is in the range 0 to 255. IPv6 address is represented as\neight groups of four hexadecimal digits, each group representing 16\nbits (two octets. The groups are separated by colons (:).\n- Optional to generate individual insights\n- Required to generate device insights"
    },
    "userAgent": {
      "type": "string",
      "description": "The user-agent string of the consumer device attempting to authorize\nwith your product or service. The user-agent must represent the HTTP\nclient of the service consumer with details on the software\noriginating the request.\n- Optional to generate individual insights\n- Required to generate device insights"
    },
    "canvas": {
      "type": "string",
      "description": "The canvas signature of the browser installed on the consumer device."
    },
    "webGl": {
      "type": "string",
      "description": "The webGL signature of the browser installed on the consumer device."
    },
    "timeZone": {
      "type": "string",
      "description": "Time-zone of the consumer device. The timezone must be a number of the time-zone offset, in minutes, from the date based on current host system settings to UTC."
    },
    "screenResolution": {
      "type": "string",
      "description": "The screen resolution of the consumer device attempting to authorize with your product or service."
    },
    "localStorage": {
      "type": "boolean",
      "description": "Flag to local storage is enabled on the consumer device."
    },
    "language": {
      "type": "string",
      "description": "The language of the consumer device. The language must be a string representing the language version as defined in BCP-47."
    },
    "colorDepth": {
      "type": "integer",
      "description": "The device screen color depth value."
    },
    "buildManufacturer": {
      "type": "string",
      "description": "Manufacturer of the product/hardware."
    },
    "placement": {
      "type": "string",
      "description": "This optional field contains the placement identifier within the application."
    },
    "androidBuildVersion": {
      "type": "string",
      "description": "Build is used to determine information about the current build, extracted from system properties."
    },
    "androidSdkInt": {
      "type": "string",
      "description": "The user-visible SDK version of the framework; its possible values are defined in Build.VERSION_CODES."
    },
    "buildFingerprint": {
      "type": "string",
      "description": "String that uniquely identifies this build."
    },
    "buildBrand": {
      "type": "string",
      "description": "Consumer-visible brand with which the product/hardware will be associated, if any."
    },
    "supportedFeatures": {
      "type": "array",
      "description": "List of the supported features on the consumer device."
    },
    "model": {
      "type": "string",
      "description": "Mobile device manufacturer and modelAndroid: Build.MANUFACTURER + \" \" + Build.MODEL returns the mobile device manufacturer and model, For example,\"samsung SM-G960U1\",\n\niOS: utsname.machine returns the device model, For example, \"iPhone10.4\". Note: Apple as a manufacturer is not included because it is the same for all iOS devices."
    },
    "sdkUserAgent": {
      "type": "string",
      "description": "The unique package name/bundle identifier of the client's application.\n\nAndroid: obtained from the applicationContext.getPackageName() method.\n\niOS: obtained from the [NSBundle mainBundle] bundleIdentifier property."
    },
    "majorOsVersion": {
      "type": "integer",
      "description": "Major operating system version."
    },
    "minorOsVersion": {
      "type": "integer",
      "description": "Minor operating system version."
    },
    "simCountryIso": {
      "type": "string",
      "description": "ISO country code equivalent for the SIM provider's country code."
    },
    "simOperator": {
      "type": "string",
      "description": "MCC+MNC (mobile country code + mobile network code) of the SIM provider."
    },
    "primaryStorage": {
      "type": "integer",
      "description": "Device primary storage size."
    },
    "systemMemory": {
      "type": "integer",
      "description": "Device System memory size."
    },
    "buildProduct": {
      "type": "string",
      "description": "Name of the overall product."
    },
    "vendorAppId": {
      "type": "string",
      "description": "Alphanumeric string that uniquely identifies a device to the app vendor."
    },
    "storedDeviceId": {
      "type": "string",
      "description": "Optional unique device identifier that merchant can store on consumer device. E.g with cookie in web flow."
    },
    "androidId": {
      "type": "string",
      "description": "Google's unique device identifier. A 64-bit number (as a hex string) that is randomly generated when the end user first sets up the device."
    },
    "hashedAccountId": {
      "type": "string",
      "description": "The hashed account identifier used during the authorization attempt."
    },
    "endCustomerRefId": {
      "type": "string",
      "description": "The End Customer Reference identifier is used during the reseller transaction request."
    },
    "cookiesEnabled": {
      "type": "boolean",
      "description": "Flag to indicate cookies are enabled on the consumer device."
    },
    "plugins": {
      "type": "array",
      "description": "A list of browser plugins."
    },
    "acquirerMerchantId": {
      "type": "string",
      "description": "The merchant ID that the transaction was processed under, as assigned by the acquirer."
    },
    "acquirerBin": {
      "type": "string",
      "description": "The BIN (Bank Identification Number) of the acquirer."
    },
    "cardHolderName": {
      "type": "string",
      "description": "The full name of the person."
    },
    "secondaryName": {
      "type": "string",
      "description": "The full name of the person."
    },
    "primaryEmail": {
      "type": "string",
      "description": "The primary contact detail - Email id"
    },
    "secondaryEmail": {
      "type": "string",
      "description": "Secondary email to contact if primary details are not reachable"
    }
  }
}