summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-09-08 19:51:43 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-09-08 19:51:43 +0530
commit14b0748e6813610bd246f3dd574a0df41064cf9b (patch)
treea0bcf7fc5104050b5c2bfedd64383456827a883b /taler-wallet.rst
parentb90c7b24fc95fbd78f834ec7d45760b56b3d8d3f (diff)
downloaddocs-14b0748e6813610bd246f3dd574a0df41064cf9b.tar.gz
docs-14b0748e6813610bd246f3dd574a0df41064cf9b.tar.bz2
docs-14b0748e6813610bd246f3dd574a0df41064cf9b.zip
wallet core tipping API
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index dd6da11..f4dc611 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
-----------------