How to get payment 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.

To get a payment token:

1. Get a user authorization token.
2. Create an order.

Get user authorization token

The lifetime of the token is 24 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.

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.

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

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"
}

Get payment token

In the response, you will receive data you need for further work:

• token — payment token