Skip to content
GitHub

Create an outgoing payment

Last reviewed: Nov 10, 2026

The Create an Outgoing Payment API lets you request the creation of an outgoing payment resource.

A client can create an outgoing payment resource against the sender’s wallet address after:

  • A quote is accepted AND
  • The client obtains the requisite grant from the sender’s financial service provider

The code snippets below let an authorized client request an outgoing payment resource be created against the sender’s wallet address. The amount of the outgoing payment is based on the amounts in the associated 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 wallet address information
const walletAddress = await client.walletAddress.get({
url: WALLET_ADDRESS
})
// Create outgoing payment
const outgoingPayment = await client.outgoingPayment.create(
{
url: walletAddress.resourceServer,
accessToken: OUTGOING_PAYMENT_ACCESS_TOKEN
},
{
walletAddress: WALLET_ADDRESS,
quoteId: QUOTE_URL
}
)
// Output
console.log('OUTGOING_PAYMENT_URL = ', outgoingPayment.id)