diff options
-rw-r--r-- | taler-wallet.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst index dd6da11f..f4dc611b 100644 --- a/taler-wallet.rst +++ b/taler-wallet.rst @@ -843,6 +843,53 @@ Confirm Payment | ConfirmPayResultDone; | ConfirmPayResultPending; +Tipping API Calls +----------------- + +Preparing a tip +~~~~~~~~~~~~~~~ + +:Name: ``"prepareTip"`` +:Description: + Prepare for accepting a tip based in a taler://tip URI +:Request: + .. ts:def:: PrepareTipRequest + + interface PrepareTipRequest { + talerTipUri: string; + } +:Response: + .. ts:def:: PrepareTipResult + + interface PrepareTipResult { + // Unique ID for the tip assigned by the wallet. + // Typically different from the merchant-generated tip ID. + walletTipId: string; + + // Has the tip already been accepted? + accepted: boolean; + tipAmountRaw: AmountString; + tipAmountEffective: AmountString; + exchangeBaseUrl: string; + expirationTimestamp: Timestamp; + } + + +Accepting a tip +~~~~~~~~~~~~~~~ + +:Name: ``"acceptTip"`` +:Description: + Prepare for accepting a tip based in a taler://tip URI +:Request: + .. ts:def:: AcceptTipRequest + + interface AcceptTipRequest { + walletTipId: string; + } +:Response: + On success, the response is an empty object. + Testing API calls ----------------- |