taler-docs

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

get-aml-OFFICER_PUB-transfers-credit.rst (2875B)

      1 .. http:get:: /aml/$OFFICER_PUB/transfers-credit
      2 .. http:get:: /aml/$OFFICER_PUB/transfers-debit
      3 .. http:get:: /aml/$OFFICER_PUB/transfers-kycauth
      4 
      5   Obtain exchange's bank account wire transfer history data. Shows effective
      6   incoming wire transfers (credit), incoming wire transfers for KYC
      7   authorization (kycauth), or effective outgoing (aggregated, closed)
      8   wire transfers (debit).  Note that bounced incoming
      9   wire transfers and drain outgoing wire transfers requests are excluded (as
     10   they are not relevant for AML processes and would just distract). The
     11   wire transfer subject is also not given as in all cases it will just
     12   be some cryptographic data that is meaningless for humans.
     13 
     14   The first two endpoints were introduced in protocol **v25**.
     15   ``transfers-kycauth`` was added in protocol **v29**.
     16 
     17   **Request:**
     18 
     19   *Taler-AML-Officer-Signature*:
     20     The client must provide Base-32 encoded EdDSA signature with
     21     ``$OFFICER_PRIV``, affirming the desire to obtain AML data.  Note that
     22     this is merely a simple authentication mechanism, the details of the
     23     request are not protected by the signature.
     24 
     25   :query threshold:
     26     *Optional*. minimum amount ("CURRENCY:VAL.FRAC") to return. All amounts
     27     below the given threshold will be filtered.
     28   :query limit:
     29     *Optional*. takes value of the form ``N (-N)``, so that at
     30     most ``N`` values strictly older (younger) than ``start`` are returned.
     31     Defaults to ``-20`` to return the last 20 entries (before ``start``).
     32   :query offset:
     33     *Optional*. Row number threshold, see ``delta`` for its
     34     interpretation.  Defaults to ``INT64_MAX``, namely the biggest row id
     35     possible in the database.
     36   :query h_payto:
     37     *Optional*. Account selector using the *normalized* payto URI.
     38     Information for all accounts is returned if this
     39     filter is absent, otherwise only transactions for this account.
     40     @since protocol **v29**.
     41 
     42   **Response:**
     43 
     44   :http:statuscode:`200 OK`:
     45     The responds will be an `ExchangeTransferList` message.
     46   :http:statuscode:`204 No content`:
     47     There are no matching transactions.
     48   :http:statuscode:`403 Forbidden`:
     49     The signature is invalid.
     50   :http:statuscode:`404 Not found`:
     51     The designated AML account is not known.
     52   :http:statuscode:`409 Conflict`:
     53     The designated AML account is not enabled.
     54 
     55   .. ts:def:: ExchangeTransferList
     56 
     57     interface ExchangeTransferList {
     58 
     59       // Matching transaction of the exchange
     60       transfers: ExchangeTransferListEntry[];
     61 
     62     }
     63 
     64   .. ts:def:: ExchangeTransferListEntry
     65 
     66     interface ExchangeTransferListEntry {
     67 
     68       // Row ID of the record.  Used to filter by offset.
     69       rowid: Integer;
     70 
     71       // payto://-URI of the other account.
     72       payto_uri: string;
     73 
     74       // The amount involved.
     75       amount: Amount;
     76 
     77       // Time when the transfer was made
     78       execution_time: Timestamp;
     79 
     80     }