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

"customerInfo"-JSON is sent as "billToCustomer" or "shipToCustomer". An overview of parameters can be found here:

Data Elements

Key

Format

CND

Description

customerNumber

ans..30

Customer number

consumer

object

Object describing private customers. Required if the customer is a person. Will become mandatory for VISA on 2024-02-12.

business

object

Object describing business customers. Required if the customer is a legal entity.

phone

object

Phone number. Required (if available), unless market or regional mandate restricts sending this information.

Either phone or mobilePhone (one value is sufficient) will become mandatory for VISA on 2024-02-12.

mobilePhone

object

Mobile phone number. Required (if available) unless market or regional mandate restricts sending this information.

Either phone or mobilePhone (one value is sufficient) will become mandatory for VISA on 2024-02-12.

string

Email address. Required unless market or regional mandate restricts sending this information.

Will become mandatory for VISA on 2024-02-12.

consumer

Key

Format

CND

Description

salutation

string

Salutation

Values accepted:

Mr
Mrs
Miss

firstName

string

Customers' first name

lastName

string

Customer's last name

birthDate

string

Customer's birthdate in format YYYY-MM-DD

business

Key

Format

CND

Description

legalName

string

Business legal name

dbaName

string

Doing Business As

registrationNumber

string

Business registration number

Schema

BASEURL= https://www.computop-paygate.com/schemas

1
{
2
    "$schema": "http://json-schema.org/draft-07/schema#",
3
    "$id": "https://www.computop-paygate.com/schemas/customerInfo.json",
4
    "title": "customerInfo",
5
    "description": "Customer Information",
6
    "type": "object",
7
    "properties": {
8
        "customerNumber": {
9
            "type": "string",
10
            "maxLength": 30
11
        },
12
        "consumer": {
13
            "type": "object",
14
            "additionalProperties": false,
15
            "properties": {
16
                "salutation": {
17
                    "type": "string",
18
                    "enum": [
19
                        "Mr",
20
                        "Mrs",
21
                        "Miss"
22
                    ]
23
                },
24
                "firstName": {
25
                    "type": "string",
26
                    "maxLength": 50
27
                },
28
                "lastName": {
29
                    "type": "string",
30
                    "maxLength": 50
31
                },
32
                "birthDate": {
33
                    "description": "YYYY-MM-DD",
34
                    "type": "string",
35
                    "format": "full-date"
36
                }
37
            },
38
            "required": [
39
                "firstName",
40
                "lastName"
41
            ]
42
        },
43
        "business": {
44
            "type": "object",
45
            "additionalProperties": false,
46
            "properties": {
47
                "legalName": {
48
                    "type": "string",
49
                    "maxLength": 999
50
                },
51
                "dbaName": {
52
                    "description": "Doing business as. Name of the company as usually known to consumers.",
53
                    "type": "string",
54
                    "maxLength": 50
55
                },
56
                "registrationNumber": {
57
                    "type": "string",
58
                    "maxLength": 20
59
                }
60
            },
61
            "required": [
62
                "legalName"
63
            ]
64
        },
65
        "phone": {
66
            "type": "object",
67
            "additionalProperties": false,
68
            "properties": {
69
                "countryCode": {
70
                    "type": "string",
71
                    "minLength": 1,
72
                    "maxLength": 3
73
                },
74
                "subscriberNumber": {
75
                    "type": "string",
76
                    "maxLength": 15
77
                }
78
            },
79
            "required": [
80
                "countryCode",
81
                "subscriberNumber"
82
            ]
83
        },
84
        "mobilePhone": {
85
            "type": "object",
86
            "additionalProperties": false,
87
            "properties": {
88
                "countryCode": {
89
                    "type": "string",
90
                    "minLength": 1,
91
                    "maxLength": 3
92
                },
93
                "subscriberNumber": {
94
                    "type": "string",
95
                    "maxLength": 15
96
                }
97
            },
98
            "required": [
99
                "countryCode",
100
                "subscriberNumber"
101
            ]
102
        },
103
        "email": {
104
            "type": "string",
105
            "maxLength": 256,
106
            "format": "idn-email"
107
        }
108
    },
109
    "oneOf": [
110
        {
111
            "required": [
112
                "consumer"
113
            ]
114
        },
115
        {
116
            "required": [
117
                "business"
118
            ]
119
        }
120
    ],
121
    "additionalProperties": false
122
}

Sample

1
{
2
    "consumer": {
3
        "salutation": "Mr",
4
        "firstName": "Napoleon",
5
        "lastName": "Bonaparte",
6
        "birthDate": "1769-08-15"
7
    },
8
    "mobilePhone": {
9
        "countryCode": "33",
10
        "subscriberNumber" : "12345678910"
11
    },
12
    "email": "napoleon.bonaparte@france.com"
13
}