Adyen · Schema

Address

Address schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
city string The name of the city. Required if `stateOrProvince` is provided. If you specify the city, you must also send `postalCode` and `street`.
country string The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
postalCode string Postal code. Required if `stateOrProvince` and/or `city` is provided.
stateOrProvince string The two-letter ISO 3166-2 state or province code. For example, **CA** in the US. If you specify the state or province, you must also send `city`, `postalCode`, and `street`.
street string The name of the street, and the house or building number. Required if `stateOrProvince` and/or `city` is provided.
street2 string The apartment, unit, or suite number.
View JSON Schema on GitHub

JSON Schema

legal-entity-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/legal-entity-address-schema.json",
  "title": "Address",
  "description": "Address schema from Adyen API",
  "type": "object",
  "properties": {
    "city": {
      "description": "The name of the city. Required if `stateOrProvince` is provided.\n\nIf you specify the city, you must also send `postalCode` and `street`.",
      "type": "string"
    },
    "country": {
      "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.",
      "type": "string"
    },
    "postalCode": {
      "description": "Postal code. Required if `stateOrProvince` and/or `city` is provided.",
      "type": "string"
    },
    "stateOrProvince": {
      "description": "The two-letter ISO 3166-2 state or province code. For example, **CA** in the US.\n\nIf you specify the state or province, you must also send `city`, `postalCode`, and `street`.",
      "type": "string"
    },
    "street": {
      "description": "The name of the street, and the house or building number. Required if `stateOrProvince` and/or `city` is provided.",
      "type": "string"
    },
    "street2": {
      "description": "The apartment, unit, or suite number.",
      "type": "string"
    }
  },
  "required": [
    "country"
  ]
}