Data Elements
Key | Format | Condition | Description | |
---|---|---|---|---|
1 | city | string | C | City. Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). |
2 | object | C | Alpha-3 country code according to ISO 3166-1:2013. Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). | |
3 | addressLine1 | object | C | First line of the street address. Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). |
4 | addressLine2 | string | C | Second line of the street address (e.g. apartment, suite, floor, PO Box, etc.). Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). |
5 | addressLine3 | string | C | Third line of the street address. Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). |
6 | postalCode | string | C | ZIP or other postal code. Required unless market or regional mandate restricts sending this information. For shipping details this data element might not be available (e.g. digital goods). |
7 | state | string | C | Alpha-2 code of state or province according to ISO 3166-2. Required unless market or regional mandate restricts sending this information, or State is not applicable for this country. For shipping details this data element might not be available (e.g. digital goods). Please do not use this parameter within the EU. |
addressLine1
Key | Format | Condition | Description | |
---|---|---|---|---|
1 | street | string | M | Street name. |
2 | streetNumber | string | C | Street or house number. |
Schema
{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://www.computop-paygate.com/schemas/address.json", "title": "address", "description": "Address", "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "object", "properties": { "countryName": { "type": "string", "description": "Name of the country." }, "countryA2": { "type": "string", "description": "ISO-3166 alpha-2 code." }, "countryA3": { "type": "string", "description": "ISO 3166-1:2013 alpha-3" }, "countryNumber": { "type": "string", "description": "ISO-3166 numeric code." } }, "required": ["countryA3"], "additionalProperties": false }, "addressLine1": { "type": "object", "properties": { "street": { "type": "string" }, "streetNumber": { "type": "string" } }, "required": ["street"], "additionalProperties": false }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string", "minLength": 2, "maxLength": 2, "description": "Alpha-2 code of state or province according to ISO 3166-2:2013 where applicable" } }, "required": ["country", "addressLine1", "postalCode"], "additionalProperties": false }
Sample
{ "city": "New York", "country": { "countryA3": "USA" }, "addressLine1": { "street": "Park Avenue", "streetNumber": "270" }, "postalCode": "10017-2070", "state": "NY" }