Sandbox mode

Sandbox mode is a stand-alone environment that supports all the features of a live environment, except real payments. You can use sandbox mode to test:

• payment widget
• payee account
• forms to pass identification procedure (KYC) and a tax interview
• integration with API

Payment widget

To open a payment widget in sandbox mode:

1. Get the token. In the request, pass the Authorization:Basic <your_authorization_basic_key> parameter, where <your_authorization_basic_key> is the platform ID: secret key pair, encoded according to the Base64 standard. To find this test data:
   1. Open your project in Publisher Account and go to the Payouts > Settings section.
   2. In the upper-right corner, choose Sandbox from the drop-down list.
   3. Go to the Settings > Security section.

Example of a request for getting a token:

curl -X POST 'https://payouts-sandbox-api.xsolla.com/api/v1/merchants/customer/auth' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic <your_authorization_basic_key>' \
-d '{"email": "<your email>", "name": "<your name>"}'

2. Open sandbox mode following the link https://payouts-sandbox-widget.xsolla.com/?token={token}, where {token} is the token received on step 1.

<script>
    var s = document.createElement('script');
    s.type = "text/javascript";
    s.async = true;
    s.src = "https://static.xsolla.com/payouts/v0/_bundles/santorelli.min.js";
    s.addEventListener('load', function () {
        const widget = new XPayoutsWidget.Widget({
                    token: '<auth token>',
                    theme: 'black',
                    size: 'fixed',
                    sandbox: true
                });

        widget.show('<container_id>');

        widget.addEventListener('load', () => {
            console.log('loaded');
        });
    }, false);
    var head = document.getElementsByTagName('head')[0];
    head.appendChild(s);
</script>

import {Widget} from '@xsolla/payouts-sdk';

const widget = new Widget({
	token: '<auth token>',
	theme: 'black',
	size: 'fixed',
	sandbox: true  
});

widget.show('<container_id>');

widget.addEventListener('load', () => {
	console.log('loaded');
});

3. In the widget that opens, check the box for reading and agreeing with the licensing agreement.
4. In the Verification tab, fill in the fields with test data:
   • name
   • surname
   • middle name (not required)
   • country
   • nationality
5. If you want to test an unsuccessful scenario, check the box for generating an error when passing an identification procedure (KYC).
6. Click Send.

7. In the Tax Interview tab, select a scenario you want to test: a success or an error.
8. Make a payment using test data.

Payee account

To open a payee account in sandbox mode:

1. Open your project in Publisher Account and go to the Payouts > Settings section.
2. In the upper-right corner, choose Sandbox from the drop-down list.

3. Go to the Users tab and invite yourselves.
4. In the email you received to your email address, follow the link to the payee account.
5. In the payee account, choose a merchant and make a payment using test data.

Test data

Test cards

Test transactions

Test email address

Test phone numbers

Rate this page

Is there anything we can improve? Send

Don’t want to answer

Thank you for your feedback!