Wallet Address API (1.3.0)

Download OpenAPI specification:

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

The wallet address server exposes publicly accessible information about an Open Payments wallet address, including basic account details and the cryptographic keys used to verify requests from this wallet address.

Endpoints:

GET / — retrieve public details for a wallet address
GET /jwks.json — retrieve the JSON Web Key Set (JWKS) for a wallet address

For an overview of wallet addresses and how they work in Open Payments, see the Wallet addresses concepts page.

wallet-address

wallet address operations

Get a Wallet Address

Retrieve the public information of the Wallet Address.

This endpoint should be open to anonymous requests as it allows clients to verify a Wallet Address URL and get the basic information required to construct new transactions and discover the grant request URL.

The content should be slow changing and cacheable for long periods. Servers SHOULD use cache control headers.

Responses

Response samples

200

Content type

application/json

{"id": "https://ilp.interledger-test.dev/alice",
"publicName": "Alice",
"assetCode": "USD",
"assetScale": 2,
"authServer": "https://ilp.interledger-test.dev/auth",
"resourceServer": "https://ilp.interledger-test.dev/op"
}

Get the keys bound to a Wallet Address

Retrieve the public keys of the Wallet Address.

Responses

Response samples

200

Content type

application/json

No sample