Mastercard · Schema

ConsumerCreditAnalytics

Object containing list of customer PAN's along with score type and product type for which score will be fetched.

Credit CardsDigital IdentityFinancial ServicesFraud DetectionOpen BankingPaymentsFortune 500

Properties

Name Type Description
hasEmbedding boolean A boolean indicating that the user of this API has requested for embedding data for the PANs. Possible value - true or false
countryCode string The 3-letter country abbreviation for the customer. These abbreviations follow https://www.iso.org/iso-3166-country-codes.html.
customerPANs array The card numbers and consents for which score needs to be retrieved. Max 20 PAN numbers are allowed in a request.
scoreTypes array Type of score needs to be retrieved for the card number, Possible value - DELINQUENCY.
productTypes array Type of products for which score needs to be retrieved of the card number, Possible value - CREDIT_CARD.
View JSON Schema on GitHub

JSON Schema

mastercard-consumer-credit-analytics-consumer-credit-analytics-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ConsumerCreditAnalytics",
  "type": "object",
  "description": "Object containing list of customer PAN's along with score type and product type for which score will be fetched.\n",
  "properties": {
    "hasEmbedding": {
      "type": "boolean",
      "description": "A boolean indicating that the user of this API has requested for embedding data for the PANs. Possible value - true or false"
    },
    "countryCode": {
      "type": "string",
      "description": "The 3-letter country abbreviation for the customer. These abbreviations follow https://www.iso.org/iso-3166-country-codes.html."
    },
    "customerPANs": {
      "type": "array",
      "description": "The card numbers and consents for which score needs to be retrieved. Max 20 PAN numbers are allowed in a request."
    },
    "scoreTypes": {
      "type": "array",
      "description": "Type of score needs to be retrieved for the card number, Possible value - DELINQUENCY."
    },
    "productTypes": {
      "type": "array",
      "description": "Type of products for which score needs to be retrieved of the card number, Possible value - CREDIT_CARD."
    }
  }
}