getMaxPeerPushDebitAmountread-only

Query the maximum amount that can currently be sent via a peer push payment in the given currency.

Request:

The request body must be a GetMaxPeerPushDebitAmountRequest object.

Response:

On success, the result is a GetMaxPeerPushDebitAmountResponse object.

Details:

The result is the best per-exchange maximum across the exchanges known to the wallet for the currency (restricted to restrictScope when given, and including the expected outputs of pending refresh operations). effectiveAmount is the total balance effect on the wallet and rawAmount the amount the receiver would get after fees. When no exchange can serve the payment, zero amounts are returned and exchangeBaseUrl is omitted.

interface GetMaxPeerPushDebitAmountRequest {
  currency: string;

  // Preferred exchange to use for the p2p payment.
  // Currently ignored by wallet-core; use restrictScope
  // to constrain the exchanges that are considered.
  exchangeBaseUrl?: string;

  restrictScope?: ScopeInfo;
}

interface GetMaxPeerPushDebitAmountResponse {
  effectiveAmount: AmountString;
  rawAmount: AmountString;
  exchangeBaseUrl?: string;
}