Adyen · Schema

BulkAddress

BulkAddress schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
city	string	The name of the city.
company	string	The name of the company.
country	string	The two-character ISO-3166-1 alpha-2 country code. For example, US.
email	string	The email address.
houseNumberOrName	string	The house number or name.
mobile	string	The full telephone number.
postalCode	string	The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries.
stateOrProvince	string	The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US.
street	string	The streetname of the house.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-webhooks-bulk-address-schema.json",
  "title": "BulkAddress",
  "description": "BulkAddress schema from Adyen API",
  "type": "object",
  "properties": {
    "city": {
      "description": "The name of the city.",
      "type": "string"
    },
    "company": {
      "description": "The name of the company.",
      "type": "string"
    },
    "country": {
      "description": "The two-character ISO-3166-1 alpha-2 country code. For example, **US**.",
      "type": "string"
    },
    "email": {
      "description": "The email address.",
      "type": "string"
    },
    "houseNumberOrName": {
      "description": "The house number or name.",
      "type": "string"
    },
    "mobile": {
      "description": "The full telephone number.",
      "type": "string"
    },
    "postalCode": {
      "description": "The postal code.\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 two-letter ISO 3166-2 state or province code.\n\nMaximum length: 2 characters for addresses in the US.",
      "type": "string"
    },
    "street": {
      "description": "The streetname of the house.",
      "type": "string"
    }
  },
  "required": [
    "country"
  ]
}