You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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.

Data Elements

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


KeyFormatCNDDescriptionBeschreibung
1customerNumberans..30OCustomer numberKundennummer
2

consumer

object

C

Object describing private customers. Required if the customer is a person.

Objekt zur Beschreibung von Privatkunden. Erforderlich, wenn der Kunde eine Person ist.
3

business

object

C

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

Objekt zur Beschreibung von Geschäftskunden. Erforderlich, wenn der Kunde eine juristische Person ist.
4

phone

object

C

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

Telefonnummer. Erforderlich (falls verfügbar), sofern nicht Markt- oder regionale Mandate die Übermittlung dieser Information beschränken.
5

mobilePhone

object

C

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

Mobiltelefonnummer. Erforderlich (falls verfügbar), sofern nicht Markt- oder regionale Mandate die Übermittlung dieser Information beschränken.
6

email

string

C

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

E-Mail-Adresse. Erforderlich, sofern nicht Markt- oder regionale Mandate die Übermittlung dieser Information beschränken.

consumer

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


KeyFormatCNDDescriptionBeschreibung
1

salutation

string

O

Salutation

Values accepted:

  • Mr

  • Mrs

  • Miss

Anrede

Zulässige Werte:

  • Mr

  • Mrs

  • Miss

2

firstName

string

M

Customers' first name

Vorname des Kunden
3

lastName

string

M

Customer's last name

Nachname des Kunden
4

birthDate

string

O

Customer's birthdate in format YYYY-MM-DD

Geburtsdatum des Kunden im Format JJJJ-MM-TT

business

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...


KeyFormatCNDDescriptionBeschreibung
1

legalName

string

M

Business legal name

Firmenname
2

dbaName

string

O

Doing Business As

Geschäfte tätigend als
3

registrationNumber

string

O

Business registration number

Unternehmens-Registrierungsnummer

Schema

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

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://www.computop-paygate.com/schemas/customerInfo.json",
	"title": "customerInfo",
	"description": "Customer Information",
	"type": "object",
	"properties": {
		"customerNumber": {
			"type": "string",
			"maxLength": 30
		},
		"consumer": {
			"type": "object",
			"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": "YYYY-MM-DD"
				}
			},
			"required": [
				"firstName",
				"lastName"
			],
			"additionalProperties": false
		},
		"business": {
			"type": "object",
			"properties": {
				"legalName": {
					"type": "string",
					"maxLength": 60
				},
				"dbaName": {
					"type": "string",
					"maxLength": 50,
					"description": "Doing business as. Name of the company as usually known to consumers."
				},
				"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"
}

  • No labels