deleteExchange

Delete an exchange and its associated resources.

Request:

The request arguments must be a DeleteExchangeRequest object.

Response:

On success, the result is an empty object.

Side effects:

Deletes the exchange and its associated resources.

Expected errors:

The caller can handle the following errors inline: WALLET_EXCHANGE_ENTRY_USED.

Details:

The operation fails with WALLET_EXCHANGE_ENTRY_USED when the exchange still has associated resources (see getExchangeResources), unless purge is set. Some transactions related to the exchange (payments, peer payments and refreshes) are kept even when purging. Deleting an exchange that is not known to the wallet succeeds silently.

interface DeleteExchangeRequest {
  exchangeBaseUrl: string;

  // Delete the exchange even if it's in use.
  purge?: boolean;
}