Adyen · JSON Structure

Configuration Delivery Address Structure

DeliveryAddress schema from Adyen API

Type: object Properties: 7 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

city country line1 line2 line3 postalCode stateOrProvince

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-delivery-address-structure.json",
  "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"
  ],
  "name": "DeliveryAddress"
}