Skip to content
GitHub

Glossary

Account servicing entity (ASE)

An account servicing entity provides and maintains a payment account for a payer and payee, and is a regulated entity in the country/countries it operates.

Authorization server (AS)

An authorization server issues tokens to clients, which can then be used to perform authorized actions on resource servers. In the context of Open Payments, the authorization server grants permission for a client to access the Open Payments APIs and the incoming-payment, quote, and outgoing-payment resources. Open Payments leverages GNAP as the mechanism for delegating authorization.

Client

A client is an application or service, such as a mobile or web app, that interacts with the authorization server to obtain grants and tokens. A client uses these tokens to access resources on a resource server to perform actions, such as retriving transaction history and setting up payments, on behalf of a user or system.

Grant Negotiation and Authorization Protocol (GNAP)

The Grant Negotiation Authorization Protocol (GNAP) defines a mechanism for delegating authorization to a piece of software, and conveying the results and artifacts of that delegation to the software. This delegation can include access to a set of APIs as well as subject information passed directly to the software. For more information, see the specification.

Incoming payment resource

An incoming payment resource is an object created by the recipient’s ASE, on their resource server, that represents a payment being received by an entity. This resource contains information about the incoming payment, such as the amount, currency, receiver’s wallet address, and payment status. It is used to track and manage payments that are expected to or have been received.

Open Payments (OP)

Open Payments is an open RESTful API and an API standard that enables clients to interface with Open Payments-enabled accounts.

Outgoing payment resource

An outgoing payment resource is an object created by the sender’s ASE, on their resource server, that represents a payment being sent by an entity. This resource contains information about the outgoing payment, such as the amount, currency, receiver’s wallet address, and payment status. Outgoing payment resources require explicit consent from the sender before the resource can be created.

Quote resource

A quote resource is an object created by the sender’s ASE, on their resource server, after the incoming payment resource is created by the recipient’s ASE. A quote resource represents a potential payment being received by an entity and contains information about the potential payment, but is mainly used to indicate the total cost, including any applicable fees, to make the payment. The quote resource also serves as a commitment from the sender’s ASE to deliver a particular amount to the receiver’s ASE and it only valid for a limited time.

Resource server (RS)

A resource server hosts protected resources and enforces access controls based on the tokens provided by the authorization server. In the context of Open Payments, the resource server manages access to three payment-related resources (incoming-payment, quote, and outgoing-payment), ensuring that only authorized clients can perform actions through the Open Payments APIs.