address | Computop Documents

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:

Data Elements

Key

Format

CND

Description

city

string(..50)

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).

country

object

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).

addressLine1

object

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).

addressLine2

string(..50)

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)

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)

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).

state

string(2)

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

CND

Description

street

string(..50)

Street name

streetNumber

string

Street or house number

Notice: 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

1
{
2
    "$schema": "http://json-schema.org/draft-07/schema#",
3
    "$id": "BASEURL/address.json",
4
    "title": "address",
5
    "description": "Address",
6
    "type": "object",
7
    "properties": {
8
        "city": {
9
            "type": "string",
10
            "maxLength": 50
11
         },
12
        "country": {
13
            "type": "object",
14
            "properties": {
15
                "countryName": {
16
                    "type": "string",
17
                    "description": "Name of the country."
18
                },
19
                "countryA2": {
20
                    "type": "string",
21
                    "description": "ISO-3166 alpha-2 code."
22
                },
23
                "countryA3": {
24
                    "type": "string",
25
                    "description": "ISO 3166-1:2013 alpha-3"
26
                },
27
                "countryNumber": {
28
                    "type": "string",
29
                    "description": "ISO-3166 numeric code."
30
                }
31
            },
32
            "required": ["countryA3"],
33
            "additionalProperties": false
34
        },
35
        "addressLine1": {
36
            "type": "object",
37
            "properties": {
38
                "street": {
39
                    "type": "string" ,
40
                    "maxLength": 50
41
                },
42
                "streetNumber": {
43
                    "type": "string"
44
                }
45
            },
46
            "required": ["street"],
47
            "additionalProperties": false
48
        },
49
        "addressLine2": {
50
            "type": "string",
51
            "maxLength": 50
52
         },
53
        "addressLine3": {
54
            "type": "string",
55
            "maxLength": 50
56
         },
57
        "postalCode": {
58
            "type": "string",
59
            "maxLength": 16
60
         },
61
        "state": {
62
            "type": "string",
63
            "minLength": 2,
64
            "maxLength": 2,
65
            "description": "Alpha-2 code of state or province according to ISO 3166-2:2013 where applicable"
66
        }
67
    },
68
    "required": ["country", "addressLine1", "postalCode"],
69
    "additionalProperties": false
70
}

Sample

1
{
2
    "city": "New York",
3
    "country": {
4
        "countryA3": "USA"
5
    },
6
    "addressLine1": {
7
        "street": "Park Avenue",
8
        "streetNumber": "270"
9
    },
10
    "postalCode": "10017-2070",
11
    "state": "NY"
12
}