Complete an incoming payment

An authorized client can complete an unexpired incoming payment to indicate it will not send any additional payments to the wallet address.

These code snippets pass the wallet address and incoming payment URL to the resource server and mark the payment as completed.

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.

Mark an incoming payment as complete

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, });

Complete incoming payment

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

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

Output

console.log("INCOMING PAYMENT:", JSON.stringify(incomingPayment, null, 2));

Copied! Copy console.log("INCOMING PAYMENT:", JSON.stringify(incomingPayment, null, 2));

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, });

Complete incoming payment

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

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

Output

console.log("INCOMING PAYMENT:", JSON.stringify(incomingPayment, null, 2));

Copied! Copy console.log("INCOMING PAYMENT:", JSON.stringify(incomingPayment, null, 2));

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

View full source

References

• API specification