Skip to content
GitHub

Get an incoming payment

Last reviewed: Nov 10, 2026

The Get an Incoming Payment API lets you get the latest state of an incoming payment resource.

Using the ID of the payment resource, a client can determine whether the payment is active, pending payment, or complete, and get the value of the amount received.

The code snippets below let an authorized client retrieve the state and details of a specific incoming payment resource.

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

Authenticated client required
Prerequisites(opens in a new tab)
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'
// Initialize client
const client = await createAuthenticatedClient({
walletAddressUrl: CLIENT_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
})
// Output
console.log('INCOMING PAYMENT:', incomingPayment)
// Import dependencies
import { createAuthenticatedClient } from '@interledger/open-payments'
// Initialize client
const client = await createAuthenticatedClient({
walletAddressUrl: CLIENT_WALLET_ADDRESS,
privateKey: PRIVATE_KEY_PATH,
keyId: KEY_ID
})
// Get incoming payment
const incomingPayment = await client.incomingPayment.get({
url: INCOMING_PAYMENT_URL
})
// Output
console.log('INCOMING PAYMENT:', incomingPayment)