Integrate payment solution

To track referrals and make payouts for collaborators, you first need to integrate Xsolla Pay Station. Requirements:

1. Pay Station is integrated on a performance-optimized landing page.
2. Pay Station is the only payment method used on the game’s landing page that drives traffic through the Partner Network program.

Get token

To open the payment UI, you need to get a token. A token is a string that includes encrypted data about a game and a user. You need to implement the getting of a token to identify the user to allow the purchase.

In the back-end of your application, implement getting a user authentication token. To do so, use an HTTP POST request that includes basic HTTP authentication and pass the required parameters in the request body.

API reference

See the full list of parameters.

The lifetime of the token is 14 hours after the last call to the Xsolla API. Implement the logic of receiving a new token after its expiration. It is recommended that you get a new token in the background, so the user doesn’t have to log in to the application again.

Basic HTTP authentication

Xsolla API uses basic access authentication. All requests to API must contain the Authorization: Basic <your_authorization_basic_key> header, where <your_authorization_basic_key> is the merchant ID:API key pair, encoded according to the Base64 standard. Go to Publisher Account to find these parameters:

• Merchant ID is shown:
  • In the Project settings > Webhooks section.
  • In the Company settings > Company section.
  • In the URL in the browser address bar on any Publisher Account page. The URL has the following format: https://publisher.xsolla.com/​merchant ID/Publisher Account section.

• API key is shown in Publisher Account only once when it is created and must be stored on your side. You can create a new key in the following section:
  • Company settings > API keys
  • Project settings > API keys

Request body

In the request body, pass the following required parameters:

To improve user experience, you can also pass the following parameters:

Example of the request for obtaining a user authentication token

curl -i -X POST \
  -u 2340:ZHgbSDVP6LtAJVWu \
  https://api.xsolla.com/merchant/v2/merchants/<merchant_id>/token \
  -H 'Content-Type: application/json' \
  -d '{
    "settings": {
      "currency": "USD",
      "language": "en",
      "project_id": <project_id>
      }
    },
    "user": {
      "email": {
        "value": "<user_email>"
      },
      "id": {
        "value": "<user_id>"
      },
      "name": {
        "value": "<user_name>"
      }
    }
  }'

Example of a user authentication token received in response

{
    "token": "1230OWrp0KF6uqvmN8jWuzLyoXMzxTyK_lc_en"
}

Open payment UI

New window

To open the payment UI in a new window, use the following URL: https://sandbox-secure.xsolla.com/paystation4/?token=TOKEN, where TOKEN is the obtained 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

EXAMPLE: ASYNCHRONOUS SCRIPT LOADING

<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:

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:

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

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

Iframe

To open the payment UI in an iframe:

1. Implement the postMessage mechanism to receive events from the payment UI.
2. Open the payment UI by following the link https://sandbox-secure.xsolla.com/paystation4/?token=TOKEN, where TOKEN is the received token.

Set up webhooks

If you want to receive notifications about events (e.g. change of the payment status), set up webhooks in Publisher Account:

1. Open your project in Publisher Account.
2. Click Project settings in the side menu and go to Webhooks.
3. Set the Webhooks toggle to On.
4. Specify the webhook URL.
5. A secret key to sign project webhooks is generated by default. If you want to generate a new secret key, click the refresh icon.
6. Click Save settings.

It is recommended to implement the following webhooks:

• User validation
• Payment
• Getting cart’s content when making purchase
• Refund
• Partial refund

To confirm that the webhook is received, your server must respond with:

• HTTP code 204 without a message body.
• HTTP code 400 describing the problem if the specified user was not found or if an invalid signature was passed.

Test payment process

To test the payment process, you can use the sandbox mode. Sandbox mode is a stand-alone environment that supports all features of a live environment, except real and declined payments. You can access sandbox mode by sending "mode":"sandbox" when you get the token.

In sandbox mode, you can test the payment process with:

• a bank card
• PayPal

Test bank card payment

1. Open the payment UI in sandbox mode.
2. Choose the Credit/Debit cards group of payment methods.
3. Enter the bank card details. Enter any values in the remaining fields. You can also specify incorrect details (card number or expiration date) to generate an error.
4. Click Pay now.

Test cards list

See the list of test bank cards.

Test PayPal payment

Create test PayPal account

To test the payment process, you need to create an account for PayPal sandbox mode:

1. Open the PayPal Developer website.
2. Log in to your account or create a new one.
3. Go to the Sandbox accounts tab.
4. On the Sandbox test accounts page, click Create account.
5. Select the Personal (Buyer Account) account type and choose the country.
6. Click Create.

The created account is shown in the list of sandbox accounts.

You can also use information from existing sandbox accounts:

Make test payment

1. Open the payment UI in sandbox mode.
2. Choose the PayPal payment method.
3. In the Mock Response Code field, enter 0 or leave the field empty.
4. In the ZIP Code field, enter any 5 digits.

5. Click Pay. You will be redirected to a window to log in to your PayPal account.
6. Enter information about your sandbox account: Email ID as the email address and System Generated Password as the password. To find this information:
   1. Log in to your account on the PayPal Developer website.
   2. Go to the Sandbox accounts tab.
   3. On the Sandbox test accounts page, choose a sandbox account.
   4. Click ••• and select View/Edit account from the drop-down list. You will see the data in the modal window that opens.
7. Complete the test payment.

Go live

After completing the previous steps, you can start receiving real payments:

1. Make sure you signed the licensing agreement with Xsolla.
2. Remove "sandbox": true parameter from the request body when obtaining a token.
3. Open the payment UI using the following link: https://secure.xsolla.com/paystation4/?token=TOKEN.