Get a Wallet Address
GET /
Retrieve the public information of the Wallet Address.
This end-point 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
Section titled “ Responses ”Wallet Address Found
A wallet address resource is the root of the API and contains the public details of the financial account represented by the Wallet Address that is also the service endpoint URL.
object
The URL identifying the wallet address.
A public name for the account. This should be set by the account holder with their provider to provide a hint to counterparties as to the identity of the account holder.
The assetCode is a code that indicates the underlying asset. An ISO4217 currency code should be used whenever possible. The ISO4217 representation of the US Dollar is USD.
The number of decimal places that defines the scale of the smallest divisible unit for the given asset code. It determines how an integer amount is scaled to derive the actual monetary value. For example, USD has an asset scale of 2 with the smallest unit being 0.01. An integer amount of 1000 with an assetCode of USD and assetScale of 2 translates to $10.00.
The URL of the authorization server endpoint for getting grants and access tokens for this wallet address.
The URL of the resource server endpoint for performing Open Payments with this wallet address.
Examples
{ "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"}If the Accept header is text/html in the request, the server may choose to redirect to an HTML page for the given wallet address.
Headers
Section titled “Headers ”The URL of the wallet address webpage.
Wallet Address Not Found