Send a PAYMENT event to Sitecore CDP

Abstract

Provides the required attributes and a JSON example of how to send a PAYMENT event to Sitecore CDP (Data model 2.1).

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 CDP 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	Description	Type	Example(s)	Required/optional
`channel`	The channel captured on each page the guest visited.	string (uppercase)	`"WEB", "MOBILE_WEB", "MOBILE_APP"`	Required
`type`	The type of event.	string (uppercase)	`"PAYMENT"`	Required
`language`	The language captured on each page the guest visited.	string (2 letter ISO 639 language code)	`"EN", "FR", "DE"`	Required
`currency`	The type of currency.	string (3 letter ISO 4217)	`"EUR", "USD", "GBP"`	Required
`page`	The name of the webpage the guest visited.	string	`"home page", "search page" "/home", "/confirm"`	Required
`pos`	The point of sale (storefront) captured on each page the guest visited.	string (predefined by client)	`"myretailsite.com"`	Required
`browser_id`	The ID of a browser generated by Sitecore CDP.	string (UUID)	`"56860bff-94ba-4d84-aa37-2b5a83d5411b"`	Required
`pay_type`	The method of payment associated with a checkout.	string (suggest title case)	`"Card", "PayPal", "Voucher", "Other"`	Required

The following JSON example demonstrates how to send a PAYMENT event:

{
    "channel": "WEB",
    "type": "PAYMENT",
    "language": "EN",
    "currency": "EUR",
    "page": "home page",
    "pos": "myretailsite.com",
    "browser_id": "56860bff-94ba-4d84-aa37-2b5a83d5411b",
    "pay_type": "Card"
}