taler-docs

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

get-private-accounts.rst (1156B)

      1 .. http:get:: [/instances/$INSTANCE]/private/accounts
      2 
      3   This is used to return the list of all the bank accounts
      4   of an instance.
      5 
      6   **Required permission:** ``accounts-read``
      7 
      8   **Response:**
      9 
     10   :http:statuscode:`200 OK`:
     11     The backend has successfully returned all the accounts. Returns a `AccountsSummaryResponse`.
     12   :http:statuscode:`404 Not found`:
     13     The backend has does not know about the instance.
     14     Returned with ``TALER_EC_MERCHANT_GENERIC_INSTANCE_UNKNOWN``.
     15   :http:statuscode:`500 Internal Server Error`:
     16     The server experienced an internal failure.
     17     Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: AccountsSummaryResponse
     22 
     23     interface AccountsSummaryResponse {
     24 
     25       // List of accounts that are known for the instance.
     26       accounts: BankAccountEntry[];
     27     }
     28 
     29   .. ts:def:: BankAccountEntry
     30 
     31     interface BankAccountEntry {
     32 
     33       // Full payto:// URI of the account.
     34       payto_uri: string;
     35 
     36       // Hash over the wire details (including over the salt).
     37       h_wire: HashCode;
     38 
     39       // true if this account is active,
     40       // false if it is historic.
     41       active: boolean;
     42     }