Get an incoming payment

An authorized client can look up the state of an incoming payment on a wallet address. This is useful when a client must determine if an incoming payment is still active and pending payment.

These code snippets return the state and details of a specific incoming payment, if found.

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.

Get the state of an incoming payment

TypeScript

Prerequisites

• Node 18
• 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"
  }
}

Get started

Import dependencies

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

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

Initialize Open Payments client

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

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

Get incoming payment

const incomingPayment = await client.incomingPayment.get({
  url: INCOMING_PAYMENT_URL,
  accessToken: INCOMING_PAYMENT_ACCESS_TOKEN,
});

Copied! Copy const incomingPayment = await client.incomingPayment.get({ url: INCOMING_PAYMENT_URL, accessToken: INCOMING_PAYMENT_ACCESS_TOKEN, });

Output

console.log("INCOMING PAYMENT:", incomingPayment);

Copied! Copy console.log("INCOMING PAYMENT:", incomingPayment);

Run tsx path/to/directory/index.ts.

View full source

JavaScript

Prerequisites

• Node 18 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! Copy import { createAuthenticatedClient } from "@interledger/open-payments";

Initialize Open Payments client

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

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

Get incoming payment

const incomingPayment = await client.incomingPayment.get({
  url: INCOMING_PAYMENT_URL,
  accessToken: INCOMING_PAYMENT_ACCESS_TOKEN,
});

Copied! Copy const incomingPayment = await client.incomingPayment.get({ url: INCOMING_PAYMENT_URL, accessToken: INCOMING_PAYMENT_ACCESS_TOKEN, });

Output

console.log("INCOMING PAYMENT:", incomingPayment);

Copied! Copy console.log("INCOMING PAYMENT:", incomingPayment);

Run node path/to/directory/index.js.

View full source

References

• API specification