16.11.7. Taler Account Directory API

This chapter describes the account discovery API that wallets or other clients can use to help the user find their payto URI.

GET /config

Return the protocol version and configuration information about the bank. This specification corresponds to current protocol being v1.

Response:

200 OK:

The exchange responds with a AccountDirectoryConfig object. This request should virtually always be successful.

Details:

interface AccountDirectoryConfig {
  // Name of the API.
  name: "taler-bank-account-directory";

  // libtool-style representation of the Bank protocol version, see
  // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
  //
  // The format is "current:revision:age".
  version: string;

  // URN of the implementation (needed to interpret 'revision' in version).
  implementation: string;
}

GET /search

Search for user accounts from user query.

Request:

Query Parameters:

• keywords – Textual search keywords. The fields matched depends on the bank. It can be a name, a login or any other identifier.

Response:

200 OK:

Response is a Accounts.

204 No content:

No accounts match this query.

Details:

interface Accounts {
  accounts: Account[];
}

interface Account {
  // Formatted user information to be displayed.
  display: string;

  // Full payto URI of this bank account.
  payto_uri: string;
}