Event analytics

You can use this feature if you have already integrated Pay Station and set up at least one account: Google Analytics or Facebook Ads/Facebook Analytics.

Integration with analytics platforms

Connecting Google Analytics and Facebook Pixel in your Publisher Account allows you to track events happening in Pay Station when users interact with it.

You can track the following events:

Google Analytics

Category	Action	Description	Label
paystation	open-{state_name}	Opening a page in the payment UI.	-
paystation	click-email-submit	Sending an email from any page. The name of the page is passed in label.	state
paystation	click-btn-share	Clicking the button to share via a social network. The social network name is passed in label.	name
paystation	click-btn-pay	Clicking the Pay Now button on the billing data entry form.	payment_method_name
paystation	click-btn-return-url	Clicking the Return to Store/Start again button.	status
paystation	choose-payment-widget	Clicking on the payment method widget. The widget name is passed in label.	name
paystation	choose-method	Selecting the payment method. The payment method name is passed in label.	name
paystation	change-status-done	Changing the payment status. If the user closes the payment UI or leaves the page, and then the status changes, the event message is sent.	state

Custom dimensions for Google Analytics

Dimension	Name	Description
1	version	Pay Station version.
2	purchase_invoice_id	Payment invoice ID in the Xsolla system.
3	external_id	Payment invoice ID in the partner’s system.
4	purchase_sku	SKU of the purchased item.
5	total_sum	Total purchase amount. All fees are included.
6	total_sum_currency	Total purchase amount currency.
7	pid	ID of the payment system.
8	projectId	Project ID.
9	country	Payment country.
10	projectName	Name of the project.
12	purchase_sku_digitalContent	SKU of the purchased game keys package.

Facebook Analytics

Event	Description
open-{state_name}	Opening a page in the payment UI. The state name is passed in parameters.
click-email-submit	Sending an email from the status page. The state name is passed in parameters.
click-btn-share	Clicking the button to share via a social network. The social network name is passed in parameters.
click-btn-pay	Clicking the Pay Now button on the billing data entry form. The payment method name is passed in parameters.
click-btn-return-url	Clicking the Return to Store/Start again button. The status name is passed in parameters.
choose-payment-widget	Clicking on the payment method widget. The widget name is passed in parameters.
choose-method	Selecting the payment method. The payment method name is passed in parameters.
change-status-{status_name}	Changing the payment status. If the user closes the payment UI or leaves the page, and then the status changes, the event message is not sent.

To integrate the analytics platform:

Go to your Publisher Account > Pay Station > Settings.
Select Google Analytics/Facebook Pixel from the Apps section.
Insert your tracking ID and click Connect.

When you integrate Google Analytics and Facebook Pixel, the correspondent events will be sent to your Google Analytics and Facebook Analytics accounts.

You can find these events in:

Google Analytics: Behaviour > Events > Top Events
Facebook Analytics: Business Settings > Measure & Report > Analytics > Pixels > Overview

Payment UI events

Payment interface events are processed via the postMessage mechanism when opening Pay Station in an iframe or with Pay Station Embed.

Event	Description
show-error-page	Displaying an error. The error text is passed in value.
open-{state_name}	Opening a page in the payment UI.
create-invoice	Creating an invoice on Xsolla's side.
close-widget	Closing the payment UI.
click-email-submit	Sending an email from the status page.
click-custom-package-continue	Clicking the Continue button when buying an arbitrary amount of virtual currency.
click-comment	Clicking the button to post a comment.
click-buy-package	Clicking the Buy Package button when buying a package of virtual currency.
click-buy-gift-package	Clicking the button when buying a package of virtual currency as a gift.
click-buy-gift-custom-package	Clicking the button when buying an arbitrary amount of virtual currency as a gift.
click-btn-share	Clicking the button to share via a social network. The social network name is passed in value.
click-btn-pay	Clicking the Pay Now button on the billing data entry form.
click-btn-continue	Clicking the button to buy the subscription.
click-btn-apply	Clicking the Apply button when redeeming a coupon.
click-btn-activate	Clicking the Activate button when activating a game key.
click-btn-accept	Clicking the button to buy digital content.
choose-payment-widget	Clicking on the payment method widget. The widget name is passed in value.
choose-method	Selecting the payment method. The payment method name is passed in value.
change-status	Changing the payment status. If the user closes the payment UI or leaves the page, and then the status changes, the event message is not sent.
external-link-open	Redirection to an external resource. The address to which the redirection occurred is passed in the url parameter.
dimensions	When Pay Station opens in the iframe, the width and height of the iframe are passed in the width and height parameters.
status-redeem	The coupon redemption in a payment form.
focus-change	Changing the focus on elements of the Pay Station widget. The focus state is passed in the hasFocus parameter and can be true or false.
status	Going to the payment status page. The following parameters can be passed: status — payment status email — user's email invoice — transaction ID virtualCurrencyAmount — the amount of purchased virtual currency userId — user ID discount — the discount applied to the payment
paymentreturn	Going to the next step after making a payment on the payment system page. If the user is returned to Pay Station, the name of the step is passed in the nextState parameter. If the user is redirected to an external resource, the page address is passed in the redirectUrl parameter.

The event parameters are passed in each message from postMessage. If the parameter information has not been collected yet, an empty string displays.

Parameter	Type	Description
action	string	Event name.
value	string	Additional parameter. Contains specific event parameters that vary depending on the user's choice.
state	string	The payment UI page, on which the action was performed.
date	string	Date and time in the GMT format.
milliseconds	number	Date and time in the Unix time format.
timezone	string	User time zone.
session_id	string	Session ID. The session includes all user actions performed within 30 minutes or until the payment UI is closed. The session starts from the moment when the payment UI is opened and is saved after the page with the payment UI is refreshed.
payment_country	string	Payment country.
purchase_invoice_id	number	Payment invoice ID in the Xsolla system.
purchase_external_id	string	Payment invoice ID in the partner’s system.
purchase_type	string	Purchase type. Can be: virtual item, virtual currency, pay2play, subscription.
purchase_sum	number	Nominal purchase amount.
purchase_currency	string	Purchase currency.
purchase_sku	string	SKU of the purchased item.
purchase_digital_content_sku	string	SKU of the purchased game keys package.
purchase_description	string	Purchase description.
virtual_currency_amount	number	Virtual currency amount.
coupon_code	string	Coupon code.
subscription_package_external_id	number	Subscription ID.
subscription_package_name	string	Subscription name.
subscription_package_description	string	Subscription description.
total_sum	number	Total purchase amount. All fees are included.
total_sum_currency	string	Total purchase amount currency.
user_id	string	User ID (v1).
user_country	string	User country.
payment_instance_name	string	Payment method name.

Events are linked to the pages where the user performs all actions when purchasing an item.

State	Description
cart	Page with the selected item purchased in virtual currency and a purchase confirmation.
coupon	Coupon entry form.
giftcard	Page with the gift cards list (Gift Cards widget).
giftrecipient	Gift purchase page.
history	Purchase history page.
index	Service page, to which the user is redirected after opening the application. It is not shown to the user.
legal	Mobile version of the page with links to legal documents.
list	List of payment methods.
paybycash	Page with the list of payment methods for purchasing via cash kiosks (Pay with Cash widget).
payment	Payment form.
paymentaccount	Page with the saved payment accounts.
paymentreturn	Service page, to which the user is redirected after the payment is made, and from which the user is sent to the status page. It is not shown to the user.
pincart	Page with the list of digital content platforms.
pricepoint	Virtual currency store.
savedmethod	List of saved payment methods.
shippingaddress	Delivery address form.
status	Status page.
subscription	Subscription plans store.
subscriptionchange	Subscription plan change.
useraccount	Account information page (username, balance) with the Disable confirmation screen for future item purchases setting.
userinventory	User inventory.
usermenu	Mobile version of the user menu page.
usersubscription	User subscriptions management.
usersubscriptioninfo	Subscription details page.
virtualitem	Virtual items store.

To send events to your Google Analytics and Facebook Analytics accounts, you need to integrate these analytics platforms.

Thank you for your feedback!

We'll review your message and use it to help us improve your experience.

Your browser is not supported. Please try a different browser

Event analytics

Integration with analytics platforms

Payment UI events