taler-docs

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

convert-deposit-amount.rst (1070B)

      1 .. ts:op:: convertDepositAmount
      2   :read-only:
      3   :deprecated:
      4 
      5   This operation is **deprecated**.  Use :ts:op:`checkDeposit` for a
      6   concrete instructed amount, or :ts:op:`getMaxDepositAmount` to query
      7   deposit limits.
      8 
      9   Compute the effective and raw amounts for a deposit of the given
     10   instructed amount, based on the coins currently available in the
     11   wallet.  The ``type`` field (`TransactionAmountMode`) selects whether
     12   ``amount`` is interpreted as an effective or as a raw amount.
     13 
     14   **Request:**
     15 
     16   The request body must be a `ConvertAmountRequest` object.
     17 
     18   **Response:**
     19 
     20   On success, the result is an `AmountResponse` object.
     21 
     22 .. ts:def:: ConvertAmountRequest
     23 
     24   // Deprecated: use CheckDepositRequest for a concrete instructed
     25   // amount, or GetMaxDepositAmountRequest to query deposit limits.
     26   interface ConvertAmountRequest {
     27     amount: AmountString;
     28     type: TransactionAmountMode;
     29     depositPaytoUri: PaytoString;
     30   }
     31 
     32 .. ts:def:: AmountResponse
     33 
     34   interface AmountResponse {
     35     effectiveAmount: AmountString;
     36     rawAmount: AmountString;
     37   }