Adyen · Schema

BillingAddress

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
city	string	The name of the city. Maximum length: 3000 characters.
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`.
houseNumberOrName	string	The number or name of the house. Maximum length: 3000 characters.
postalCode	string	A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
stateOrProvince	string	The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada. > Required for the US and Canada.
street	string	The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingAddress",
  "title": "BillingAddress",
  "properties": {
    "city": {
      "description": "The name of the city. Maximum length: 3000 characters.",
      "maxLength": 3000,
      "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"
    },
    "houseNumberOrName": {
      "description": "The number or name of the house. Maximum length: 3000 characters.",
      "maxLength": 3000,
      "type": "string"
    },
    "postalCode": {
      "description": "A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.",
      "type": "string"
    },
    "stateOrProvince": {
      "description": "The two-character ISO 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"
    },
    "street": {
      "description": "The name of the street. Maximum length: 3000 characters.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.",
      "maxLength": 3000,
      "type": "string"
    }
  },
  "required": [
    "street",
    "houseNumberOrName",
    "city",
    "postalCode",
    "country"
  ],
  "type": "object"
}