taler-docs

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

get-private-accounts.rst (940B)

      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 
     15   **Details:**
     16 
     17   .. ts:def:: AccountsSummaryResponse
     18 
     19     interface AccountsSummaryResponse {
     20 
     21       // List of accounts that are known for the instance.
     22       accounts: BankAccountEntry[];
     23     }
     24 
     25   .. ts:def:: BankAccountEntry
     26 
     27     interface BankAccountEntry {
     28 
     29       // Full payto:// URI of the account.
     30       payto_uri: string;
     31 
     32       // Hash over the wire details (including over the salt).
     33       h_wire: HashCode;
     34 
     35       // true if this account is active,
     36       // false if it is historic.
     37       active: boolean;
     38     }