Get a quote

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.

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.

Get a quote

Authenticated client required

TypeScript/NodeJS

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'

// Initialize client
const client = await createAuthenticatedClient({
  walletAddressUrl: 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))

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::snippets::utils::{create_authenticated_client, get_env_var, load_env};

// Initialize client
let client = create_authenticated_client()?;

// Get quote
let access_token = get_env_var("QUOTE_ACCESS_TOKEN")?;
let quote_url = get_env_var("QUOTE_URL")?;

let quote = client.quotes().get(&quote_url, Some(&access_token)).await?;

// Output
println!("Quote: {quote:#?}");

View full source

PHP

Prerequisites

// Import dependencies
use OpenPayments\AuthClient;
use OpenPayments\Config\Config;

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

$wallet = $opClient->walletAddress()->get([
    'url' => $config->getWalletAddressUrl()
]);

// Get quote
$quote = $opClient->quote()->get(
    [
        'access_token' => $QUOTE_GRANT_ACCESS_TOKEN,
        'url' => $QUOTE_URL
    ]
);

// Output
echo 'QUOTE_URL ' . $quote->id . PHP_EOL;
echo 'QUOTE ' . print_r($quote, true) . PHP_EOL;

View full source

Go

Prerequisites

package main

// Import dependencies
import (
  "context"
  "encoding/json"
  "fmt"
  "log"

  op "github.com/interledger/open-payments-go"
)

func main() {
  // Initialize client
  client, err := op.NewAuthenticatedClient(WALLET_ADDRESS_URL, PRIVATE_KEY_BASE_64, KEY_ID)
  if err != nil {
    log.Fatalf("Error creating authenticated client: %v\n", err)
  }

  // Get quote
  quote, err := client.Quote.Get(context.TODO(), op.QuoteGetParams{
    URL:         QUOTE_URL,
    AccessToken: QUOTE_ACCESS_TOKEN,
  })
  if err != nil {
    log.Fatalf("Error fetching quote: %v\n", err)
  }

  // Output
  quoteJSON, err := json.MarshalIndent(quote, "", "  ")
  if err != nil {
    log.Fatalf("Error marshaling quote: %v\n", err)
  }
  fmt.Println("QUOTE:", string(quoteJSON))
}

Java

Prerequisites

// Import dependencies
import org.interledger.openpayments.httpclient.OpenPaymentsHttpClient;
import org.interledger.openpayments.IOpenPaymentsClient;

// Initialize client
IOpenPaymentsClient client = OpenPaymentsHttpClient.defaultClient(
"WalletAddress",
"PrivateKeyPEM",
"KeyId"
);

// Get wallet address information
var receiverWallet = client.walletAddress().get("https://cloudninebank.example.com/merchant");
var senderWallet = client.walletAddress().get("https://cloudninebank.example.com/customer");

// Create incoming payment
var grantRequest = client.auth().grant().incomingPayment(receiverWallet);
var incomingPayment = client.payment().createIncoming(receiverWallet, grantRequest, BigDecimal.valueOf(11.25));

// Create quote
var quoteRequest = client.auth().grant().quote(senderWallet);
var quote = client.quote().create(quoteRequest.getAccess().getToken(), senderWallet, incomingPayment, Optional.empty(), Optional.empty());

// Get the newly created quote (fetch by ID)
var quoteFetched = client.quote().get(quote.getId(), grantRequest);

// Output
log.info("QUOTE: {}", quoteFetched);

.NET

Prerequisites

// Import dependencies
using Microsoft.Extensions.DependencyInjection;
using Newtonsoft.Json;
using OpenPayments.Sdk.Clients;
using OpenPayments.Sdk.Extensions;
using OpenPayments.Sdk.HttpSignatureUtils;

// Initialize client
var client = new ServiceCollection()
    .UseOpenPayments(opts =>
    {
        opts.UseAuthenticatedClient = true;
        opts.KeyId = CLIENT_ID;
        opts.PrivateKey = KeyUtils.LoadPem(CLIENT_SECRET);
        opts.ClientUrl = new Uri(CLIENT_WALLET_ADDRESS);
    })
    .BuildServiceProvider()
    .GetRequiredService<IAuthenticatedClient>();

// Get quote
var quote = await client.GetQuoteAsync(
    new AuthRequestArgs
    {
        Url = new Uri(QUOTE_URL),
        AccessToken = QUOTE_ACCESS_TOKEN,
    }
);

// Output
Console.WriteLine($"QUOTE: {JsonConvert.SerializeObject(quote, Formatting.Indented)}");

View full source

References

• API specification