Enterprise-level SDK for Unity / General information
  Back to Docs

Enterprise-level SDK for Unity

General information

The SDK supports the item purchase from the catalog in one click or via the shopping cart.

To test the purchase process, you can use sandbox mode of payment UI and test cards. The sandbox mode only simulates the behavior of a payment method; no real money is involved. To try sandbox, you don’t need to sign any agreements with Xsolla or pay any fees.

Notice
After the first real payment is made, a strict sandbox payment policy takes effect. Payments made in sandbox mode are available only to users who are specified in Publisher Account in the Company settings > Users section.

The payment UI is based on the Pay Station product. The choice of available payment methods and other settings are available in Publisher Account in the Pay Station section.

The method to open the payment UI depends on the platform for which your application is built:

  • For desktop applications, the SDK allows you to open the payment UI in the built-in or external browser, depending on the project settings.
  • In mobile applications, the payment UI opens in an external browser.
  • For WebGL, the payment UI widget opens in an iframe on the same browser page.

If you open the payment UI in a WebView in your mobile application, add a button so the user can close the payment UI at any stage of the purchase. To do this, use the close_button parameter on instances of the PurchaseParams class when calling the XsollaCatalog.Purchase or XsollaCart.Purchase SDK method.

You can select the icon that will be displayed on the button. To do this, pass one of the following values ​​in the close_button_icon parameter in instances of the PurchaseParams class:

  • “arrow” — to display the icon (used by default)
  • “cross” — to display the × icon

Example of using the close_button and close_button_icon parameters in WebView:

How-tos

Learn about advanced setups from our how-tos.

How to set up user redirection to your application after payment

To redirect users to another page after they completed the payment, you can configure two types of redirects:

  • automatic — a redirect with a set delay.
  • manual — a redirect after a user clicks the redirect button.

You can configure a redirect in the following ways:

  • in Publisher Account — use this option if you are setting up a project for a single application and don’t plan to create builds for different platforms.

  • in the SDK settings — use this option if you plan to:
    • use the project for multiple applications
    • create builds for different platforms
    • sell in-game items via the website
Notice
If redirects are configured in Publisher Account and SDK settings, the parameters specified in the SDK settings are used.

Configure redirects in Publisher Account

  1. Open your project in Publisher Account.
  2. Click Pay Station in the side menu.
  3. Go to the Settings > Redirect policy section.
  1. In the Return URL field, enter the URL or path where a user is redirected to after making a payment.
Note

To redirect users to a mobile application, the URL must match one of the following schemes:

You can find the <ANDROID_PACKAGE_NAME>/<BUNDLE_ID> value in the Unity project settings (Edit > Project Settings > Player > Android (iOS) > Other Settings > Bundle Identifier).

  1. To set automatic redirect parameters:
    1. In the drop-down list, choose Automatic redirect condition:
      • None — do not redirect.
      • Successful payment — redirect when a payment is successful.
      • Successful or canceled payment — redirect when a payment is successful or canceled.
      • Any payment — redirect for any payment status.
    2. In the Delay field, enter a redirect timeout in seconds. By default, a redirect is activated in 0 seconds.

  1. To set manual redirect parameters:
    1. In the drop-down list, choose Manual redirect condition:
      • None — do not redirect.
      • Successful payment — the redirect button appears when a payment is successful.
      • Successful or canceled payment — the redirect button appears when a payment is successful or canceled.
      • Any payment — the redirect button appears for any payment status.
    2. In the Redirect button caption field, enter the copy for the button that redirects a user to the return URL.
Notice

The redirect button copy is Back to the Game by default. It is localized in all Pay Station languages.

If your project supports several languages, you can specify redirect button copy for each of them in the respective fields.

When a user closes the payment UI, they are also redirected to the specified return URL.

  1. Click Save.

Configure redirects in SDK settings

  1. Open your Unity project.
  2. Click Window > Xsolla > Edit Settings in the main menu.
  3. Open the Inspector panel and go to the Pay Station > Redirect Policy section.
  4. Go to the section corresponding to your application’s build platform (Desktop, WebGL, Android, or iOS) and specify the redirect parameters:

    1. Uncheck the Use setting from Publisher Account box.
    2. In the Return URL field, enter the URL or path where a user is redirected to after making a payment.
Note

To redirect users to a mobile application, the URL must match one of the following schemes:

You can find the <ANDROID_PACKAGE_NAME>/<BUNDLE_ID> value in the Unity project settings (Edit > Project Settings > Player > Android (iOS) > Other Settings > Bundle Identifier).

    1. To set automatic redirect parameters:
      1. In the drop-down list, choose Redirect Conditions:
        • None — do not redirect.
        • Successful payment — redirect when a payment is successful.
        • Successful or canceled payment — redirect when a payment is successful or canceled.
        • Any payment — redirect for any payment status.
      2. In the Redirect Timeout field, enter a redirect timeout in seconds.

    1. To set manual redirect parameters:
      1. In the drop-down list, choose Status for Manual Redirection:
        • None — do not redirect.
        • Successful payment — the redirect button appears when a payment is successful.
        • Successful or canceled payment — the redirect button appears when a payment is successful or canceled.
        • Any payment — the redirect button appears for any payment status.
      2. In the Redirect Button Caption field, enter the copy for the button that will redirect a user to the return URL.
Notice

The redirect button copy is Back to the Game by default. It is localized in all Pay Station languages.

If your project supports several languages, you can specify redirect button copy for each of them in the respective fields.

When a user closes the payment UI, they are also redirected to the specified return URL.

Was this article helpful?
Thank you!
Is there anything we can improve? Message
We’re sorry to hear that
Please explain why this article wasn’t helpful to you. Message
Thank you for your feedback!
We’ll review your message and use it to help us improve your experience.
Hide

Continue reading

Last updated: July 23, 2024

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!