taler-docs

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

get-aml-OFFICER_PUB-wallet-credit.rst (2024B)

      1 .. http:get:: /aml/$OFFICER_PUB/wallet-credit
      2 
      3   Obtain a wallet's P2P incoming history data. Shows effective
      4   merges into a wallet (credit).  Note that requests for
      5   payments that were not paid by the other party are not shown.
      6 
      7   The endpoint was introduced in protocol **v37**.
      8 
      9   **Request:**
     10 
     11   *Taler-AML-Officer-Signature*:
     12     The client must provide Base-32 encoded EdDSA signature with
     13     ``$OFFICER_PRIV``, affirming the desire to obtain AML data.  Note that
     14     this is merely a simple authentication mechanism, the details of the
     15     request are not protected by the signature.
     16 
     17   :query threshold:
     18     *Optional*. minimum amount ("CURRENCY:VAL.FRAC") to return. All amounts
     19     below the given threshold will be filtered.
     20   :query limit:
     21     *Optional*. takes value of the form ``N (-N)``, so that at
     22     most ``N`` values strictly older (younger) than ``start`` are returned.
     23     Defaults to ``-20`` to return the last 20 entries (before ``start``).
     24   :query offset:
     25     *Optional*. Row number threshold, see ``delta`` for its
     26     interpretation.  Defaults to ``INT64_MAX``, namely the biggest row id
     27     possible in the database.
     28   :query h_payto:
     29     *Optional*. Account selector using the *normalized* payto URI
     30     of the wallet.  Information for all wallets is returned if this
     31     filter is absent, otherwise only transactions for this wallet.
     32     @since protocol **v29**.
     33 
     34   **Response:**
     35 
     36   :http:statuscode:`200 OK`:
     37     The responds will be an `ExchangeTransferList` message.
     38   :http:statuscode:`204 No content`:
     39     There are no matching transactions.
     40   :http:statuscode:`403 Forbidden`:
     41     The signature is invalid.
     42   :http:statuscode:`404 Not found`:
     43     The designated AML account is not known.
     44   :http:statuscode:`409 Conflict`:
     45     The designated AML account is not enabled.
     46   :http:statuscode:`500 Internal Server Error`:
     47     The server experienced an internal error.
     48     This response comes with a standard `ErrorDetail` response with
     49     a code of ``TALER_EC_GENERIC_DB_FETCH_FAILED``.