commit 4e9d7fba3eb253274264e0449036db15635e26f7
parent 3e5e4fa70f72c17ba97f58cf185f63e9a17038d6
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Fri, 4 Aug 2023 10:47:04 +0200
improve docs based on feedback
Diffstat:
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/taler-merchant-api-tutorial.rst b/taler-merchant-api-tutorial.rst
@@ -223,7 +223,7 @@ A minimal Python snippet for creating an order would look like this:
>>> body = dict(order=dict(amount="KUDOS:10",
... summary="Donation",
... fulfillment_url="https://example.com/thanks.html"),
- ... create_token=false)
+ ... create_token=False)
>>> response = requests.post("https://backend.demo.taler.net/private/orders",
... json=body,
... headers={"Authorization": "secret-token:secret"})
@@ -244,14 +244,18 @@ address of the merchant instance. The full details are called the
you must adjust the code to construct the ``taler://pay/`` URI
given below to include the claim token.
-After successfully ``POST``\ ing to ``/private/orders``, an ``order_id`` will be
-returned. Together with the merchant ``instance``, the order id uniquely
-identifies the order within a merchant backend. Using the order ID, you
-can trivially construct the respective ``taler://pay/`` URI that must
-be provided to the wallet. Let ``example.com`` be the domain name where
-the public endpoints of the instance are reachable. The Taler pay URI is
-then simply ``taler://pay/example.com/$ORDER_ID/`` where ``$ORDER_ID``
-must be replaced with the ID of the order that was returned.
+After successfully ``POST``\ ing to ``/private/orders``, a JSON with just an
+``order_id`` field with a string representing the order ID will be returned.
+If you also get a claim token, please double-check that you used the request
+as described above.
+
+Together with the merchant ``instance``, the order id uniquely identifies the
+order within a merchant backend. Using the order ID, you can trivially
+construct the respective ``taler://pay/`` URI that must be provided to the
+wallet. Let ``example.com`` be the domain name where the public endpoints of
+the instance are reachable. The Taler pay URI is then simply
+``taler://pay/example.com/$ORDER_ID/`` where ``$ORDER_ID`` must be replaced
+with the ID of the order that was returned.
You can put the ``taler://`` URI as the target of a link to open the Taler
wallet via the ``taler://`` schema, or put it into a QR code. However, for a
