Skip to content
GitHub

Get a quote

Last reviewed: Nov 10, 2026

The Get a Quote API lets you get the latest details for a quote resource. For example, its state (whether it’s valid or expired), the total amount that the recipient should receive, and the total amount to be debited from the sender.

The code snippets below let an authorized client receive the state and other details of a specific quote.

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 quote
const quote = await client.quote.get({
url: QUOTE_URL,
accessToken: QUOTE_ACCESS_TOKEN
})
// Output
console.log('QUOTE:', JSON.stringify(quote, null, 2))