get-max-peer-push-debit-amount.rst (1364B)
1 .. ts:op:: getMaxPeerPushDebitAmount 2 :read-only: 3 4 Query the maximum amount that can currently be sent via a peer push 5 payment in the given currency. 6 7 **Request:** 8 9 The request body must be a `GetMaxPeerPushDebitAmountRequest` 10 object. 11 12 **Response:** 13 14 On success, the result is a `GetMaxPeerPushDebitAmountResponse` 15 object. 16 17 **Details:** 18 19 The result is the best per-exchange maximum across the exchanges 20 known to the wallet for the currency (restricted to ``restrictScope`` 21 when given, and including the expected outputs of pending refresh 22 operations). ``effectiveAmount`` is the total balance effect on the 23 wallet and ``rawAmount`` the amount the receiver would get after 24 fees. When no exchange can serve the payment, zero amounts are 25 returned and ``exchangeBaseUrl`` is omitted. 26 27 .. ts:def:: GetMaxPeerPushDebitAmountRequest 28 29 interface GetMaxPeerPushDebitAmountRequest { 30 currency: string; 31 32 // Preferred exchange to use for the p2p payment. 33 // Currently ignored by wallet-core; use ``restrictScope`` 34 // to constrain the exchanges that are considered. 35 exchangeBaseUrl?: string; 36 37 restrictScope?: ScopeInfo; 38 } 39 40 .. ts:def:: GetMaxPeerPushDebitAmountResponse 41 42 interface GetMaxPeerPushDebitAmountResponse { 43 effectiveAmount: AmountString; 44 rawAmount: AmountString; 45 exchangeBaseUrl?: string; 46 }