Sending events

PAYMENT event

The PAYMENT event is an optional event you can send to capture a guest's payment method. You do not need to send a payment event to create an order.

Sitecore Personalize does not capture payment details, so there are no concerns with sending Personally Identifiable Information (PII) data.

To send a PAYMENT event, use the following attributes:

Attribute	Type	Description	Example
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"PAYMENT"`
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"home"` `"search"` `"confirm"`
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`
`pay_type`	string	The method of payment associated with a checkout.	`"Card"` `"PayPal"` `"Voucher"` `"Other"` `"Cancelled"`

Example 55. PAYMENT event object

{
    "channel": "WEB",
    "type": "PAYMENT",
    "language": "EN",
    "currency": "EUR",
    "page": "home",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
    "pay_type": "Card"
}

If you have suggestions for improving this article, let us know!