interledger / open-payments

Protocol to setup payments between entities on the Web based on GNAP

Open Payments

What is Open Payments?

Open Payments is an open API standard that can be implemented by account servicing entities (e.g. banks, digital wallet providers, and mobile money providers) to facilitate interoperability in the setup and completion of payments for different use cases including:

• Web Monetization
• Tipping/Donations (low value/low friction)
• eCommerce checkout
• P2P transfers
• Subscriptions
• Invoice Payments

An Open Payments server runs two sub-systems, a resource server which exposes APIs for performing functions against the underlying accounts and and authorisation server which exposes APIs compliant with the GNAP standard for getting grants to access the resource server APIs.

This repository hosts the Open API Specifications of the two APIs which are published along with additional documentation at https://openpayments.guide.

Additionally, this repository also contains three published libraries:

• @interledger/open-payments contains a NodeJS Open Payments SDK to make requests via the Open Payments API, as well as TypeScript types for the API.
• @interledger/http-signature-utils provides tools for working with HTTP Message Signatures.
• @interledger/openapi exposes functionality to validate requests and responses according to a given OpenAPI 3.1 schema.

The code for the landing page is in ./docs.

Dependencies

• Interledger

New to Interledger?

Never heard of Interledger before? Or would you like to learn more? Here are some excellent places to start:

• Interledger Website
• Interledger Specification
• Interledger Explainer Video
• Open Payments
• Web monetization

Contributing

Please read the contribution guidelines before submitting contributions. All contributions must adhere to our code of conduct.

Open Payments Catchup Call

Our catchup calls are open to our community. We have them every Monday at 11:00 GMT, via Google Meet.

Video call link: https://meet.google.com/htd-eefo-ovn

Or dial: (DE) [phone] and enter this PIN: 105 520 503#

More phone numbers: https://tel.meet/htd-eefo-ovn?hs=5

Local Development Environment

Prerequisites

• NVM

Environment Setup

# install node 18
nvm install lts/hydrogen
nvm use lts/hydrogen

# install pnpm
corepack enable

# if moving from yarn run
pnpm clean

# install dependencies
pnpm i

Local Development

Useful commands

# format and lint code:
pnpm format

# check lint and formatting
pnpm checks

# verify code formatting:
pnpm check:prettier

# verify lint
pnpm check:lint

# build all the packages in the repo:
pnpm -r build

# run individual tests (e.g. open-payments)
pnpm --filter open-payments test

# run all tests
pnpm -r --workspace-concurrency=1 test