Get Payment Customer

To get a Payment Customer the model PaymentCustomersDTO needs to be passed to the method paymentCustomersGetById of the class PaymentCustomersApi.

As (successful) response will return the model PaymentCustomersProductModel back.

API

Endpoint

GET https://connect.secucard.com/api/v2/Payment/Customers/PCU_XXXX

Header


Accept:application/json
Content-Type:application/json
Accept-Charset:utf-8
Authorization:Bearer {{access_token}}


Response

Sample

{
"object": "payment.customers",
"id": "PCU_27JWDNGV82NEECVN6Q3A4E72WGXBAW",
"contract": {
"object": "payment.contracts",
"id": "PCR_WDYM...KAH"
},
"merchant": {
"object": "general.merchants",
"id": "MRC_WVHJ...QP8"
},
"contact": {
"forename": "John",
"surname": "Doe",
"companyname": "Example Inc.",
"name": "John Doe",
"salutation": "Mr.",
"title": "Dr.",
"address": {
"street": "Example Street",
"street_number": "6a",
"postal_code": "01234",
"city": "Examplecity",
"country": "DE"
},
"email": "example@example.com",
"mobile": "0049-987-654321",
"phone": "0049-123-456789",
"dob": "1901-02-03T00:00:00+01:00"
},
"created": "2019-11-15T09:55:10+01:00"
}

Properties

Name

Type

Description

Sample

Format

Notes

object

string

Object type of instance

payment.customers



id

string

ID of payment customer

PCU_27JWDNGV82NEECVN6Q3A4E72WGXBAW

(3 letters)_(30 alphanumeric signs)


contract

Model\ProductInstanceUID

Payment contract




contract.object

string

Object type of instance

payment.contracts



contract.id

string

ID of instance

PCR_WDYM...KAH

(3 letters)_(30 alphanumeric signs)


merchant

Model\ProductInstanceUID

General merchant




merchant.object

string

Object type of instance

general.merchants



merchant.id

string

ID of merchant

MRC_WVHJ...QP8

(3 letters)_(30 alphanumeric signs)


contact

Model\Contact

Customer contact info



Same structure as in the input model

contact.forename

string

Forename of the contact person

John



contact.surname

string

Surname of the contact person

Doe



contact.companyname

string

Company name

Example Inc.



contact.salutation

string

Form of address

Mr

"Mr", "Ms", ...


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


contact.phone

string

Phone

+49 4321 567890

E.123


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)


contact.picture

string

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




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



contact.address.street

string

Street

Example Street



contact.address.street_number

string

Street number

6a



contact.address.city

string

City

Examplecity



contact.address.postal_code

string

Postal code

01234



contact.address.country

string

Country

DE

ISO 3166-1 (alpha-2)


created

string

Created at date

2019-11-15T09:55:10+01:00

ISO 8601

(YYYY-MM-DDThh:mm:ss+UTC)


updated

string

Updated at date

2019-11-21T12:01:05+01:00

ISO 8601

(YYYY-MM-DDThh:mm:ss+UTC)

only after an update visible