Analytics

The Android SDK emits structured analytics events throughout the Aeropay flow. Use these events to measure conversion, identify drop-off points, and connect client activity with your monitoring and analytics systems.

Aeropay analytics can help you:

• Measure progression from the payment button to transaction submission.
• Track Aerosync bank-linking attempts and outcomes.
• Monitor consumer data, OTP, bank selection, and transaction errors.
• Correlate client activity with sessions and merchant transactions.
• Find points where shoppers abandon or repeatedly retry the flow.

Set analyticsEvent when building PxpSdkConfig:

val sdkConfig = PxpSdkConfig(
    environment = Environment.TEST,
    session = sessionResult.session,
    transactionData = transactionData,
    clientId = "your-client-id",
    ownerType = "MerchantGroup",
    ownerId = "MERCHANT_GROUP_1",
    onGetShopper = { getCurrentShopper() },
    analyticsEvent = { event ->
        sendAnalyticsEvent(
            eventName = event.eventName,
            timestamp = event.timestamp,
            payload = event,
        )
    },
)

The SDK calls this handler when an event is created. Keep the handler non-blocking and catch errors in your analytics client so tracking doesn't interrupt checkout.

Aeropay emits payment-method-specific events and shared component events.

All events include eventName, sessionId, and timestamp (milliseconds since epoch). Authorisation events also expose isRetry (defaults to false).

The following events describe the embedded Aerosync bank-linking flow:

Widget-level Aerosync failures emit AerosyncFailed and onError with SDK1304. They don't always emit ComponentError. Listen for AerosyncFailed or onError in addition to ComponentError for complete Aeropay error coverage.

PreAuthorisation and PostAuthorisation describe the transaction gate and successful submission:

The transactionId is the merchantTransactionId supplied during SDK initialisation. PreAuthorisation is emitted only when onPreAuthorisation is configured (including when the callback later returns false). PostAuthorisation is emitted only when onPostAuthorisation is configured and submission succeeds with a MerchantSubmitResult.

ComponentInteraction records shopper activity such as button taps and popup close actions:

Aeropay uses these component types to identify parts of the flow:

ComponentLifecycleEvent records popup screen mount and unmount activity:

ComponentError records SDK and provider failures:

Use errorCode, sessionId, and componentId when investigating errors. Don't display errorMessage directly to shoppers without mapping it to an approved user-facing message.

Mapped failed Unity transaction responses call onSubmitError and also emit ComponentError with SDK1326. Network or transport failures still call onSubmitError, but can emit a different ComponentError code. Widget-level Aerosync failures that emit AerosyncFailed and SDK1304 on onError don't always emit ComponentError.

ErrorMessageShown records messages rendered inside the Aeropay flow. The event can represent field validation, user creation, OTP, bank account, account-linking, or transaction feedback shown in the popup. It isn't emitted merely because an error occurred.

The SDK emits MessageShownAnalyticsEvent with these fields:

Use eventName, componentType, and interactionType to derive a basic Aeropay funnel:

analyticsEvent = { event ->
    when (event.eventName) {
        "ComponentInteraction" -> {
            val interaction = event as ComponentInteractionAnalyticsEvent
            if (
                interaction.componentType == "aeropay-button" &&
                interaction.interactionType == "Click"
            ) {
                // Track aeropay_button_clicked
            }
        }
        "AerosyncLaunched" -> {
            // Track aeropay_bank_linking_started
        }
        "AerosyncCompleted" -> {
            // Track aeropay_bank_linking_completed
        }
        "PostAuthorisation" -> {
            // Track aeropay_transaction_submitted using transactionId
        }
    }
}

Filter the Aeropay button click carefully. Popup screens also emit ComponentInteraction events with the screen componentType values in the component-type table (e.g., aeropayDataCollection, aeropayOtpVerification, aeropayAerosync) and interaction types such as Focus, Blur, Change, Submit, and Close.

PostAuthorisation is emitted only when onPostAuthorisation is set on AeropayButtonComponentConfig and submission succeeds with a MerchantSubmitResult. Configure that callback if you rely on this funnel stage.

Analytics events don't include a dedicated user-verification-success event. If you need that funnel stage, record a custom event from onUserVerificationSuccess.

When forwarding Aeropay analytics:

• Prefer sessionId, merchantTransactionId, eventName, componentType, and errorCode.
• Don't forward OTPs, full shopper records, bank account numbers, or provider payloads.
• Treat errorMessage and messageContent as potentially sensitive.
• Keep analytics out of the payment-confirmation path.