Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
259 changes: 259 additions & 0 deletions src/content/blog/2025-12-19-go-further-with-open-payments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
---
title: 'Go Further with Open Payments'
description: 'Announcing the Open Payments Go SDK'
date: 2025-12-19
slug: go-further-with-open-payments
authors:
- Blair Currey
author_urls:
- https://www.linkedin.com/in/blair-currey/
tags:
- Open Payments
- Releases
- Updates
---

## Why Open Payments in Go?

The [**Open Payments**](https://openpayments.dev/) standard is reshaping how applications initiate, manage, and complete digital transactions — enabling truly interoperable financial systems across different wallets, services, and financial institutions.

The Interledger Foundation has been steadily expanding SDK support across languages — [Node](https://github.com/interledger/open-payments-node) led the way, followed by [PHP](https://github.com/interledger/open-payments-php) and [Rust](https://github.com/interledger/open-payments-rust). But one language was notably missing: **Go**.

According to the [2025 Stack Overflow Developer Survey](https://survey.stackoverflow.co/2025/technology#worked-with-vs-want-to-work-with-language-worked-want), Go ranks among the top backend languages, sitting alongside TypeScript and Python in developer adoption. Perhaps more tellingly, the survey notes that "Python developers aspire to use Rust and Go as the path to high-performance systems programming" — reflecting Go's growing role in cloud infrastructure, microservices, and performance-critical backends.

Today, we're excited to close that gap with [**Open Payments Go**](https://github.com/interledger/open-payments-go) — an open-source SDK that brings first-class Open Payments support to the Go ecosystem.

## What We Built

[interledger/open-payments-go](https://github.com/interledger/open-payments-go) is a production-ready Go module that provides complete client support for the Open Payments API.

It includes:

- Complete API coverage — wallet addresses, grants, tokens, quotes, incoming payments, and outgoing payments.
- Built for Go 1.21+, leveraging Go's strong typing, interfaces, and standard library conventions.
- **Types generated directly from OpenAPI specifications** using [oapi-codegen](https://github.com/oapi-codegen/oapi-codegen), ensuring the SDK stays in sync with the Open Payments spec.
- Built-in HTTP signature utilities for [GNAP authentication](https://openpayments.dev/identity/http-signatures/), abstracting away the complexity of Ed25519 signing.
- Comprehensive integration tests against both local Rafiki environments and testnet.

Here's what it looks like to request a grant and create an incoming payment:

```go
package main

import (
"context"
"log"
"time"

openpayments "github.com/interledger/open-payments-go"
as "github.com/interledger/open-payments-go/generated/authserver"
rs "github.com/interledger/open-payments-go/generated/resourceserver"
)

func main() {
privateKeyBase64 := os.Getenv("BASE64_PRIVATE_KEY")
keyId := os.Getenv("KEY_ID")

// Initialize the authenticated client
client, err := openpayments.NewAuthenticatedClient(
"https://wallet.example.com/alice", // Your wallet address
privateKeyBase64,
keyId,
)
if err != nil {
log.Fatal(err)
}

// Get wallet address info
wallet, err := client.WalletAddress.Get(context.Background(), openpayments.WalletAddressGetParams{
URL: "https://wallet.example.com/alice",
})
if err != nil {
log.Fatal(err)
}

// Build the access request
incomingAccess := as.AccessIncoming{
Type: as.IncomingPayment,
Actions: []as.AccessIncomingActions{
as.AccessIncomingActionsCreate,
as.AccessIncomingActionsRead,
as.AccessIncomingActionsList,
as.AccessIncomingActionsComplete,
},
}
accessItem := as.AccessItem{}
accessItem.FromAccessIncoming(incomingAccess)

// Request a grant
grant, err := client.Grant.Request(context.Background(), openpayments.GrantRequestParams{
URL: *wallet.AuthServer,
RequestBody: as.GrantRequestWithAccessToken{
AccessToken: struct {
Access as.Access `json:"access"`
}{
Access: []as.AccessItem{accessItem},
},
},
})
if err != nil {
log.Fatal(err)
}

// Create an incoming payment
expiresAt := time.Now().Add(24 * time.Hour)
payment, err := client.IncomingPayment.Create(context.Background(), openpayments.IncomingPaymentCreateParams{
BaseURL: *wallet.ResourceServer,
AccessToken: grant.AccessToken.Value,
Payload: rs.CreateIncomingPaymentJSONBody{
WalletAddressSchema: *wallet.Id,
IncomingAmount: &rs.Amount{
Value: "1000",
AssetCode: wallet.AssetCode,
AssetScale: wallet.AssetScale,
},
ExpiresAt: &expiresAt,
},
})
if err != nil {
log.Fatal(err)
}

log.Printf("Created incoming payment: %s", *payment.Id)
}
```

With Go's strong typing and the SDK's clean API design, developers get compile-time safety and IDE autocompletion for the entire Open Payments workflow.

## How It Works: Inside the Library

Open Payments Go is designed around Go idioms and best practices, making it feel natural for Go developers while handling the complexity of the Open Payments protocol.

### Project Structure

| Package | Purpose |
| ------------------------------- | --------------------------------------------------------------- |
| `openpayments` (root) | Main client types, service implementations, and public API |
| `generated/authserver` | Types generated from the Auth Server OpenAPI spec |
| `generated/resourceserver` | Types generated from the Resource Server OpenAPI spec |
| `generated/walletaddressserver` | Types generated from the Wallet Address Server OpenAPI spec |
| `httpsignatureutils` | HTTP signature creation and validation utilities |
| `test/integration` | Integration tests against Rafiki local and testnet environments |

### Service-Oriented Architecture

Each Open Payments resource has a dedicated service with methods that map directly to API operations:

- `client.WalletAddress.Get()`, `GetKeys()`, `GetDIDDocument()`
- `client.Grant.Request()`, `Continue()`, `Cancel()`
- `client.IncomingPayment.Create()`, `Get()`, `List()`, `Complete()`, `GetPublic()`
- `client.OutgoingPayment.Create()`, `Get()`, `List()`
- `client.Quote.Create()`, `Get()`
- `client.Token.Rotate()`, `Revoke()`

### Type-Safe Generated Types with OpenAPI Overlays

One challenge we faced was that the upstream OpenAPI specifications didn't always produce ideal Go types when run through code generators. For example, request bodies for grants and outgoing payments used `oneOf` unions that resulted in awkward generated type names like `PostRequestJSONBody`.

To solve this, we leveraged [OpenAPI Overlays](https://learn.openapis.org/overlay/) — a powerful technique for modifying OpenAPI specs without forking them. Our overlay files (`authserver.overlay.yaml`, `resourceserver.overlay.yaml`) add explicit type names and restructure unions for better Go ergonomics:

```yaml
# resourceserver.overlay.yaml
actions:
- target: $.components.schemas
update:
CreateOutgoingPaymentWithQuote:
type: object
required: [walletAddress, quoteId]
properties:
walletAddress:
$ref: '#/components/schemas/walletAddress'
quoteId:
type: string
metadata:
type: object
additionalProperties: true

CreateOutgoingPaymentWithAmount:
type: object
required: [walletAddress, incomingPayment, debitAmount]
# ...
```

Instead of wrestling with anonymous types, you get clear, self-documenting structs:

```go
// Without overlays: confusing generated names
var payload PostRequestJSONBody // What is this?

// With overlays: intent is obvious
var payload rs.CreateOutgoingPaymentWithQuote
payload.WalletAddressSchema = walletAddress
payload.QuoteId = quoteId
```

This approach keeps us in sync with upstream specs while producing clean, well-named Go types.

### HTTP Signatures Made Simple

Open Payments requires [HTTP Message Signatures](https://openpayments.dev/introduction/http-signatures/) for authenticated requests. The SDK handles this complexity internally through the `httpsignatureutils` package:

The SDK automatically signs requests when using `AuthenticatedClient`. Internally, it:

1. Computes `Content-Digest` for request bodies
2. Builds the signature base string per RFC 9421
3. Signs with your Ed25519 private key
4. Sets `Signature` and `Signature-Input` headers

## Why It Matters for the Go Community

Go powers a significant portion of cloud infrastructure, payment systems, and fintech backends. By bringing native Open Payments support to Go, we enable:

- **Cloud-native payment integrations**: Deploy Open Payments clients as microservices, serverless functions, or embedded in existing Go applications.

- **High-performance payment processing**: Go's concurrency model and low overhead make it ideal for high-throughput payment scenarios.

- **Type safety at compile time**: Catch integration errors before runtime with Go's strong typing and the SDK's generated types.

- **Battle-tested**: Comprehensive integration tests run against both local Rafiki environments and the Interledger testnet, ensuring real-world reliability.

## Getting Started

Install the SDK:

```bash
go get github.com/interledger/open-payments-go
```

The SDK requires Go 1.21 or later. For development, you'll also need to initialize the OpenAPI spec submodule:

```bash
git submodule update --init
```

To regenerate types from the specs (if you're contributing or customizing):

```bash
go generate ./generated
```

## What's Next

We're actively developing Open Payments Go and have exciting plans ahead:

- **Official documentation integration** — Open Payments docs will include Go examples alongside JavaScript, TypeScript, and PHP examples.

- **Community feedback** — We want to hear from you! Open issues, submit PRs, or join discussions on GitHub.

## Resources

- GitHub: [interledger/open-payments-go](https://github.com/interledger/open-payments-go)
- [Open Payments Specification](https://openpayments.dev/)
- [Interledger Foundation](https://interledger.org/)
- [Rafiki — Open Payments Reference Implementation](https://github.com/interledger/rafiki)

---

We're excited to bring Open Payments to the Go ecosystem and can't wait to see what the community builds.

Give it a try, and let us know what you think! 🚀
2 changes: 1 addition & 1 deletion src/content/docs/get-involved.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you are most comfortable working with **Angular**, you can contribute to [Tes

If you are most comfortable working with the **Web Extensions API**, you can contribute to the [Web Monetization Extension](https://github.com/interledger/web-monetization-extension)

If you are most comfortable in either **Python**, **Go**, **Rust**, **PHP**, **Ruby** or **.Net**, you can contribute to porting the [Open Payments SDK](https://github.com/interledger/open-payments) to the any of the aforementioned languages.
If you are most comfortable in either **Python**, **Ruby** or **.Net**, you can contribute to porting the [Open Payments SDK](https://github.com/interledger/open-payments) to the any of the aforementioned languages.

If you have experience working on browser engines, you can contribute to the [Chromium](https://issues.chromium.org/issues/40110471) browser implementation of Web Monetization.

Expand Down