customerInfo

JSON object

CustomerInfo

Data elements

KeyFormatConditionDescription
consumerobjectCObject describing private customers. Required if the customer is a person.
businessobjectCObject describing business customers. Required if the customer is a legal entity.
phoneobjectCPhone number. Required (if available), unless market or regional mandate restricts sending this information.
mobilePhoneobjectCMobile phone number. Required (if available) unless market or regional mandate restricts sending this information.
emailstringCEmail address. Required unless market or regional mandate restricts sending this information.
Data elements

consumer

KeyFormatConditionDescription
salutationstringOSalutation Values accepted: · Mr · Mrs · Miss
firstNamestringMCustomers’ first name.
lastNamestringMCustomer’s last name.
birthDatestringOCustomer’s birthdate in format YYYY-MM-DD.
Data elements consumer

business

KeyFormatConditionDescription
legalNamestringMBusiness legal name.
dbaNamestringODoing Business As.
registrationNumberstringOBusiness registration number.
Data elements business

Schema

{

    "$schema": "http://json-schema.org/draft-07/schema#",

    "$id": "https://www.computop-paygate.com/schemas/customerInfo.json",

    "title": "customerInfo",

    “description”: “Kundeninformationen”,

    “type”: “object”,

    “properties”: {

        “consumer”: {

            “properties”: {

                “salutation”: {

                    “type”: “string”,

                    “enum”: [“Mr”, “Mrs”, “Miss”]

                },

                “firstName”: {

                    “type”: “string”,

                    “maxLength”: 30

                },

                “lastName”: {

                    “type”: “string”,

                    “maxLength”: 30

                },

                “birthDate”: {

                    “type”: “string”,

                    “format”: “full-date”,

                    “description”: “JJJJ-MM-TT”

                }

            },

            “required”: [“firstName”, “lastName”],

            “additionalProperties”: false

        },

        “business”: {

            “properties”: {

                “legalName”: {

                    “type”: “string”,

                    “maxLength”: 50

                },

                “dbaName”: {

                    “type”: “string”,

                    “maxLength”: 50,

                    “description”: “Geschäfte tätigens als. Unternehmensname, wie er üblicherweise den Kunden bekannt ist.”

                },

                “registrationNumber”: {

                    “type”: “string”,

                    “maxLength”: 20

                }

            },

            “required”: [“legalName”],

            “additionalProperties”: false

        },

        “phone”: {

            “type”: “object”,

            “properties”: {

                “countryCode”: {

                    “type”: “string”,

                    “minLength”: 1,

                    “maxLength”: 3

                },

                “subscriberNumber”: {

                    “type”: “string”,

                    “maxLength”: 15

                }

            },

            “required”: [“countryCode”, “subscriberNumber”],

            “additionalProperties”: false

        },

        “mobilePhone”: {

            “type”: “object”,

            “properties”: {

                “countryCode”: {

                    “type”: “string”,

                    “minLength”: 1,

                    “maxLength”: 3

                },

                “subscriberNumber”: {

                    “type”: “string”,

                    “maxLength”: 15

                }

            },

            “required”: [“countryCode”, “subscriberNumber”],

            “additionalProperties”: false 

        },

        “email”: {

            “type”: “string”,

            “maxLength”: 254,

            “format”: “idn-email”

        }

    },

    “oneOf”: [

        {“required”: [“consumer”]},

        {“required”: [“business”]}

    ],

    “additionalProperties”: false

}

Sample

{

    "consumer": {

        "salutation": "Mr",

        "firstName": "Napoleon",

        “lastName”: “Bonaparte”,

        “birthDate”: “1769-08-15”

    },

    “mobilePhone”: {

        “countryCode”: “33”,

        “subscriberNumber” : “12345678910”

    },

    “email”: “napoleon.bonaparte@france.com”

}