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": "Germany"
        },
        "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

NameTypeDescriptionSampleFormatNotes
objectstringObject type of instancepayment.customers

idstringID of payment customerPCU_27JWDNGV82NEECVN6Q3A4E72WGXBAW(3 letters)_(30 alphanumeric signs)
contractModel\ProductInstanceUIDPayment contract


contract.objectstringObject type of instancepayment.contracts

contract.idstringID of instancePCR_WDYM...KAH(3 letters)_(30 alphanumeric signs)
merchantModel\ProductInstanceUIDGeneral merchant


merchant.objectstringObject type of instancegeneral.merchants

merchant.idstringID of merchantMRC_WVHJ...QP8(3 letters)_(30 alphanumeric signs)
contactModel\ContactCustomer contact info

Same structure as in the input model
contact.forenamestringForename of the contact personJohn

contact.surnamestringSurname of the contact personDoe

contact.companynamestringCompany nameExample Inc.

contact.salutationstring

Form of address

Mr"Mr", "Ms", ...
contact.genderstring

Gender

m"m", "f", "d", ...
contact.titlestringAristocratic or Academic titlesDr.

contact.emailstring

Email

mail@example.comE.123
contact.phonestring

Phone

+49 4321 567890E.123
contact.mobilestring

Mobile

+49 123 987654321E.123
contact.faxstring

Fax

+49 4321 567891E.123
contact.dobstring

Date of birth

1950-12-25ISO 8601 (YYYY-MM-DD)
contact.picturestringThe document id of an user picture
(To upload the picture use our document service.)



contact.url_websitestring

URL to website

www.example.comRFC 1738
contact.birthplacestringBirthplaceBerlin

contact.nationalitystring

Nationality

DEISO 3166-1 (alpha-2)
contact.addressModel\AddressAddress


contact.address.typestringAddress-Typeinvoice

contact.address.streetstringStreetExample Street

contact.address.street_numberstringStreet number6a

contact.address.citystringCityExamplecity

contact.address.postal_codestringPostal code01234

contact.address.countrystring

Country

DEISO 3166-1 (alpha-2)
createdstringCreated at date2019-11-15T09:55:10+01:00

ISO 8601

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


updatedstring

Updated at date

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

ISO 8601

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

only after an update visible