Create an outgoing payment

After a quote is accepted and the authorized client obtains the requisite grant from the authorization server of the sender’s ASE ? Account servicing entity , the client can create an outgoing payment resource against the sender’s wallet address.

These code snippets create an outgoing payment to a given wallet address. The amount of the outgoing payment is based on the amounts in the associated quote.

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.

Create an outgoing payment resource

TypeScript/JavaScript

Prerequisites

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";

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

Create outgoing payment

const outgoingPayment = await client.outgoingPayment.create(
  {
    url: new URL(WALLET_ADDRESS).origin,
    accessToken: OUTGOING_PAYMENT_ACCESS_TOKEN,
  },
  {
    walletAddress: WALLET_ADDRESS,
    quoteId: QUOTE_URL,
  },
);

Copied! Copy const outgoingPayment = await client.outgoingPayment.create( { url: new URL(WALLET_ADDRESS).origin, accessToken: OUTGOING_PAYMENT_ACCESS_TOKEN, }, { walletAddress: WALLET_ADDRESS, quoteId: QUOTE_URL, }, );

Output

console.log("OUTGOING_PAYMENT_URL = ", outgoingPayment.id);

Copied! Copy console.log("OUTGOING_PAYMENT_URL = ", outgoingPayment.id);

For TypeScript, run tsx path/to/directory/index.ts. View full TS source

For JavaScript, run node path/to/directory/index.js. View full JS source

Rust

Prerequisites

Import dependencies

use open_payments::client::api::AuthenticatedResources;
use open_payments::client::utils::get_resource_server_url;
use open_payments::snippets::utils::{create_authenticated_client, get_env_var, load_env};
use open_payments::types::OutgoingPaymentRequest;

Copied! Copy use open_payments::client::api::AuthenticatedResources; use open_payments::client::utils::get_resource_server_url; use open_payments::snippets::utils::{create_authenticated_client, get_env_var, load_env}; use open_payments::types::OutgoingPaymentRequest;

Initialize Open Payments client

let client = create_authenticated_client()?;

Copied! Copy let client = create_authenticated_client()?;

Prepare outgoing payment request

let access_token = get_env_var("OUTGOING_PAYMENT_ACCESS_TOKEN")?;
let quote_url = get_env_var("QUOTE_URL")?;
let wallet_address_url = get_env_var("WALLET_ADDRESS_URL")?;
let resource_server_url = get_resource_server_url(&wallet_address_url)?;

let request = OutgoingPaymentRequest::FromQuote {
    wallet_address: wallet_address_url,
    quote_id: quote_url,
    metadata: None,
};

Copied! Copy let access_token = get_env_var("OUTGOING_PAYMENT_ACCESS_TOKEN")?; let quote_url = get_env_var("QUOTE_URL")?; let wallet_address_url = get_env_var("WALLET_ADDRESS_URL")?; let resource_server_url = get_resource_server_url(&wallet_address_url)?; let request = OutgoingPaymentRequest::FromQuote { wallet_address: wallet_address_url, quote_id: quote_url, metadata: None, };

Create outgoing payment

println!(
    "Outgoing payment create request JSON: {}",
    serde_json::to_string_pretty(&request)?
);

let payment = client
    .outgoing_payments()
    .create(&resource_server_url, &request, Some(&access_token))
    .await?;

Copied! Copy println!( "Outgoing payment create request JSON: {}", serde_json::to_string_pretty(&request)? ); let payment = client .outgoing_payments() .create(&resource_server_url, &request, Some(&access_token)) .await?;

Output

println!("Created outgoing payment: {payment:#?}");

Copied! Copy println!("Created outgoing payment: {payment:#?}");

View full Rust source

PHP

Prerequisites

Import dependencies

use OpenPayments\AuthClient;
use OpenPayments\Config\Config;

Copied! Copy use OpenPayments\AuthClient; use OpenPayments\Config\Config;

Initialize Open Payments client

$config = new Config($WALLET_ADDRESS, $PRIVATE_KEY, $KEY_ID);
$opClient = new AuthClient($config);

Copied! Copy $config = new Config($WALLET_ADDRESS, $PRIVATE_KEY, $KEY_ID); $opClient = new AuthClient($config);

Without amount

Create outgoing payment

$newOutgoingPayment = $opClient->outgoingPayment()->create(
  [
    "url" => $wallet->resourceServer,
    "access_token" => $OUTGOING_PAYMENT_GRANT_ACCESS_TOKEN,
  ],
  [
    "walletAddress" => $config->getWalletAddressUrl(),
    "quoteId" => $QUOTE_URL,
    "metadata" => [
      "description" => "Test outgoing payment",
      "reference" => "1234567890",
      "invoiceId" => "1234567890",
      "customData" => [
        "key1" => "value1",
        "key2" => "value2",
      ],
    ],
  ],
);

Copied! Copy $newOutgoingPayment = $opClient->outgoingPayment()->create( [ "url" => $wallet->resourceServer, "access_token" => $OUTGOING_PAYMENT_GRANT_ACCESS_TOKEN, ], [ "walletAddress" => $config->getWalletAddressUrl(), "quoteId" => $QUOTE_URL, "metadata" => [ "description" => "Test outgoing payment", "reference" => "1234567890", "invoiceId" => "1234567890", "customData" => [ "key1" => "value1", "key2" => "value2", ], ], ], );

With amount

Create outgoing payment with amount

$newOutgoingPayment = $opClient->outgoingPayment()->create(
  [
    "url" => $wallet->resourceServer,
    "access_token" => $OUTGOING_PAYMENT_GRANT_ACCESS_TOKEN,
  ],
  [
    "walletAddress" => $config->getWalletAddressUrl(),
    "incomingPayment" => $INCOMING_PAYMENT_URL,
    "debitAmount" => [
      "value" => "121",
      "assetCode" => "USD",
      "assetScale" => 2,
    ],
    "metadata" => [
      "description" => "Test outgoing payment",
      "reference" => "1234567890",
      "invoiceId" => "1234567890",
      "customData" => [
        "key1" => "value1",
        "key2" => "value2",
      ],
    ],
  ],
);

Copied! Copy $newOutgoingPayment = $opClient->outgoingPayment()->create( [ "url" => $wallet->resourceServer, "access_token" => $OUTGOING_PAYMENT_GRANT_ACCESS_TOKEN, ], [ "walletAddress" => $config->getWalletAddressUrl(), "incomingPayment" => $INCOMING_PAYMENT_URL, "debitAmount" => [ "value" => "121", "assetCode" => "USD", "assetScale" => 2, ], "metadata" => [ "description" => "Test outgoing payment", "reference" => "1234567890", "invoiceId" => "1234567890", "customData" => [ "key1" => "value1", "key2" => "value2", ], ], ], );

Output

$output->writeln("OUTGOING_PAYMENT_URL " . $newOutgoingPayment->id);

Copied! Copy $output->writeln("OUTGOING_PAYMENT_URL " . $newOutgoingPayment->id);

View full source without amount

View full source with amount

References

• API specification