taler-docs

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

check-peer-pull-credit.rst (1351B)

      1 .. ts:op:: checkPeerPullCredit
      2 
      3   Check fees for an outgoing peer pull payment, i.e. a payment request
      4   that this wallet creates for another wallet to pay.
      5 
      6   **Request:**
      7 
      8   The request body must be a `CheckPeerPullCreditRequest` object.
      9   Either ``exchangeBaseUrl`` or ``restrictScope`` must be specified.
     10 
     11   **Response:**
     12 
     13   On success, the result is a `CheckPeerPullCreditResponse` object.
     14 
     15   **Side effects:**
     16 
     17   May refresh the exchange's key material over the network and writes
     18   denomination verification results.
     19 
     20   **Expected errors:**
     21 
     22   The caller can handle the following errors inline:
     23   ``WALLET_NO_SUITABLE_EXCHANGE``, ``WALLET_CORE_API_BAD_REQUEST``.
     24 
     25 .. ts:def:: CheckPeerPullCreditRequest
     26 
     27   interface CheckPeerPullCreditRequest {
     28     // Require using this particular exchange for this operation.
     29     exchangeBaseUrl?: string;
     30 
     31     restrictScope?: ScopeInfo;
     32 
     33     amount: AmountString;
     34 
     35     progressToken?: string;
     36   }
     37 
     38 .. ts:def:: CheckPeerPullCreditResponse
     39 
     40   interface CheckPeerPullCreditResponse {
     41     exchangeBaseUrl: string;
     42     amountRaw: AmountString;
     43     amountEffective: AmountString;
     44 
     45     // Wallet-selected default expiration for the request.
     46     defaultExpiration: TalerProtocolDuration;
     47 
     48     // Number of coins that will be used; can be used by the UI to
     49     // warn if excessively large.
     50     numCoins: number;
     51   }