Address is a JSON Structure definition published by Adyen, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/configuration-address-structure.json",
"description": "Address schema from Adyen API",
"type": "object",
"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"
],
"name": "Address"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.