Create order on the client side of application

You can sell both an item with one SKU in any quantity, or a cart of items with different SKUs pre-filled by a user. To create an order with data about a user and items on the Xsolla side, use one of the following API calls:

• Create order with specified item
• Create order with all items from current cart
• Create order with all items from particular cart

The API call used will return a payment token, which is required to open the payment UI and make a payment. To use sandbox mode, pass the “sandbox”: true parameter in the body of the request for getting a token.

Open payment UI

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

<iframe
  src="https://sandbox-secure.xsolla.com/paystation4/?token=TOKEN"
  width="800"
  height="700"
  allow="clipboard-read; clipboard-write; payment"
></iframe>

Make test payment

To test the payment process, you can use sandbox mode. Sandbox mode is a standalone environment that supports all features of a live environment, except real and declined payments. You can access sandbox mode by sending “sandbox”: true when you create an order.

1. Open the payment UI in sandbox mode.
2. Choose the Bank card payment method.
3. Enter the bank card details. In other fields (e.g., name or address), you can enter any data. You can also specify incorrect details (card number or expiration date) to test if an error is generated.
4. Click Pay.

Test cards list

See the list of test bank cards.

To see detailed information, including fees, about transactions made in sandbox mode:

1. Open your Publisher Account.
2. Go to Accounting > Transaction registry.
3. Check the Show test transactions box.

Additionally, you can see the transactions’ details and request refunds in Publisher Account in the Support > Transaction search section.

Create order and open payment UI

You can sell both an item with one SKU in any quantity, or a cart of items with different SKUs pre-filled by a user.

To create an order with data about a user and an item with one SKU on the Xsolla side, call the XsollaCatalog.Purchase SDK method, passing the following parameters to it:

• itemSku — the SKU of the item that the user wants to purchase.
• onSuccess — the successful purchase callback, triggered when the order transitions to the done status.
• onError — the request error callback.
• onBrowseClosed — the browser closing callback (optional). The event is tracked only when opening the user payment interface in the built-in browser. External browser events are not tracked.
• purchaseParams — purchase parameters and user payment UI settings, such as locale and currency (optional).
• customHeaders — custom web request headers (optional).

The XsollaCatalog.Purchase method initiates the purchase process for the specified item, including creating the order, opening the user payment UI, and tracking the order status. In the onSuccess parameter pass a function, that is called when the order transitions to the done status.

To create an order with data about a user and a cart of items on the Xsolla side, you first need to implement the logic of filling and editing the cart, as well as getting its content. Refer to the instructions for detailed information about purchase via a shopping cart.

Make test payment

To test the payment process, you can use sandbox mode. Sandbox mode is a standalone environment that supports all features of a live environment, except real and declined payments. To have access to the sandbox mode, you should have the Test Payments Mode box checked in the Unity Editor in the Inspector panel (checked by default).

1. Run your application or scene in the Unity Editor.
2. Choose the Bank card payment method.
3. Enter the bank card details. In other fields (e.g., name or address), you can enter any data. You can also specify incorrect details (card number or expiration date) to test if an error is generated.
4. Click Pay.

Test cards list

See the list of test bank cards.

To see detailed information, including fees, about transactions made in sandbox mode:

1. Open your Publisher Account.
2. Go to Accounting > Transaction registry.
3. Check the Show test transactions box.

Additionally, you can see the transactions’ details and request refunds in Publisher Account in the Support > Transaction search section.

Create order and open payment UI

You can sell both an item with one SKU in any quantity, or a cart of items with different SKUs pre-filled by a user.

1. To create an order with data about a user and an item with one SKU on the Xsolla side, call the createOrderByItemSku method from the Store library, passing the following parameters to it:

1. • callback — the successful order creation callback. It receives the payment token that is necessary to open the payment UI and make payment.

1. • itemSku — the SKU of the item that the user wants to purchase.

1. • options — payment parameters (optional).

1. • quantity — the number of items the user wants to purchase (optional). If the quantity is not specified, the default value will be set to 1.

2. Implement the logic of payment UI opening:

val intent = XPayments.createIntentBuilder(activity)
    .accessToken(AccessToken(<payment token>))
    .isSandbox(<isSandbox>)
    .build()
startActivityForResult(intent, RC_PAYSTATION)

3. Implement payment result handling:

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == RC_PAYSTATION) {
        val (status, _) = XPayments.Result.fromResultIntent(data)
        when (status) {
            XPayments.Status.COMPLETED -> Log.d("MainActivity", "Payment completed")
            XPayments.Status.CANCELLED -> Log.d("MainActivity", "Payment cancelled")
            XPayments.Status.UNKNOWN -> Log.d("MainActivity", "Status unknown")
        }
    }
}

To create an order with data about a user and a cart of items on the Xsolla side, you first need to implement the logic of filling and editing the cart, as well as getting its content. Refer to the instructions for detailed information about purchase via a shopping cart.

Make test payment

To test the payment process, you can use sandbox mode. Sandbox mode is a standalone environment that supports all features of a live environment, except real and declined payments. To have access to the sandbox mode, you should call the isSandbox method and pass true as an argument, when creating an IntentBuilder object.

1. Run your application.
2. Choose the Bank card payment method.
3. Enter the bank card details. In other fields (e.g., name or address), you can enter any data. You can also specify incorrect details (card number or expiration date) to test if an error is generated.
4. Click Pay.

Test cards list

See the list of test bank cards.

To see detailed information, including fees, about transactions made in sandbox mode:

1. Open your Publisher Account.
2. Go to Accounting > Transaction registry.
3. Check the Show test transactions box.

Additionally, you can see the transactions’ details and request refunds in Publisher Account in the Support > Transaction search section.

Create order and open payment UI

You can sell both an item with one SKU in any quantity, or a cart of items with different SKUs pre-filled by a user.

1. To create an order with data about a user and an item with one SKU the Xsolla side, call the FetchPaymentToken SDK method, passing the following parameters to it:

1. • AuthToken — the user authentication token, obtained during authentication using Xsolla Login.

1. • ItemSKU — the SKU of the item that the user wants to purchase.

1. • SuccessCallback - the callback triggered when successfully receiving the payment token.

1. • ErrorCallback — the request error callback.

1. • PurchaseParams — purchase and user payment interface parameters, such as locale and currency (optional).

2. Implement the opening of the payment interface. To do this, call the LaunchPaymentConsole SDK method, passing the following parameters to it:

1. • WorldContextObject — the world context object (for C++ call).

1. • OrderId — the order ID.

1. • AccessToken — the payment token.

1. • SuccessCallback — the callback triggered when successfully receiving the payment token.

1. • ErrorCallback — the request error callback.

1. • BrowserClosedCallback — the browser closing callback. The event is tracked only when opening the user payment interface in the built-in browser. External browser events are not tracked.

1. • PayStationVersion — the Pay Station version. By default, version 4 is used.

To create an order with data about a user and a cart of items on the Xsolla side, you first need to implement the logic of filling and editing the cart, as well as getting its content. Refer to the instructions for detailed information about purchase via a shopping cart.

Make test payment

To test the payment process, you can use sandbox mode. Sandbox mode is a standalone environment that supports all features of a live environment, except real and declined payments. To have access to the sandbox mode, you should have the Enable Sandbox box checked in Unreal Editor in Settings > Project Settings > Plugins > Xsolla Settings > Purchases section (checked by default).

1. Run your application or map in the Unreal Editor.
2. Choose the Bank card payment method.
3. Enter the bank card details. In other fields (e.g., name or address), you can enter any data. You can also specify incorrect details (card number or expiration date) to test if an error is generated.
4. Click Pay.

Test cards list

See the list of test bank cards.

To see detailed information, including fees, about transactions made in sandbox mode:

1. Open your Publisher Account.
2. Go to Accounting > Transaction registry.
3. Check the Show test transactions box.

Additionally, you can see the transactions’ details and request refunds in Publisher Account in the Support > Transaction search section.