Adyen · JSON Structure

Accounts Vias Address Structure

ViasAddress schema from Adyen API

Type: object Properties: 6 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

city country houseNumberOrName postalCode stateOrProvince street

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/accounts-vias-address-structure.json",
  "description": "ViasAddress schema from Adyen API",
  "type": "object",
  "properties": {
    "city": {
      "description": "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
      "type": "string"
    },
    "country": {
      "description": "The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, **NL**.",
      "type": "string"
    },
    "houseNumberOrName": {
      "description": "The number or name of the house.",
      "type": "string"
    },
    "postalCode": {
      "description": "The postal code. Required if the `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.\n\nMaximum length:\n\n* 5 digits for addresses in the US.\n\n* 10 characters for all other countries.",
      "type": "string"
    },
    "stateOrProvince": {
      "description": "The abbreviation of the state or province. Required if the `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. \n\nMaximum length:\n\n* 2 characters for addresses in the US or Canada.\n\n* 3 characters for all other countries.\n",
      "type": "string"
    },
    "street": {
      "description": "The name of the street. Required if the `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.",
      "type": "string"
    }
  },
  "required": [
    "country"
  ],
  "name": "ViasAddress"
}