getDefaultExchangesread-onlydeprecated

This operation is deprecated. Use listWithdrawalExchangeCandidates instead.

List the default exchanges offered to the user for withdrawing.

Request:

The request arguments must be a GetDefaultExchangesRequest object, as for listWithdrawalExchangeCandidates.

Response:

On success, the result is a GetDefaultExchangesResponse object.

Expected errors:

The caller can handle the following errors inline: WALLET_CORE_API_BAD_REQUEST.

Details:

The result is a reduced view of the withdrawal exchange candidates, carrying only the withdrawal URI, currency and currency specification of each candidate.

interface GetDefaultExchangesRequest {
  // Only return production exchanges from the builtin exchange list.
  // Cannot be combined with withBuiltin: false.
  presetOnly?: boolean;

  // Include exchanges from the builtin list.  Defaults to true.
  withBuiltin?: boolean;

  // Include demo exchanges from the builtin list.  Defaults to false.
  withDemo?: boolean;

  // Include test exchanges from the builtin list.  Defaults to false.
  withTest?: boolean;
}

interface GetDefaultExchangesResponse {
  defaultExchanges: {
    // A taler://withdraw-exchange URI for the exchange.
    talerUri: string;

    // Currency offered by the exchange.
    currency: string;

    // Currency spec for the currency offered by the exchange.
    currencySpec: CurrencySpecification;
  }[];
}