address
JSON object
address
Please note that the data within all JSON objects is encoded using UTF-8 and then must be also Base64 encoded. This applies in particular to special characters such as “Umlaute” and diactrics.
“address”-JSON is sent as “billingAddress” or “shippingAddress”. An overview of parameters can be found here:
• Card processing – common form
• Card processing – common Server-to-Server
Data elements
| Key | Format | CND | Description |
| city | string(..50) | 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). Will become mandatory for VISA on 2024-02-12. |
| country | 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). Will become mandatory for VISA on 2024-02-12. |
| 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). Will become mandatory for VISA on 2024-02-12. |
| addressLine2 | string(..50) | 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). |
| addressLine3 | string(..50) | 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). |
| postalCode | string(..16) | 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). Will become mandatory for VISA on 2024-02-12. |
| state | string(2) | 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). Will become mandatory for VISA on 2024-02-12. Please do not use this parameter within the EU. |
addressLine1
| Key | Format | CND | Description | |
|---|---|---|---|---|
| 1 | street | string(..50) | M | Street name |
| 2 | streetNumber | string | C | Street or house number |
Please note that “street” and “streetNumber” together can only contain a total length of 50 characters. If more characters are used, the system will shorten the values accordingly.
Schema
BASEURL= https://www.computop-paygate.com/schemas
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "BASEURL/address.json",
"title": "address",
"description": "Address",
"type": "object",
"properties": {
"city": {
"type": "string",
"maxLength": 50
},
"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" ,
"maxLength": 50
},
"streetNumber": {
"type": "string"
}
},
"required": ["street"],
"additionalProperties": false
},
"addressLine2": {
"type": "string",
"maxLength": 50
},
"addressLine3": {
"type": "string",
"maxLength": 50
},
"postalCode": {
"type": "string",
"maxLength": 16
},
"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”
}
