Adyen · Schema

AddressRequirement

AddressRequirement schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
description string Specifies the required address related fields for a particular route.
requiredAddressFields array List of address fields.
type string **addressRequirement**
View JSON Schema on GitHub

JSON Schema

configuration-address-requirement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-address-requirement-schema.json",
  "title": "AddressRequirement",
  "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
}