API docs by Redocly

Open Payments Authorization Server (1.3.0)

Download OpenAPI specification:

E-mail: tech@interledger.org License: Apache-2.0

Open Payments Authorization Server

The authorization server handles grant requests and access token management for the Open Payments protocol, using GNAP (Grant Negotiation and Authorization Protocol).

Endpoints:

  • POST / — initiate a grant request
  • POST /continue/{id} — continue a pending grant request
  • DELETE /continue/{id} — cancel a pending grant request
  • POST /token/{id} — rotate an access token
  • DELETE /token/{id} — revoke an access token

For an overview of how Open Payments authorization works, see the Authorization concepts page.

grant

Grant operations

Grant Request

Make a new grant request

Request Body schema: application/json
required
Any of
required
client (string) or client (object) or client (object) (client)
object (interact-request)

The client instance declares the parameters for interaction methods that it can support using the interact field.

required
object
object (subject)

Information about the subject for which the client is requesting information.

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
Example
{}

Continuation Request

Continue a grant request during or after user interaction.

Authorizations:
GNAP
path Parameters
id
required
string

The unique reference ID of the grant request continuation.

Request Body schema: application/json
interact_ref
string

The interaction reference generated for this interaction by the AS.

Responses

Request samples

Content type
application/json
{
  • "interact_ref": "ad82597c-bbfa-4eb0-b72e-328e005b8689"
}

Response samples

Content type
application/json
Example
{}

Cancel Grant

Cancel a grant request or delete a grant client side.

Authorizations:
GNAP
path Parameters
id
required
string

The unique reference ID of the grant request continuation.

Responses

Response samples

Content type
application/json
Example
{
  • "error": {
    }
}

token

Token operations

Rotate Access Token

Management endpoint to rotate access token.

Authorizations:
GNAP
path Parameters
id
required
string

The unique reference of the access token to be managed.

Responses

Response samples

Content type
application/json
{}

Revoke Access Token

Management endpoint to revoke access token.

Authorizations:
GNAP
path Parameters
id
required
string

The unique reference of the access token to be managed.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}