summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2019-08-26 20:55:53 +0200
committerFlorian Dold <florian.dold@gmail.com>2019-08-26 20:56:01 +0200
commit19762c76466783eaa60ff1be6f75bcdd014c4e65 (patch)
tree8ff8ec813cf0bd02c218579f9f4ffe29fadfef61
parenta401998c5c3ef70408fae9b9fec61b95b45bf639 (diff)
downloaddocs-19762c76466783eaa60ff1be6f75bcdd014c4e65.tar.gz
docs-19762c76466783eaa60ff1be6f75bcdd014c4e65.tar.bz2
docs-19762c76466783eaa60ff1be6f75bcdd014c4e65.zip
taler://pay draft
-rw-r--r--index.rst1
-rw-r--r--taler-uri.rst36
2 files changed, 37 insertions, 0 deletions
diff --git a/index.rst b/index.rst
index e883b58..4ed7407 100644
--- a/index.rst
+++ b/index.rst
@@ -60,6 +60,7 @@ interfaces between the core components of Taler.
api-auditor
api-bank
wireformats
+ taler-uri
---------
Licensing
diff --git a/taler-uri.rst b/taler-uri.rst
new file mode 100644
index 0000000..9165c28
--- /dev/null
+++ b/taler-uri.rst
@@ -0,0 +1,36 @@
+====================
+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
+