Skip to content
GitHub

Overview

An API for open access to financial accounts to send and receive payments.

Open Payments (1.3.0)

Section titled “Open Payments (1.3.0)”

The resource server manages the core transaction resources of the Open Payments protocol: incoming payments, outgoing payments, and quotes. All resources are scoped to a wallet address and require an access token issued by the authorization server.

Endpoints:

  • /incoming-payments — create and manage incoming payments
  • /outgoing-payments — create and manage outgoing payment instructions
  • /quotes — request a quote for a specific send or receive amount

For a full overview of these resources, see the Resources concepts page.

Authentication

Section titled “ Authentication ”

GNAP

Section titled “GNAP ”

The API uses the Grant Negotiation and Authorization Protocol for authorization. An access token must be acquired from an authorization server before accessing the API and then provided in the request headers using the prefix GNAP.

All requests must also be signed using a client key over some select headers and a digest of the request body.

Security scheme type: apiKey

Header parameter name: Authorization