Integration Guide

A complete Payment Customer would look so:

Payment Customer

{
    "object": "payment.customers",
    "id": "PCU_2NF5ETKNJ2X0H6SHQX4S7FP8WGR2AZ",
    "merchant": {
        "object": "general.merchants",
        "id": "MRC_WVHJQFQ4JNVYNG5B55TYK748ZCHQP8"
    },
    "contact": {
        "companyname": "Musterfirma GmbH",
        "salutation": "Mr.",
        "forename": "Max",
        "surname": "Mustermann",
        "name": "Max Mustermann",
        "address": {
            "street": "Max-Muster-Str.",
            "street_number": "25a",
            "additional_address_data": "Whg. 202",
            "postal_code": "09555",
            "city": "Musterstadt",
            "country": "DE"
        },
        "email": "mmustermann@example.net",
        "mobile": "+49 177 5555555",
        "phone": "+49 555 5555555",
        "dob": "1965-12-31T00:00:00+01:00"
    },
    "created": "2021-01-27T10:49:23+01:00"
}

These are the fields:

Field	Meaning
`object`	Always `payment.customers`.
`id`	Smart Transaction ID.
`merchant`	The merchant the Payment Customer was created for.
`merchant/object`	Always `general.merchants`. Managed by our system.
`merchant/id`	General Merchant ID.
`contact`	Contact details of the customer.
`contact/companyname`	Optional company name.
`contact/salutation`	Optional salutation.
`contact/forename`	First name.
`contact/surname`	Last name.
`contact/name`	Full name. Managed by our system.
`contact/address/street`	Optional street without house number.
`contact/address/street_number`	Optional house number.
`contact/address/additional_address_data`	Optional address addition like an appartment number, a c/o note, etc.
`contact/address/postal_code`	Optional ZIP code.
`contact/address/city`	Optional city.
`contact/address/country`	Optional two-letter country code (e. g. `DE`).
`contact/email`	Email address.
`contact/phone`	Optional phone number.
`contact/mobile`	Optional mobile phone number.
`contact/dob`	Optional date of birth. Helpful for authorization.
`created`	Managed by our system.

If you create or read the customer object inline in the Smart Transaction, it is simply nested in one object field customer (with the exception of merchant and the created date):

Example Smart Transaction

{
  "object": "smart.transactions",
  // ...
  "merchant": {
    "object": "general.merchants",
    "id": "MRC_35SZ3R5GGQQP4T0U2T5GFAN9P6C4PG"
  },
  "customer": {
    "object": "payment.customers",
    "id": "PCU_2NF5ETKNJ2X0H6SHQX4S7FP8WGR2AZ",
    "contact": {
      "companyname": "Musterfirma GmbH",
      "salutation": "Mr.",
      "forename": "Max",
      "surname": "Mustermann",
      "name": "Max Mustermann",
      "address": {
        "street": "Max-Muster-Str.",
        "street_number": "25a",
        "additional_address_data": "Whg. 202",
        "postal_code": "09555",
        "city": "Musterstadt",
        "country": "DE"
      },
      "email": "max25@example.net",
      "mobile": "+49 177 5555555",
      "phone": "+49 555 5555555",
      "dob": "1965-12-31T00:00:00+01:00"
    }
  }
  // ...
}

The same applies for the shipping_address, except it cannot be created inline.