Getting Started with Open Payments Java SDK

Written by Oana Lolea

As adoption of Open Payments grows within the Interledger ecosystem, developers are building innovative solutions, enabling truly global, frictionless value transfer.

A significant portion of enterprise-grade backend services, financial platforms, and scalable applications are powered by Java. Developers in these environments have long sought a native, idiomatic way to integrate Open Payments without the overhead of language bridges or manual HTTP management.

Introducing Java SDK for Open Payments

We’re excited to announce the release of the Java SDK for Open Payments! This new SDK brings robust, type-safe support directly to the Java world, making it easier than ever for Java developers to harness the full potential of interoperable payments.

Why We Built the Java SDK

We’ve heard from our community: Java remains a powerhouse for enterprise-grade applications, especially in the fintech space where reliability, scalability, and security are paramount. The new Java SDK addresses this by offering:

It lets you focus on building innovative payment features while writing clean, maintainable Java code.

Open Payments and the Java Ecosystem

Java continues to power the majority of enterprise software, especially in sectors where reliability, security, and scalability are critical—such as banking, financial services, payment processing, and large-scale backend systems. The availability of a native Java SDK for Open Payments brings several important advantages:

This SDK makes it straightforward for Java teams to experiment with, prototype, and deploy Interledger-based payments in production.

Key Features

The SDK supports core Open Payments functionality:

Getting Started

The library is available on Maven Central and adding it to your project is straightforward:

<dependency>
<groupId>org.interledger</groupId>
<artifactId>open-payments</artifactId>
<version>1.0.0</version>
</dependency>

And now let’s see an example of how to create an incoming payment:

import org.interledger.openpayments.*;
// Create HTTP client
IOpenPaymentsClient client = OpenPaymentsHttpClient.defaultClient(
"WalletAddress",
"PrivateKeyPEM",
"KeyId"
);
// Retrieve the wallet:
var receiverWallet = client.getWalletAddress("https://cloudninebank.example.com/merchant");
// Create incoming payment:
var grantRequest = this.client.createGrantIncomingPayment(receiverWallet);
var incomingPayment = this.client.createIncomingPayment(receiverWallet, grantRequest, BigDecimal.valueOf(11.25));

Packages Overview

The SDK is thoughtfully organized into packages for better modularity and maintainability. Here’s an overview of the main packages based on the repository structure:

PackageContent
exception/Custom exceptions for both Open Payments API errors and client errors
httpclient/Client to interact with Open Payments API and its custom logger and options
mapper/Custom object mapper for JSON and API error processing, plus useful serializers
model/Data modelling for Open Payments resources
signing/Builder for signed HTTP requests to ensure Interledger API communication
util/Utility methods for validations

Get Coding!

Give the Java SDK a spin in your project. Try it out, break it, and let us know what you think via GitHub or the Interledger community channels. Your feedback will shape where this goes next!


As we are open source, you can easily check our work on GitHub. If the work mentioned here inspired you, we welcome your contributions. You can join our community slack or participate in the next community call, which takes place each second Wednesday of the month.

If you want to stay updated with all open opportunities and news from the Interledger Foundation, you can subscribe to our newsletter.