Skip to main content
Sitecore Documentation
  • Learn
  • Downloads
  • Changelog
  • Roadmap
CDPCloud Portal
Sitecore CDP Developer Documentation
  • Developing with Sitecore CDP
        • Authentication
        • Base URL
        • Retrieve the browser ID
            • IDENTITY event
            • SEARCH event
            • ADD event
            • ADD event for flights
            • ADD event for ancillary product
            • ADD_CONSUMERS event
            • ADD_CONTACTS event
            • CONFIRM event
            • CONFIRM event for flights
            • CHECKOUT event
            • ORDER_CHECKOUT event
            • CLEAR_CART event
            • PAYMENT event
            • Custom event
        • Sending orders
        • Cart abandonment
        • Send additional event data
        • Troubleshooting
  1. Sending events
  1. Sitecore CDP Developer Documentation
  2. Stream API

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 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:

AttributeTypeDescriptionExample
channelstring (uppercase)The touchpoint where the user interacts with your brand.
  • "MOBILE_APP"
  • "MOBILE_WEB"
  • "WEB"
typestring (uppercase)The type of the event that takes place when the user interacts with your brand."PAYMENT"
languagestring (uppercase ISO 639-1)The language the user is using your app in.
  • "DE"
  • "EN"
  • "FR"
currencystring (uppercase ISO 4217)The alphabetic currency code of the currency the user is using in your app.
  • "EUR"
  • "GBP"
  • "USD"
pagestringThe name of the webpage where the interaction with your brand takes place.

This is a custom value of your choice.
  • "home"
  • "search"
  • "confirm"
posstringThe name of the point of sale where the interaction with your brand takes place.
  • "myretailsite/ireland"
  • "spinair.com/france"
browser_idstringThe browser ID."a38b230c-11eb-4cf9-8d5d-274e9f344925​"
pay_typestringThe method of payment associated with a checkout.
  • "Card"
  • "PayPal"
  • "Voucher"
  • "Other"
  • "Cancelled"

Example 52. 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!

© Copyright , Sitecore A/S or a Sitecore affiliated company.
All rights reserved.

Privacy policySitecore Trust CenterTerms of use
CDPCloud Portal