Skip to content
GitHub

List incoming payments

After one or more incoming payments are created on a wallet address, an authorized client can look up active and pending incoming payments on that wallet address.

These code snippets retrieve the first ten incoming payments on the given wallet address.

Before you begin

We recommend creating a wallet account on the test wallet. Creating an account allows you to test your client against the Open Payments APIs by using an ILP-enabled wallet funded with play money.

List all incoming payments on a wallet address

Prerequisites
Initial configuration

If you’re using JavaScript, only do the first step.

  1. Add "type": "module" to package.json.
  2. Add the following to tsconfig.json 
    {
      "compilerOptions": {
        "target": "ES2022",
        "module": "ES2022"
      }
    }

Import dependencies

import { createAuthenticatedClient } from "@interledger/open-payments";
Copied!

Initialize Open Payments client

const client = await createAuthenticatedClient({
  walletAddressUrl: WALLET_ADDRESS,
  privateKey: PRIVATE_KEY_PATH,
  keyId: KEY_ID,
});
Copied!

List incoming payments

const incomingPayments = await client.incomingPayment.list(
  {
    url: new URL(WALLET_ADDRESS).origin,
    walletAddress: WALLET_ADDRESS,
    accessToken: INCOMING_PAYMENT_ACCESS_TOKEN,
  },
  {
    first: 10,
    last: undefined,
    cursor: undefined,
  },
);
Copied!

Output

console.log("INCOMING PAYMENTS:", JSON.stringify(incomingPayments, null, 2));
Copied!

For TypeScript, run tsx path/to/directory/index.ts. View full TS source

For JavaScript, run node path/to/directory/index.js. View full JS source

References