taler-docs

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

remove-global-currency-exchange.rst (790B)

      1 .. ts:op:: removeGlobalCurrencyExchange
      2 
      3   Remove an exchange registered for a global currency.
      4 
      5   **Request:**
      6 
      7     The request must be a `RemoveGlobalCurrencyExchangeRequest`
      8     object.
      9 
     10   **Response:**
     11 
     12     On success, the result is an empty object (`EmptyObject`).
     13 
     14   **Side effects:**
     15 
     16     Removes the registration from the wallet's database; removing
     17     the last exchange of a currency also removes the global
     18     currency information.  When the configuration changed, a
     19     ``balance-change`` notification is emitted.
     20 
     21   **Details:**
     22 
     23     Removing an exchange that is not registered is a no-op.
     24 
     25 .. ts:def:: RemoveGlobalCurrencyExchangeRequest
     26 
     27   interface RemoveGlobalCurrencyExchangeRequest {
     28     currency: string;
     29     exchangeBaseUrl: string;
     30     exchangeMasterPub: string;
     31   }