taler-docs

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

get-accounts-USERNAME-transactions.rst (1448B)

      1 .. http:get:: /accounts/$USERNAME/transactions
      2 
      3   Retrieve a subset of transactions related to $USERNAME.
      4 
      5   **Request:**
      6 
      7   :query limit: *Optional.*
      8     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**.
      9   :query offset: *Optional.*
     10     Starting ``row_id`` for :ref:`pagination <row-id-pagination>`. Since **v5**.
     11   :query timeout_ms: *Optional.*
     12     Timeout in milliseconds, for :ref:`long-polling <long-polling>`, to wait for at least one element to be shown. Only useful if *limit* is positive. Since protocol **v5**.
     13   :query delta: *Optional.*
     14     Deprecated since **v5**. Use *limit* instead.
     15   :query start: *Optional.*
     16     Deprecated since **v5**. Use *offset* instead.
     17   :query long_poll_ms: *Optional.*
     18     Deprecated since **v5**. Use *timeout_ms* instead.
     19 
     20   **Response:**
     21 
     22   :http:statuscode:`200 OK`:
     23     The bank responds with an `BankAccountTransactionsResponse` object.
     24   :http:statuscode:`204 No content`:
     25     No transaction found.
     26   :http:statuscode:`401 Unauthorized`:
     27     Invalid or missing credentials.
     28   :http:statuscode:`403 Forbidden`:
     29     Missing rights.
     30   :http:statuscode:`404 Not found`:
     31     The account pointed by ``$USERNAME`` was not found.
     32 
     33   **Details:**
     34 
     35   .. ts:def:: BankAccountTransactionsResponse
     36 
     37     interface BankAccountTransactionsResponse {
     38       transactions: BankAccountTransactionInfo[];
     39     }