Skip to main content

Sandbox Environment

Introduction​

The Embedded Wallet Sandbox environment is a testing environment that allows you to interact with the Embedded Wallet APIs. This guide will help you understand how to use the sandbox environment effectively.

Important

The sandbox environment is intended exclusively for testing purposes. Use only the credentials that are specifically created for it.

No real end user data should be used during the testing process.

Create an account​

To get started with the sandbox environment, follow these steps:

  1. Access the Sandbox Dashboard sign up page.
  2. Fill in the necessary details and select Register.
  3. Activate your account by following the link sent to your email address.
  4. Open the Sandbox Dashboard login page and enter your credentials.

Get your API Keys​

To tests the Embedded Wallet APIs, you need to get the appropriate API keys from your sandbox account:

  1. Log in to your sandbox account.
  2. Navigate to the APIs section.
  3. Select API Keys from the Embedded Wallet (Sandbox) card.
  4. On this page, you will find a set of API keys, along with the respective brand identifier and HMAC Key for the US and ROW regions.
  5. These keys provide access to the Embedded Wallet APIs through the Sandbox environment (https://sandbox.paysafe.com).

API Key types​

Brand identifier​

Some of the Embedded Wallet APIs require a brand identifier. Use the provided one in the Brand identifier field on the APIs Keys page when necessary.

HMAC Key​

То ensure the authenticity and origin of the requests, a digital signature of the request payload is created for certain Embedded Wallet API endpoints using the HMAC key provided in the HMAC Key field for each region.

For more information, please refer to the Request Signing page.

Set up a Webhook URLs​

The Embedded Wallet APIs use webhooks, in order to notify you about various events happening in the system.

To configure webhook URLs:

  1. Log in to your sandbox account.
  2. Navigate to the APIs section.
  3. Select Webhooks from the Embedded Wallet (Sandbox) card.
  4. Configure the URLs for each webhook type.
  5. Save the configuration.
info

If there is no configuration for a given webhook type, then it won't be sent to you.

For more information about the available webhook types, please refer to the Webhooks page.

Generate a subject token​

To use the Embedded Wallet SDKs, you need an access token, which can be obtained through the Token Exchange flow. To initiate the Token Exchange, you must provide a signed JWT (subject token) containing the end user data. Our system will validate this token, and upon successful validation, an access token will be issued for the SDKs to use for the specified user.

Follow these steps to generate a dummy subject token for the Token Exchange flow:

  1. Log in to your sandbox account.
  2. Navigate to the APIs section.
  3. Select Token Exchange from the Embedded Wallet (Sandbox) card.
  4. Provide User External ID.
  5. Select Generate dummy subject token.
  6. Use this token as a subject token in the Issue an Access Token API for the Token Exchange flow.
note

This token is valid only for the sandbox environment and can not be used in the production environment.