Open payment UI

Note

Before you sign a contract with Xsolla, testing your payment process is only available in sandbox mode. In case of any errors, see their descriptions.

To open the payment UI in sandbox mode, use the following URL: https://sandbox-secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the token obtained in the previous step.

New window

To open the payment UI in a new window, use the following URL: https://sandbox-secure.xsolla.com/paystation3/?access_token=TOKEN, where TOKEN is the obtained token.

Note
Use the link above to open the payment UI in sandbox mode. After the project launch, use this URL https://secure.xsolla.com/paystation3/?access_token=TOKEN.

You can also open the payment UI using other options:

  • With Pay Station Embed. Limitation: there might be problems when opening it in the in-game browser (WebView).
  • In iframe. Limitation: there might be problems when opening it in the in-game browser (WebView) and in the mobile version of your application.

Pay Station Embed

Notice
This way of opening payment UI doesn’t support selling game keys. To sell game keys, follow the instruction.

EXAMPLE: ASYNCHRONOUS SCRIPT LOADING

Copy
Full screen
Small screen

<script>
   var options = {
       access_token: 'ACCESS_TOKEN', //TODO use access token, received on previous step
       sandbox: true //TODO please do not forget to remove this setting when going live
   };
   var s = document.createElement('script');
   s.type = "text/javascript";
   s.async = true;
   s.src = "https://static.xsolla.com/embed/paystation/1.0.7/widget.min.js";
   s.addEventListener('load', function (e) {
       XPayStationWidget.init(options);
   }, false);
   var head = document.getElementsByTagName('head')[0];
   head.appendChild(s);
</script>

<button data-xpaystation-widget-open>Buy Credits</button>

Pay Station Embed allows getting events from the payment UI via postMessage. You can send these events to analytics systems. To set up events processing in your analytics system, contact your Account Manager or send email to am@xsolla.com.

The Xsolla team created a widget that simplifies the integration of the payment UI into your website. The widget script is available in our GitHub repository.

Script initialization parameters:

ParameterTypeDescription
access_token
stringToken, received via API. Required.
sandbox
booleanSet to true to test the payment process: sandbox-secure.xsolla.com will be used instead of secure.xsolla.com.
lightbox
objectLightbox parameters (object; desktop version only).
lightbox.width
stringLightbox frame width. If null, depends on Pay Station width. Default is null.
lightbox.height
stringLightbox frame height. If null, depends on Pay Station height. Default is 100%.
lightbox.zIndex
integerDefines arrangement order. Default is 1000.
lightbox.overlayOpacity
integerOverlay opacity (0 to 1). Default is .6.
lightbox.overlayBackground
stringOverlay background color. Default is #000000.
lightbox.modal
booleanIf true, the lightbox frame cannot be closed. Default is false.
lightbox.closeByClick
booleanIf true, clicking the overlay will close the lightbox. Default is true.
lightbox.closeByKeyboard
booleanIf true, pressing ESC will close the lightbox. Default is true.
lightbox.contentBackground
stringFrame background color. Default is #ffffff. Note that these color changes do not affect the Pay Station iframe itself, only the settings of the lightbox that hold it.
lightbox.contentMargin
stringFrame margin. Default is 10px.
lightbox.spinner
stringType of animated loading indicator. Can be xsolla or round. Default is xsolla.
lightbox.spinnerColor
stringSpinner color. No default value.
childWindow
objectOptions for the child window containing the Pay Station UI. Supported in the mobile version.
childWindow.target
stringWhere to open the Pay Station window. Can be _blank, _self, _parent. Default is _blank.

The script allows you to track payment UI events. Depending on the event type, you can perform various actions on the web page.

List of events:

ParameterDescription
initWidget initialized.
openWidget opened.
loadPayment UI (Pay Station) loaded.
closePayment UI (Pay Station) closed.
statusUser is on the status page.
status-invoiceUser is on the status page; payment in progress.
status-deliveringEvent when the user was moved on the status page, payment was completed, and we’re sending payment notification.
status-doneUser is on the status page; payment credited to the user’s account.
status-troubledEvent when the user was moved on the status page, but the payment failed.

If you want to initialize the opening of the payment UI, use the following link: https://secure.xsolla.com/paystation3/?access_token=TOKEN.

Note
It is necessary to use the link with the https:// prefix only for the payment UI opening.

Use the following URL for testing purposes: https://sandbox-secure.xsolla.com/paystation3/?access_token=TOKEN.

Notice
access_token parameter contains private user data. Make sure that you use server-to-server communication when getting this parameter.

Iframe

To open the payment UI in an iframe:

  1. Implement the postMessage mechanism to receive events from the payment UI.
  2. Get a token when creating an order using API calls from the Payment group. In the request, pass:
    • the device type (desktop or mobile) in the settings.ui.version parameter
    • the payment UI size in the settings.ui.size parameter:

Pay Station sizeIframe width
large (default)670–850 px
medium590–740 px
small510–630 px

  1. Open the payment UI by following the link https://sandbox-secure.xsolla.com/paystation3/?access_token=TOKEN, where TOKEN is the received token.

Your progress
Thank you for your feedback!

Continue reading

Last updated: December 22, 2022

Found a typo or other text error? Select the text and press Ctrl+Enter.

Report a problem
We always review our content. Your feedback helps us improve it.
Provide an email so we can follow up
Thank you for your feedback!