PaymentCustomersDTO

Mandatory properties

Mandatory properties

The following parameters must be transmitted every time a transaction is created or updated

  • forename

  • surname

  • companyname (only in case of a company)

  • email

  • address

    • street

    • street_number

    • postal_code

    • city

    • country

Sample

Example Customer
{
"contact": {
"salutation": "Mr",
"title": "Dr.",
"forename": "John",
"surname": "Doe",
"companyname": "Example Inc.",
"dob": "1901-02-03",
"email": "example@example.com",
"phone": "0049-123-456789",
"mobile": "0049-987-654321",
"address": {
"street": "Example Street",
"street_number": "6a",
"postal_code": "01234",
"city": "Examplecity",
"country": "DE"
}
}
}

Properties

Name

Type

Description

Sample

Format

Notes

contact

Model\Contact





contact.forename

string

Forename of the contact person

John


mandatory

contact.surname

string

Surname of the contact person

Doe


mandatory

contact.companyname

string

Company name

Example Inc.


mandatory (only in case of a company)

contact.salutation

string

Form of address

Mr

"Mr", "Ms", ...

recommended

contact.gender

string

Gender

m

"m", "f", "d", ...


contact.title

string

Aristocratic or Academic titles

Dr.



contact.email

string

Email

mail@example.com

E.123

mandatory

contact.phone

string

Phone

+49 4321 567890

E.123

recommended

contact.mobile

string

Mobile

+49 123 987654321

E.123


contact.fax

string

Fax

+49 4321 567891

E.123


contact.dob

string

Date of birth

1950-12-25

ISO 8601 (YYYY-MM-DD)

recommended

contact.picture

string

The document id of an user picture
(To upload the picture use our document service.)



not recommended

contact.url_website

string

URL to website

www.example.com

RFC 1738


contact.birthplace

string

Birthplace

Berlin



contact.nationality

string

Nationality

DE

ISO 3166-1 (alpha-2)


contact.address

Model\Address

Address




contact.address.type

string

Address-Type

invoice


recommended

contact.address.street

string

Street

Example Street


mandatory

contact.address.street_number

string

Street number

6a


mandatory

contact.address.city

string

City

Examplecity


mandatory

contact.address.postal_code

string

Postal code

01234


mandatory

contact.address.country

string

Country

DE

ISO 3166-1 (alpha-2)

mandatory