Contact

Occurrence

Content

circle-info

Payments trigger the creation of an internal Contact identified by the email address. Repeating payments update this Contact. When the webhook is triggered, it prioritises values sent with the specific payment; if those are missing, it falls back to the values stored on the Contact.

Key
Type
Description

id

int

Internal shopper ID

uuid

string

  • External shopper ID

  • 8 - 40 characters long

title

string

  • The person's title

  • Possible values:

    • translated values of miss and mister

    • arbitrary values due to e.g. custom gateway creation

firstname

string

The shopper's first name

lastname

string

The shopper's last name

company

string

The shopper's company name

street

string

The shopper's street

zip

string

The shopper's postcode

place

string

The place in which the shopper is living

country

string

The translated name of the country in which the shopper is living

countryISO

string

The ISO 3166-1 Alpha 2arrow-up-right string of the country in which the shopper is living

phone

string

  • The shopper's phone number

  • The numbers come in different formats depending on the shopper's input. Several examples, not limited to these formats:

    • +41335500010

    • +41 33 550 00 10

    • 0335500010

    • 033 550 00 10

email

string

The shopper's email address

date_of_birth

string

  • The shopper's date of birth

  • The numbers come in different formats depending on the shopper's input. Several examples, not limited to these formats:

    • 01.01.1970

    • 1970-01-01

delivery_title

string

  • The recipient's title

  • Possible values:

    • translated values of miss and mister

    • arbitrary values due to e.g. custom gateway creation

delivery_firstname

string

The recipient's first name

delivery_lastname

string

The recipient's last name

delivery_company

string

The recipient's company name

delivery_street

string

The recipient's street

delivery_zip

string

The recipient's postcode

delivery_place

string

The place in which the recipient is living

delivery_country

string

The translated name of the country in which the recipient is living

delivery_countryISO

string

The ISO 3166-1 Alpha 2arrow-up-right string of the country in which the recipient is living

Example

Last updated