Overview

note

PayString was previously known as PayID.

PayString is a simple, web-based protocol designed to make it as easy to send someone money as it is to send them an email. This guide walks you through the following.

Your contributions are welcome. Check out the PayString repository on GitHub, and note the Contributing guidelines.

Experiment with the PayString Sandbox#

The PayString Sandbox lets you experiment with PayString in a test environment. Your work is not saved between sessions, and the sandbox may be reset at any time.

To use PayString Sandbox, log in with your Github account and follow the prompts. You can quickly set up a virtual test server, and then create users with simple PayString addresses that map to addresses on various networks such as XRPL, Interledger, BTC, and ETH. Using the provided cURL or Javascript code, you can create, update, and delete users, and get payment information about a PayString address. While the session is running, you can also run operations from your command line. See Get Started With PayString Sandbox.

Run a PayString Server#

See Get Started With a Local PayString Server.

Run PayString CLI#

PayString CLI allows you to manage PayStrings and get user information from the command line. See Get Started With PayString CLI.

RippleX Dev Kit Integration#

PayString support is integrated into RippleX Dev Kit.

RippleX Dev Kit provides the ability to work with PayString. It provides three language libraries:

These libraries help you connect your application to PayString without having to worry about the specifics of PayString. Try Get Started With RippleX Dev Kit and PayString.

Best Practices for App Development#

Follow these guidelines for incorporating PayString into your app.

Learn More#

You now have a good foundation for learning more about the PayString Protocol. Here are some next steps you can take:

  • How to convert the user$domain.com format to a URL
  • Learn how to use relevant HTTP headers
  • Learn how to handle different types of responses you could receive from a PayString server

You can use extended PayString features:

Learn about:

Edit this page