{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["sub-heading"]},"type":"markdown"},"seo":{"title":"Analytics","description":"Transform your commerce with PXP's unified platform—seamless payments, real-time insights, and global growth in one powerful integration.","lang":"en-UK","siteUrl":"https://developer.pxp.io"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"analytics","__idx":0},"children":["Analytics"]},{"$$mdtype":"Tag","name":"SubHeading","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get actionable, trackable data instantly to drive better decisions and performance."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Analytics events are structured data objects that the SDK raises when significant actions or states occur in Payout Drop-in. Use them to monitor the withdrawal journey in your own analytics or CRM tools."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Analytics events allow you to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Observe Drop-in lifecycle and interaction events in your own tooling."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optimise conversion rates and reduce drop-offs with actionable insights."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Feed real-time data into your analytics and CRM systems."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["analyticsEvent"]}," is optional. Treat it as observational alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onSuccess"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["onError"]},", and your backend webhook handling for payout outcomes. Don't block the withdrawal UI waiting for analytics network calls."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"consume-an-event","__idx":2},"children":["Consume an event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pass an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["analyticsEvent"]}," callback to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayoutDropIn.initialize"]},". The SDK calls it with each event object. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["event.eventName"]}," to route payloads."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"typescript","header":{"controls":{"copy":{}}},"source":"import {\n  PayoutDropIn,\n  type PayoutDropInSubmitResult,\n} from '@pxpio/web-components-sdk';\nimport type { BaseSdkException } from '@pxpio/web-components-sdk';\n\nconst payoutDropIn = PayoutDropIn.initialize({\n  environment: 'test',\n  session: sessionData,\n  ownerId: 'MERCHANT-1',\n  transactionData: {\n    currency: 'USD',\n    amount: 25,\n    entryType: 'Ecom',\n    merchantTransactionId: 'withdrawal-123',\n    merchantTransactionDate: () => new Date().toISOString(),\n  },\n  onGetShopper: () => Promise.resolve({ id: 'shopper-001' }),\n  analyticsEvent: (event) => {\n    console.log('Analytics event:', event.eventName, event);\n\n    if (typeof gtag !== 'undefined') {\n      gtag('event', event.eventName, {\n        session_id: event.sessionId,\n        timestamp:\n          event.timestamp instanceof Date\n            ? event.timestamp.toISOString()\n            : event.timestamp,\n      });\n    }\n  },\n  onSuccess: async (result: PayoutDropInSubmitResult) => {\n    await verifyPayoutOnBackend(result);\n  },\n  onError: (error: BaseSdkException) => {\n    console.error('Payout failed:', error);\n  },\n});\n\nawait payoutDropIn.create('payout-drop-in-container');\n","lang":"typescript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every event includes at least:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]},": The event identifier (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeviceType"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]},": The payout session identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]},": The date and time when the event was created."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"supported-events","__idx":3},"children":["Supported events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The tables below list events the Web SDK can raise during a Payout Drop-in session. Exact events depend on which methods and user interface steps the shopper uses."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"initialisation","__idx":4},"children":["Initialisation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Raised once when you call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayoutDropIn.initialize"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event name"},"children":["Event name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Structure"},"children":["Structure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BrowserData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserVersion"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatingSystem"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"drop-in-and-panel-lifecycle","__idx":5},"children":["Drop-in and panel lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Raised when Drop-in panels and nested components mount or unmount, and when component-level errors occur (including some SDK and Unity service failures surfaced through the shared analytics callback)."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event name"},"children":["Event name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Structure"},"children":["Structure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentLifecycleEvent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentError"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorMessage"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventType"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentLifecycleEvent"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Mount"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unmount"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentError"]}," can be omitted for some failures."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"card-on-file-methods","__idx":6},"children":["Card-on-file methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Card, Apple Pay, and Google Pay withdrawals use the stored-instrument list and withdraw submit components (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["useCardOnFile: true"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"list-and-edit-events","__idx":7},"children":["List and edit events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Raised from the stored-instrument list while the shopper selects, edits, deletes, or abandons a card."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event name"},"children":["Event name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Structure"},"children":["Structure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ChangePreselectedCardClick"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardDeletion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardStatus"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardBrand"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elementId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EditCardClick"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elementId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["editedFields"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentAbandonment"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For stored-card abandonment, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardOnFile"]},". The list has no CVC field, so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CVVFillTime"]}," isn't raised."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"submit-events","__idx":8},"children":["Submit events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Raised when the shopper confirms a card-on-file withdrawal."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event name"},"children":["Event name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Structure"},"children":["Structure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomerClick"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elementId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentInteraction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interactionType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayButtonClick"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardBrand"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreAuthorisation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isRetry"]}]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostAuthorisation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isRetry"]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On this path, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}," is typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardOnFile"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interactionType"]}," for the submit interaction is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submit"]},". Soft-decline retries can set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isRetry"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreAuthorisation"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostAuthorisation"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Payout intent skips tokenisation and 3D Secure authentication analytics (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreTokenization"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostTokenization"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SecurityCheck"]},", and the authentication lifecycle events)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"closed-loop-allocation","__idx":9},"children":["Closed-loop allocation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When closed-loop enforcement is active, the closed-loop drop-in also raises ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentLifecycleEvent"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentError"]},". Preferred-method and excess-selection screens reuse the card-on-file list events above when a stored-instrument list is shown."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"paypal","__idx":10},"children":["PayPal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The PayPal panel raises ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentLifecycleEvent"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentError"]}," for its UI. On submit it also raises:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Event name"},"children":["Event name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Structure"},"children":["Structure"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomerClick"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`eventName`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`timestamp`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`elementId`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`pageUrl`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`sessionId`"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComponentInteraction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`eventName`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`timestamp`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`interactionType`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`componentId`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`pageUrl`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`sessionId`"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["`componentType`"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For that submit interaction, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Paypal"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interactionType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submit"]},". Card-on-file submit events such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PayButtonClick"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PreAuthorisation"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostAuthorisation"]}," apply only to card, Apple Pay, and Google Pay."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"event-data","__idx":11},"children":["Event data"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following table describes common fields returned on analytics events."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The browser type (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Chrome"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["browserVersion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The browser version."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardBrand"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card brand (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Visa"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Mastercard"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardStatus"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The state of the card (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cardType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The card type reported for the selected instrument."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The component's unique identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["componentType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The component type (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CardOnFile"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Paypal"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deviceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The device category detected at initialisation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["editedFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The fields edited on a stored card (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExpiryDate"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["elementId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The element's unique identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The SDK error code, when present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorMessage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The error description."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the event."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eventType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The lifecycle action (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Mount"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unmount"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interactionType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The interaction type (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submit"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Click"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isRetry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the lifecycle step is a soft-decline retry."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatingSystem"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The operating system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The page URL where the event occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session's unique identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date and time when the event occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The transaction identifier associated with the lifecycle step."]}]}]}]}]}]},"headings":[{"value":"Analytics","id":"analytics","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Consume an event","id":"consume-an-event","depth":2},{"value":"Supported events","id":"supported-events","depth":2},{"value":"Initialisation","id":"initialisation","depth":3},{"value":"Drop-in and panel lifecycle","id":"drop-in-and-panel-lifecycle","depth":3},{"value":"Card-on-file methods","id":"card-on-file-methods","depth":3},{"value":"List and edit events","id":"list-and-edit-events","depth":4},{"value":"Submit events","id":"submit-events","depth":4},{"value":"Closed-loop allocation","id":"closed-loop-allocation","depth":3},{"value":"PayPal","id":"paypal","depth":3},{"value":"Event data","id":"event-data","depth":2}],"frontmatter":{"seo":{"title":"Analytics"}},"lastModified":"2026-11-12T15:20:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/payout/drop-in/web/analytics","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}