summaryrefslogtreecommitdiff
path: root/core/taler-uri.rst
diff options
context:
space:
mode:
Diffstat (limited to 'core/taler-uri.rst')
-rw-r--r--core/taler-uri.rst84
1 files changed, 84 insertions, 0 deletions
diff --git a/core/taler-uri.rst b/core/taler-uri.rst
new file mode 100644
index 0000000..d69b4b0
--- /dev/null
+++ b/core/taler-uri.rst
@@ -0,0 +1,84 @@
+====================
+The taler URI scheme
+====================
+
+The `taler` URI scheme represents actions that are processed by a Taler wallet. The basic syntax is as follows:
+
+.. code:: none
+
+ 'taler://' action '/' params
+
+--------------------
+Requesting a Payment
+--------------------
+
+Payments are requested with the `pay` action. The parameters are a hierarchical identifier for the requested payment:
+
+
+.. code:: none
+
+ 'taler://pay/' merchant-host '/' merchant-query '/' merchant-instance '/' order-id [ '/' session-id ]
+
+The components `merchant-host`, `merchant-query` and `order-id` identify the URL that is used to claim the contract
+for this payment request.
+
+To make the URI shorter (which is important for QR code payments), `-` (minus) can be substituted to get a default value
+for some components:
+
+* the default for `merchant-instance` is `default`
+* the default for `merchant-query` is `/public/proposal`
+
+The following is a minimal example for a payment request from the demo merchant, using the default instance and no session-bound payment:
+
+.. code:: none
+
+ taler://pay/backend.demo.taler.net/-/-/2019.08.26-ABCED
+
+
+-----------
+Withdrawing
+-----------
+
+.. code:: none
+
+ 'taler://withdraw/' bank-host '/' bank-query '/' withdraw-uid
+
+When `bank-query` is `-`, the default `withdraw-operation` will be used.
+
+Example:
+
+.. code:: none
+
+ 'taler://withdraw/bank.taler.net/-/ABDE123
+
+
+-------------------------
+Low-level Reserve Actions
+-------------------------
+
+The following actions are deprecated. They might not be supported
+in newer wallets.
+
+.. code:: none
+
+ 'taler://reserve-create/' reserve-pub
+
+.. code:: none
+
+ 'taler://reserve-confirm/' query
+
+----------------------------
+Special URLs for fulfillment
+----------------------------
+
+The special `fulfillment-success` action can be used in a fulfillment URI to indicate success
+with a message, without directing the user to a website. This is useful in applications that are not Web-based:
+
+When wallets encounter this URI in any other circumstance than going to a fulfillment URL, they must raise an error.
+
+Example:
+
+.. code:: none
+
+ taler://fulfillment-success/Thank+you+for+donating+to+GNUnet
+