-
Notifications
You must be signed in to change notification settings - Fork 5
feat: open payments java sdk blog post #180
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
d9d6291
133a66b
4b539d5
582fe8f
3c3a292
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| --- | ||
| title: 'Getting Started with Open Payments Java SDK' | ||
| description: 'Discover the Open Payments Java SDK and master its usage for seamless integrations.' | ||
| date: 2025-12-18 | ||
| slug: open-payments-java | ||
| authors: | ||
| - Oana Lolea | ||
| author_urls: | ||
| - https://github.com/oana-lolea | ||
| tags: | ||
| - Releases | ||
| - Open Payments | ||
| - Updates | ||
| --- | ||
|
|
||
| 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. Now, we are bringing Open Payments support to these developers through a native, idiomatic library that eliminates the need for manual HTTP management. | ||
|
|
||
| ## Introducing Java SDK for Open Payments | ||
|
|
||
| We're excited to announce the release of the [**Java SDK for Open Payments**](https://github.com/interledger/open-payments-java)\! 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. | ||
|
|
||
| ## 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: | ||
|
|
||
| - **Reduced integration costs**: Connect to a global, protocol-agnostic payment network without maintaining dozens of provider-specific integrations. | ||
| - **Improved resilience and reach**: Leverage Interledger's interoperability to access new markets and payment rails while avoiding single-provider risk. | ||
| - **Enterprise-ready tooling alignment**: Integrate seamlessly with familiar frameworks like Spring Boot, Quarkus, or Micronaut, and existing security/compliance workflows. | ||
| - **Faster innovation**: Enable use cases such as cross-border B2B transfers, automated treasury management, real-time reconciliations, and next-generation fintech products, all within established Java ecosystems. | ||
|
|
||
| This SDK makes it straightforward for Java teams to experiment with, prototype, and deploy Open Payments-based payments in production. | ||
|
|
||
| ## 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: | ||
|
|
||
| - **Native Java feel**: Fluent APIs, builders, and strong typing. | ||
| - **Simplified complexity**: Handles GNAP grant flows, HTTP signature support (Ed25519) and nonce management. | ||
| - **Minimal boilerplate**: No more manual JSON handling or signature calculations for every request. | ||
|
|
||
| ## Challenges Along the Way | ||
|
|
||
| While building the Java SDK for Interledger's Open Payments, we ran into two main challenges. | ||
|
|
||
| First, the OpenAPI specification did not work well with Java code generators. The generated Java code was cluttered — with unnecessary wrappers and structures that did not respect typical Java idioms and readability standards. Instead of trying to fix generated code with extra scripts or keeping the output, we chose to write the entire client layer by hand. This gave us a lightweight, focused library with full alignment to Java's conventions. | ||
|
|
||
| We also faced JSON handling issues that default Java libraries couldn't manage well. Open Payments models include special cases like RFC 3339 timestamp (`Instant`), ordered set (needing preserved insertion order of `Set`), and `Client` model. To fix this, we wrote custom serializers to ensure exact spec compliance. | ||
|
Comment on lines
+45
to
+49
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe we can add a subtitle for this section to better separate it |
||
|
|
||
| ## Key Features | ||
|
|
||
| The SDK supports core Open Payments functionality: | ||
|
|
||
| - Complete support for managing Open Payments operations (grants, incoming and outgoing payments, quotes and tokens). | ||
| - Full error handling and validation. | ||
| - Configurable HTTP client, such as connection, read timeout and transaction expiration durations. | ||
| - Examples for common flows. | ||
| - Comprehensive models and Javadoc. | ||
| - Unit tests for core logic and integration tests verifying end-to-end flows (against the Interledger Test Wallet) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| The library is available on Maven Central and adding it to your project is straightforward: | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>org.interledger</groupId> | ||
| <artifactId>open-payments</artifactId> | ||
| <version>1.1.0</version> | ||
| </dependency> | ||
| ``` | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note to self: check before publishing that the project is available on Maven Central
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @oana-lolea , true, I always check out the |
||
|
|
||
| And now let’s see an example of how to create an incoming payment: | ||
|
|
||
| ```java | ||
| 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 = client.createGrantIncomingPayment(receiverWallet); | ||
| var incomingPayment = 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: | ||
|
|
||
| | Package | Content | | ||
| | ------------- | ------------------------------------------------------------------------------- | | ||
| | `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 and let us know what you think via GitHub or the Interledger Slack community channels. Your feedback will shape where this goes next! | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll update the date when it will be released