Adyen · Schema

DeliveryAddress

DeliveryAddress schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
city string The name of the city.
country string The two-character ISO-3166-1 alpha-2 country code. For example, **US**. >If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.
line1 string The street name. For example, if the address is "Rokin 49", provide "Rokin".
line2 string The house number or name. For example, if the address is "Rokin 49", provide "49".
line3 string Optional information about the address.
postalCode string The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries.
stateOrProvince string The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.
View JSON Schema on GitHub

JSON Schema

configuration-delivery-address-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-delivery-address-schema.json",
  "title": "DeliveryAddress",
  "description": "DeliveryAddress schema from Adyen API",
  "type": "object",
  "properties": {
    "city": {
      "description": "The name of the city.",
      "type": "string"
    },
    "country": {
      "description": "The two-character ISO-3166-1 alpha-2 country code. For example, **US**.\n>If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
      "type": "string"
    },
    "line1": {
      "description": "The street name. For example, if the address is \"Rokin 49\", provide \"Rokin\".",
      "type": "string"
    },
    "line2": {
      "description": "The house number or name. For example, if the address is \"Rokin 49\", provide \"49\".",
      "type": "string"
    },
    "line3": {
      "description": "Optional information about the address.",
      "type": "string"
    },
    "postalCode": {
      "description": "The postal code.\nMaximum length:\n* 5 digits for an address in the US.\n* 10 characters for an address in all other countries.",
      "type": "string"
    },
    "stateOrProvince": {
      "description": "The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
      "type": "string"
    }
  },
  "required": [
    "country"
  ]
}