Adyen · JSON Structure

Configuration Address Requirement Structure

AddressRequirement schema from Adyen API

Type: object Properties: 3 Required: 1
PaymentsFinancial ServicesFintech

AddressRequirement is a JSON Structure definition published by Adyen, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

description requiredAddressFields type

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/configuration-address-requirement-structure.json",
  "description": "AddressRequirement schema from Adyen API",
  "type": "object",
  "properties": {
    "description": {
      "description": "Specifies the required address related fields for a particular route.",
      "type": "string"
    },
    "requiredAddressFields": {
      "description": "List of address fields.",
      "items": {
        "enum": [
          "city",
          "country",
          "line1",
          "postalCode",
          "stateOrProvince"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "default": "addressRequirement",
      "description": "**addressRequirement**",
      "enum": [
        "addressRequirement"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "name": "AddressRequirement"
}