Adyen · JSON Structure

Payments Additional Data Risk Structure

AdditionalDataRisk schema from Adyen API

Type: object Properties: 21
PaymentsFinancial ServicesFintech

AdditionalDataRisk is a JSON Structure definition published by Adyen, describing 21 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

riskdata.[customFieldName] riskdata.basket.item[itemNr].amountPerItem riskdata.basket.item[itemNr].brand riskdata.basket.item[itemNr].category riskdata.basket.item[itemNr].color riskdata.basket.item[itemNr].currency riskdata.basket.item[itemNr].itemID riskdata.basket.item[itemNr].manufacturer riskdata.basket.item[itemNr].productTitle riskdata.basket.item[itemNr].quantity riskdata.basket.item[itemNr].receiverEmail riskdata.basket.item[itemNr].size riskdata.basket.item[itemNr].sku riskdata.basket.item[itemNr].upc riskdata.promotions.promotion[itemNr].promotionCode riskdata.promotions.promotion[itemNr].promotionDiscountAmount riskdata.promotions.promotion[itemNr].promotionDiscountCurrency riskdata.promotions.promotion[itemNr].promotionDiscountPercentage riskdata.promotions.promotion[itemNr].promotionName riskdata.riskProfileReference riskdata.skipRisk

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/payments-additional-data-risk-structure.json",
  "description": "AdditionalDataRisk schema from Adyen API",
  "type": "object",
  "properties": {
    "riskdata.[customFieldName]": {
      "description": "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].amountPerItem": {
      "description": "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].brand": {
      "description": "Brand of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].category": {
      "description": "Category of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].color": {
      "description": "Color of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].currency": {
      "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].itemID": {
      "description": "ID of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].manufacturer": {
      "description": "Manufacturer of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].productTitle": {
      "description": "A text description of the product the invoice line refers to.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].quantity": {
      "description": "Quantity of the item purchased.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].receiverEmail": {
      "description": "Email associated with the given product in the basket (usually in electronic gift cards).",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].size": {
      "description": "Size of the item.",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].sku": {
      "description": "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).",
      "type": "string"
    },
    "riskdata.basket.item[itemNr].upc": {
      "description": "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).",
      "type": "string"
    },
    "riskdata.promotions.promotion[itemNr].promotionCode": {
      "description": "Code of the promotion.",
      "type": "string"
    },
    "riskdata.promotions.promotion[itemNr].promotionDiscountAmount": {
      "description": "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
      "type": "string"
    },
    "riskdata.promotions.promotion[itemNr].promotionDiscountCurrency": {
      "description": "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
      "type": "string"
    },
    "riskdata.promotions.promotion[itemNr].promotionDiscountPercentage": {
      "description": "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.",
      "type": "string"
    },
    "riskdata.promotions.promotion[itemNr].promotionName": {
      "description": "Name of the promotion.",
      "type": "string"
    },
    "riskdata.riskProfileReference": {
      "description": "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).",
      "type": "string"
    },
    "riskdata.skipRisk": {
      "description": "If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.",
      "type": "string"
    }
  },
  "name": "AdditionalDataRisk"
}