taler-docs

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

list-exchanges.rst (997B)

      1 .. ts:op:: listExchanges
      2   :read-only:
      3 
      4   List exchanges known to the wallet.
      5 
      6   **Request:**
      7 
      8   The request arguments must be a `ListExchangesRequest` object.
      9   Omitted filter fields do not restrict the result.
     10 
     11   **Response:**
     12 
     13   On success, the result is an `ExchangesListResponse` object.
     14 
     15 .. ts:def:: ListExchangesRequest
     16 
     17   interface ListExchangesRequest {
     18     // Filter results to only include exchanges in the given scope.
     19     filterByScope?: ScopeInfo;
     20 
     21     // Filter results to only include exchanges
     22     // with the given status.
     23     filterByExchangeEntryStatus?: ExchangeEntryStatus;
     24 
     25     // Filter results to only include exchanges with the
     26     // given type.
     27     filterByType?: ExchangeType;
     28   }
     29 
     30 .. ts:def:: ExchangeType
     31 
     32   type ExchangeType = "demo" | "prod";
     33 
     34 .. ts:def:: ExchangesListResponse
     35 
     36   interface ExchangesListResponse {
     37     exchanges: ExchangeListItem[];
     38   }
     39 
     40 .. ts:def:: ExchangeEntryStatus
     41 
     42   type ExchangeEntryStatus =
     43     | "preset"
     44     | "ephemeral"
     45     | "used";