Before you begin

The Open Payments SDKs provide developers with pre-built functions that simplify interactions with the Open Payments API. Currently, we offer a TypeScript/NodeJS SDK and a PHP SDK, with plans to expand to additional languages and frameworks in the future.

Using the SDKs

Each SDK snippet page uses a tabbed interface to support multiple programming languages. This means you can find the relevant code snippets for the language of your choice with ease, without needing individual pages for each language. The basic structure of each page is as follows:

• The page title reflects the operation, function, or action being performed.
• A few overview paragraphs provide context about the function, its role in the Open Payments flow, and any general information that may be helpful.
• The “Before you begin” section that links back to this page for steps to create a test wallet.
• The main content area includes the tabbed interface where you can select your preferred programming language.

Within the tabbed interface, you’ll notice the following sections:

• A “Prerequisites” button that links to the respective SDK’s README on GitHub for setup instructions.
• Any additional configuration steps required for the selected language.
• Code blocks for each step in the process, broken down into manageable chunks.
• After the code snippets, any other commands that need to be run are mentioned, along with links to the relevant API reference documentation or other pertinent resources.

This consistent structure across all SDK snippet pages allow you to quickly grasp the functionality and implementation details, making it easier to work with the Open Payments SDKs.

Create an account on the test wallet

Before working with our SDK snippets, we recommend creating a wallet account on the test wallet that’s part of the Interledger testnet.

The test wallet lets you create developer keys and wallet accounts, funded with play money, for making Interledger transactions via the Open Payments APIs.

1. Go to wallet.interledger-test.dev.
2. Click Create account at the bottom-right of the screen.
3. Enter your e-mail address, a strong password, then confirm the password. Click the arrowhead.
4. Go to your inbox and look for an e-mail sent by tech@interledger.org with the subject “[Test.Wallet] Verify your account”. Click Confirm my email address.
5. Click Login to your account at the email verification screen.
6. Log in with your credentials.
7. Complete the Know Your Customer (KYC) steps. The only real information you need to share is your email address. All other information can be fake.

   Why are there so many KYC steps?

   The Interledger test wallet environment is running on a GateHub pre-production environment. The pre-production environment mimics the production environment, including many of the KYC steps.

You’re now ready to create a test wallet and add money to it!

Create and fund a wallet account

1. Click New account on the Interledger Wallet dashboard.

   

2. Enter any account name, select an asset (currency), then click Create account.

   

3. Click Close, then click Accounts from the left nav bar.

4. Select the account you just created.

5. Click Deposit.

   

6. Enter an amount between 50 to 1,000 to deposit into the account, then click Deposit.

   Caution

   The minimum deposit amount is 50. Though you can enter an amount larger than 1,000, total deposits exceeding 10,000 within 24 hours will be subject to manual review and approval. Thus, to avoid delays, it is advised that each deposit be limited to 1,000 to allow multiple deposits within a 24-hour period automatically.

   

   You now have a funded test wallet!

Add a payment pointer to your wallet account

1. Select the account from the Test Wallet dashboard.
2. Click Add payment pointer.
3. Enter a Payment Pointer name and a Public name of your choosing.
4. Click Create. Your account now has a payment pointer.

Obtain a public-private key pair and key ID

Before you can initialize an authenticated Open Payments client, you must obtain a public-private key pair and a key ID.

1. Click Settings in the left sidebar on the dashboard.
2. Click the Developer Keys tab.
3. Expand the menu for your wallet account.
4. Click Generate public & private key.
5. Enter any nickname for the key pair, then click Generate keys. A file named private.key automatically downloads to your machine
6. Click Close. Your key ID appears on the screen, along with a Show/Hide option for your public key.

You can now use your keys and payment pointer to initialize an authenticated Open Payments client.