PayString Sandbox

note

PayString was previously known as PayID.

With the PayString Sandbox, you can experiment with PayString without deploying your own server. The PayString Sandbox does not directly support Verifiable PayString.

Caution: Although the PayString Sandbox can be used to create PayStrings, do not use PayStrings that rely on this virtual server to send or receive real cryptocurrency.

You can also experiment with PayString by using PayString CLI, which does support Verifiable PayString.

The sandbox allows you to experiment with PayString, but does not create an application that allows you to send or receive currency using the PayString.

You are encouraged to copy the cURL or JavaScript code snippets that the sandbox provides and adapt them to your app.

Requirements:

  • GitHub account. You will use this GitHub account to log in to PayString Sandbox.
  • Crypto addresses on other wallets or exchanges. You can map your PayString to these crypto addresses.

Open PayString Sandbox and Create a User#

  1. Open PayString Sandbox and log in with your GitHub account. The sandbox sets up a virtual server for you at <YOUR_GITHUB_USERNAME>.sandbox.paystring.org. You also get an Admin API token that can be used to create and manage users. Save this token for later use. By default, the sandbox incorporates this token into the Authorization: Bearer heading. Sandbox start
  2. Click Try API Constructor. API Constructor On the API Constructor page, you have access to all of PayString's capabilities. The Create User page opens by default.
  3. Under API Details, enter the value for this PayString to create a full PayString address. Example: starlight$loisrp.sandbox.paystring.org. This is a PayString that you can use to send or receive currency.
  4. Under Address1, select the network you want to use. For experimentation, you can choose any of the networks, and you can use a real or fake address for it. This example uses a live address on the XRPL network.
    • Select XRPL for the Payment Network
    • Enter rUAuauaXNTskaHdsz1TWnHWvB8goNXQaVy for the Payment Address.
    • The Destination Tag can be used to enter a number that is typically used to map to a user in another system. You can experiment by adding a value.
    • Select Testnet or Mainnet, depending whether you want to have the address be valid for test currency or real currency.
    • If you want to associate another address to this PayString, click + and repeat the process for another address. Your PayString can have multiple addresses on multiple networks on the same PayString.
  5. By default, cURL is selected on the top right. The sandbox constructs the cURL snippet you need to create a user. You can also select JavaScript to run a script to create a user.
  6. Click Run. Whether you used cURL or JavaScript, the JSON response for the newly created user looks the same.
    {
    "payId": "starlight$loisrp.sandbox.paystring.org",
    "addresses": [
    {
    "paymentNetwork": "XRPL",
    "details": {
    "address": "rUAuauaXNTskaHdsz1TWnHWvB8goNXQaVy",
    "tag": "56"
    }
    }
    ]
    }

Get Payment Information#

Get Payment Information is a public API, and does not require your Admin API token. You can use this API for any PayString.

  1. Click Get Payment Information on the left.
  2. Enter the PayString. On the sandbox, you are restricted to PayStrings on your server. Enter the PayString you just created, or another one you happen to know. Select either cURL or JavaScript at the top right.
  3. Click Run. The JSON response provides information about the PayString.

Get User#

Get User provides the same information as Get Payment Information, but Get User does so through the private Admin API.

  1. Click Get User on the left.

  2. Enter the PayString you want to look up.

  3. Select either cURL or JavaScript.

  4. Click Run. The JSON response provides information about the PayString.

    {
    "payId": "starlight$loisrp.sandbox.paystring.org",
    "addresses": [
    {
    "paymentNetwork": "XRPL",
    "environment": "TESTNET",
    "details": {
    "address": "rUAuauaXNTskaHdsz1TWnHWvB8goNXQaVy"
    }
    }
    ],
    "verifiedAddresses": []
    }

If you enter a nonexistent PayString, you get the response "Failed to find the PayString <NONEXISTENT_PAYID_VALUE>".

Replace User#

With Replace User, you can rename a PayString, and enter new address information. The address information from the "old" PayString does not transfer to the new PayString, so you have to enter the address information again.

  1. Click Replace User on the left.
  2. Enter the PayString you want to rename, and the new PayString. In this example, starlight is replaced with moonlight.
  3. Enter the address information as if you were creating a user.
  4. Select either cURL or JavaScript.
  5. Click Run.
    {
    "payId": "moonlight$loisrp.sandbox.paystring.org",
    "addresses": [
    {
    "paymentNetwork": "XRPL",
    "environment": "TESTNET",
    "details": {
    "address": "rUAuauaXNTskaHdsz1TWnHWvB8goNXQaVy"
    }
    }
    ],
    "verifiedAddresses": []
    }
The new PayString information is returned in JSON format.
## Delete a User
1. Click **Delete User** on the left.
2. Enter the PayString you want to delete.
3. Select either **cURL** or **JavaScript**.
4. Click **Run**. The PayString is returned.
`"moonlight$loisrp.sandbox.paystring.org"`
The PayString you have deleted is returned in the response. Even if the PayString did not exist, you will get the same response.
Edit this page