diff options
Diffstat (limited to 'core/taler-uri.rst')
| -rw-r--r-- | core/taler-uri.rst | 45 |
1 files changed, 22 insertions, 23 deletions
diff --git a/core/taler-uri.rst b/core/taler-uri.rst index 23ebc1ed..a4942b83 100644 --- a/core/taler-uri.rst +++ b/core/taler-uri.rst @@ -28,34 +28,34 @@ Payments are requested with the ``pay`` action. The parameters are a hierarchic taler://pay/{merchant_host}{/merchant_prefix_path*}/{order_id}/{session_id}{?c}{#ssid} -* ``merchant_host`` is the hostname (and optionally port) of the merchant +* ``merchant_host`` is the hostname (and optionally port) of the merchant. * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. -* ``order_id`` is the order ID that the customer is asked to pay for -* ``session_id`` is the optional session ID under which the payment takes place -* ``c`` is the optional high-entropy order `ClaimToken` -* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity +* ``order_id`` is the order ID that the customer is asked to pay for. +* ``session_id`` is the optional session ID under which the payment takes place. +* ``c`` is the optional high-entropy order `ClaimToken`. +* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity. Examples: .. code:: none # Example 1: - # Order ID "ORD123", no session ID - # Merchant backend base URL "https://backend.test.taler.net/ + # Order ID "ORD123", no session ID. + # Merchant backend base URL https://backend.test.taler.net/ taler://pay/test.taler.net/ORD123/ # Example 2: - # Order ID "ORD123", no session ID - # Merchant backend base URL "https://backend.test.taler.net/instances/x1/ + # Order ID "ORD123", no session ID. + # Merchant backend base URL https://backend.test.taler.net/instances/x1/ taler://pay/test.taler.net/instances/x1/ORD123/ # Example 3: - # Order ID "ORD123", session ID "ABC123" - # Merchant backend base URL "https://backend.test.taler.net/ + # Order ID "ORD123", session ID "ABC123". + # Merchant backend base URL https://backend.test.taler.net/ taler://pay/test.taler.net/ORD123/ABC123 # INVALID Example 1: - # When no session ID is given, the slash must still be present + # When no session ID is given, the slash must still be present. taler://pay/test.taler.net/ORD123 ------------------------ @@ -68,11 +68,11 @@ The action ``withdraw`` is used to trigger a bank-integrated withdrawal operatio taler://withdraw/{bank_host}{/bank_prefix_path*}/{withdrawal_uid}{#ssid} -* ``bank_host`` is the hostname of the merchant +* ``bank_host`` is the hostname of the merchant. * ``bank_prefix_path`` is an optional list of path components that identifies the path prefix of the bank integration API base URL. -* ``withdrawal_uid`` is the unique ID of the withdrawal operation +* ``withdrawal_uid`` is the unique ID of the withdrawal operation. * ``ssid`` is the optional WLAN SSID that the bank (typically in an ATM scenario) can offer the wallet - to connect to for internet connectivity + to connect to for internet connectivity. -------------------------- Withdrawing (Confirmation) @@ -84,7 +84,7 @@ Withdrawing (Confirmation) This action notifies the wallet that the status of a reserve has changed. It is used by the bank to indicate that the withdrawal has been confirmed by the user (e.g. via 2FA / mTAN / ...). -The wallet the re-checks the status of all unconfirmed reserves. +The wallet then re-checks the status of all unconfirmed reserves. Optionally, ``reserve_pub`` can be specified to also indicate the reserve that has been updated. @@ -101,10 +101,10 @@ A ``taler://refund`` URI instructs the wallet to download and apply available re taler://refund/{merchant_host}{/merchant_prefix_path*}/{order_id}/{#ssid} taler+http://refund/{merchant_host}{/merchant_prefix_path*}/{order_id}/{#ssid} -* ``merchant_host`` is the hostname of the merchant +* ``merchant_host`` is the hostname of the merchant. * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. -* ``order_id`` is the order ID to check for refunds -* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity +* ``order_id`` is the order ID to check for refunds. +* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity. ------- @@ -118,12 +118,12 @@ a merchant and ask the user to accept/decline it. taler://tip/{merchant_host}{/merchant_prefix_path*}/{tip_id}/{#ssid} -* ``merchant_host`` is the hostname of the merchant +* ``merchant_host`` is the hostname of the merchant. * ``merchant_prefix_path`` is an optional list of path components that identifies the path prefix of the merchant base URL. -* ``tip_id`` uniquely identifies the tip +* ``tip_id`` uniquely identifies the tip. * ``insecure`` is an optional query parameter. When "1", the ``merchant_host`` is contacted via HTTP. When absent or "0", the ``merchant_host`` is contacted via HTTPS. -* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity +* ``ssid`` is the optional WLAN SSID that the merchant can offer the wallet to connect to for internet connectivity. ---------------- @@ -147,4 +147,3 @@ the user to confirm/decline adding the auditor to the list of trusted auditors. .. code:: none taler://auditor/{auditor_host}{/auditor_prefix_path*}/ - |