List incoming payments
After one or more incoming payments have been 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 payment pointer
Prerequisites
- Node 20
- A package manager such as NPM or PNPM
-
Open Payments SDK
- TSX
Additional configuration
Add "type": "module"
to package.json
Add the following to tsconfig.json
{ "compilerOptions": { "target": "ES2022", "module": "ES2022" }}
Import createAuthenticatedClient
from the Open Payments SDK
Import dependencies
import { createAuthenticatedClient } from "@interledger/open-payments";
Copied! Create an authenticated Open Payments client
Create an Open Payments-authenticated client by providing the following properties:
walletAddressURL
: your Open Payments-enabled wallet address that your client will use to authenticate itself to one or more authorization servers.privateKey
: the EdDSA-Ed25519 key or preferably the absolute or relative file path to the key that is bound to your wallet address. A public key signed with this private key must be made available as a public JWK document at{walletAddressUrl}/jwks.json
url.keyId
: the identifier of the private key and the corresponding public key.
Initialize Open Payments client
const client = await createAuthenticatedClient({
walletAddressUrl: WALLET_ADDRESS,
privateKey: PRIVATE_KEY_PATH,
keyId: KEY_ID,
});
Copied! Get started
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! Run tsx path/to/directory/index.ts
.
Prerequisites
- Node 20 or higher
- A package manager such as NPM or PNPM
-
Open Payments SDK
Additional configuration
Add "type": "module"
to package.json
Get started
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! Run node path/to/directory/index.js
.