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

You need to obtain a token to integrate the payment UI. An access token is a string that identifies game, user, and purchase parameters.

Xsolla API uses basic access authentication. Specify your merchant ID as the username and the API key as the password.

To find this data:

1. In your Publisher Account, go to Company settings.
2. In the Company tab, copy Merchant ID.
3. In the API key tab, copy the API key.

URL to retrieve the token:

https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token

You can alter the HTTP POST request by including the parameters you want to pass on to the payment UI. Pass the information about the user in the parameters user.id, user.name, and user.email of the Create token method.

Note

For the user.id parameter, use an identifier that users can remember and later use outside the game by themselves (e.g., when replenishing the game balance using push payments).

API reference

See the full list of parameters.

Both the request and the response are in JSON format.

Below you can find sample code of how to get a token in PHP with the help of Xsolla PHP SDK. If you are using another programming language, take a look at the CURL example by clicking on the CURL tab.

<?php

use Xsolla\SDK\API\XsollaClient;
use Xsolla\SDK\API\PaymentUI\TokenRequest;

$tokenRequest = new TokenRequest($projectId, $userId);
$tokenRequest->setUserEmail('email@example.com')
    ->setExternalPaymentId('12345')
    ->setSandboxMode(true)
    ->setUserName('USER_NAME')
    ->setPurchase(9.99, 'USD');

$xsollaClient = XsollaClient::factory(array(
    'merchant_id' => MERCHANT_ID,
    'api_key' => API_KEY
));
$token = $xsollaClient->createPaymentUITokenFromRequest($tokenRequest);

curl -v https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token \
-X POST \
-u your_merchant_id:merchant_api_key \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-d '
{
    "user": {
        "id": {
            "value": "1234567"
        },
        "email": {
            "value": "email@example.com"
        }
    },
    "settings": {
        "project_id": 14004,
        "mode": "sandbox"
    },
    "purchase": {
            "checkout": {
                "amount": 9.99,
                "currency": "USD"
            }
    }
}'

Open payment UI

There are three ways of opening the payment UI:

• Pay Station Embed script
• Iframe
• New window

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.

To easily implement the payment UI on your website, download the script from our CDN. Use this URL to integrate the script on your website. For more information visit 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 by yourself, use this link: https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN.

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

Iframe

You need to implement the following mechanisms on your side:

• Check the device type (desktop vs. mobile) and send it within the token’s settings.ui.version parameter
• Get 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.

To open the payment UI in an iframe, use the following link: https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the token obtained in the previous step. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN.

New window

To open the payment UI in a new window, use the following link: https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, where ACCESS_TOKEN is the token obtained in the previous step. For testing purposes, use this URL: https://sandbox-secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN.

Set up webhooks

You need to implement the following webhooks for Pay Station:

• User validation
• Payment
• Refund

What are webhooks

Learn what webhooks are, how they work, and when to use them.

Acknowledge the receipt of a webhook by responding with HTTP code 204 without a message body.

To test the webhook handler, open Project settings > Webhooks section.

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

1. 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 Sandbox > Accounts.
   4. In the Sandbox Account section, click Create account.
   5. In the modal window, select the Personal account type and a country.
   6. Click Create. The created account will be shown in the list of sandbox accounts.

2. Open the payment UI in sandbox mode.
3. Choose the PayPal payment method.
4. In the payment window, enter required information.
5. Click Pay Now. You will be redirected to a window to log in to your PayPal account.

6. To complete the testing payment process, enter information about your sandbox account created in step 1: 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 Sandbox > Accounts.
   3. In the Sandbox Account section, choose the sandbox account.
   4. Click ••• and select View/edit account from the drop-down list.
7. Click Pay Now.

You can also use information from existing sandbox accounts:

Go live

To start processing real payments:

1. Make sure that you have signed a contract with Xsolla.
2. Open Pay Station by secure.xsolla.com link. Or change sandbox-secure.xsolla.com to secure.xsolla.com in Pay Station Embed script.
3. Remove "mode":"sandbox" when getting the token.