Adyen · JSON Structure

Configuration Bulk Address Structure

BulkAddress schema from Adyen API

Type: object Properties: 9 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

city company country email houseNumberOrName mobile 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/configuration-bulk-address-structure.json",
  "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"
  ],
  "name": "BulkAddress"
}