Adyen · JSON Structure

Checkout Merchant Risk Indicator Structure

MerchantRiskIndicator schema from Adyen API

Type: object Properties: 14
PaymentsFinancial ServicesFintech

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

Properties

addressMatch deliveryAddressIndicator deliveryEmail deliveryEmailAddress deliveryTimeframe giftCardAmount giftCardCount giftCardCurr preOrderDate preOrderPurchase preOrderPurchaseInd reorderItems reorderItemsInd shipIndicator

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/checkout-merchant-risk-indicator-structure.json",
  "description": "MerchantRiskIndicator schema from Adyen API",
  "type": "object",
  "properties": {
    "addressMatch": {
      "description": "Whether the chosen delivery address is identical to the billing address.",
      "type": "boolean"
    },
    "deliveryAddressIndicator": {
      "description": "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`",
      "enum": [
        "shipToBillingAddress",
        "shipToVerifiedAddress",
        "shipToNewAddress",
        "shipToStore",
        "digitalGoods",
        "goodsNotShipped",
        "other"
      ],
      "type": "string"
    },
    "deliveryEmail": {
      "deprecated": true,
      "x-deprecatedInVersion": "68",
      "x-deprecatedMessage": "Use `deliveryEmailAddress` instead.",
      "description": "The delivery email address (for digital goods).",
      "type": "string"
    },
    "deliveryEmailAddress": {
      "x-addedInVersion": "68",
      "description": "For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.",
      "maxLength": 254,
      "type": "string"
    },
    "deliveryTimeframe": {
      "description": "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`",
      "enum": [
        "electronicDelivery",
        "sameDayShipping",
        "overnightShipping",
        "twoOrMoreDaysShipping"
      ],
      "type": "string"
    },
    "giftCardAmount": {
      "description": "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
      "$ref": "#/components/schemas/Amount"
    },
    "giftCardCount": {
      "description": "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
      "type": "int32"
    },
    "giftCardCurr": {
      "x-addedInVersion": "68",
      "description": "For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.",
      "type": "string"
    },
    "preOrderDate": {
      "description": "For pre-order purchases, the expected date this product will be available to the shopper.",
      "type": "datetime"
    },
    "preOrderPurchase": {
      "description": "Indicator for whether this transaction is for pre-ordering a product.",
      "type": "boolean"
    },
    "preOrderPurchaseInd": {
      "x-addedInVersion": "68",
      "description": "Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.",
      "type": "string"
    },
    "reorderItems": {
      "description": "Indicator for whether the shopper has already purchased the same items in the past.",
      "type": "boolean"
    },
    "reorderItemsInd": {
      "x-addedInVersion": "68",
      "description": "Indicates whether the cardholder is reordering previously purchased merchandise.",
      "type": "string"
    },
    "shipIndicator": {
      "x-addedInVersion": "68",
      "description": "Indicates shipping method chosen for the transaction.",
      "type": "string"
    }
  },
  "name": "MerchantRiskIndicator"
}