taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-public-accounts.rst (1669B)

      1 .. http:get:: /public-accounts
      2 
      3   Show those accounts whose histories are publicly visible.  For example,
      4   accounts from donation receivers.  As such, this request is unauthenticated.
      5 
      6   **Request:**
      7 
      8   :query limit: *Optional.*
      9     At most return the given number of results. Negative for descending by ``row_id``, positive for ascending by ``row_id``. Defaults to ``-20``. Since **v5**.
     10   :query offset: *Optional.*
     11     Starting ``row_id`` for :ref:`pagination <row-id-pagination>`. Since **v5**.
     12   :query filter_name: *Optional.*
     13     Pattern to filter on the account's legal name.  Given
     14     the filter 'foo', all the results will **contain**
     15     'foo' in their legal name.  Without this option,
     16     all the existing accounts are returned.
     17   :query delta: *Optional.*
     18     Deprecated since **v5**. Use *limit* instead.
     19   :query start: *Optional.*
     20     Deprecated since **v5**. Use *offset* instead.
     21 
     22   **Response:**
     23 
     24   :http:statuscode:`200 OK`:
     25     Response is a `PublicAccountsResponse`.
     26   :http:statuscode:`204 No content`:
     27     No public account.
     28 
     29   **Details:**
     30 
     31   .. ts:def:: PublicAccountsResponse
     32 
     33     interface PublicAccountsResponse {
     34       public_accounts: PublicAccount[];
     35     }
     36 
     37   .. ts:def:: PublicAccount
     38 
     39     interface PublicAccount {
     40       // Username of the account
     41       username: string;
     42 
     43       // Full payto URI of this bank account.
     44       payto_uri: string;
     45 
     46       // Current balance of the account
     47       balance: Balance;
     48 
     49       // Is this a taler exchange account?
     50       is_taler_exchange: boolean;
     51 
     52       // Opaque unique ID used for pagination.
     53       // @since **v4**, will become mandatory in the next version.
     54       row_id?: Integer;
     55     }