[GNUnet-SVN] [taler-docs] branch master updated (88cea0c -> a522114)

[gnunet]

This is an automated email from the git hooks/post-receive script.

dold pushed a change to branch master
in repository docs.

    from 88cea0c  onboarding minor fixes
     new 971a47b  ignore cf doc
     new 9e13066  no more trigger pay api
     new a522114  merge refund status into public pay query

The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 conf.py               |   2 +-
 core/api-merchant.rst | 100 +++++++++++++++++++++++++++-----------------------
 2 files changed, 56 insertions(+), 46 deletions(-)

diff --git a/conf.py b/conf.py
index de69de0..7b1267a 100644
--- a/conf.py
+++ b/conf.py
@@ -95,7 +95,7 @@ release = '0.6.0pre1'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', '_exts']
+exclude_patterns = ['_build', '_exts', 'cf']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 9eb6981..6c60c09 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -23,6 +23,8 @@
 Merchant Backend API
 ====================
 
+.. contents:: Table of Contents
+
 ------------------
 Receiving Payments
 ------------------
@@ -33,7 +35,7 @@ Receiving Payments
 
   Create a new order that a customer can pay for.
 
-  This request is not idempotent unless an `order_id` is explicitly specified.
+  This request is **not** idempotent unless an `order_id` is explicitly 
specified.
 
   .. note::
 
@@ -1078,6 +1080,58 @@ both by the user's browser and their wallet.
     }
 
 
+.. http:get:: /public/pay
+
+  Query the payment status of an order.
+
+  **Request**
+
+  :query hc: hash of the order's contract terms
+
+  **Response**
+
+  :status 200 OK:
+    The response is a `PublicPayStatusResponse`_.
+
+
+  .. _PublicPayStatusResponse:
+  .. code-block:: tsref
+
+    interface PublicPayStatusResponse {
+      // Has the payment for this order been completed?
+      paid: boolean;
+
+      // Refunds for this payment, if any.
+      refunds: RefundInfo[];
+    }
+
+
+  .. _RefundInfo:
+  .. _tsref-type-RefundInfo:
+  .. code-block:: tsref
+
+    interface RefundInfo {
+
+      // Coin from which the refund is going to be taken
+      coin_pub: EddsaPublicKey;
+
+      // Refund amount taken from coin_pub
+      refund_amount: Amount;
+
+      // Refund fee
+      refund_fee: Amount;
+
+      // Identificator of the refund
+      rtransaction_id: number;
+
+      // Merchant public key
+      merchant_pub: EddsaPublicKey
+
+      // Merchant signature of a TALER_RefundRequestPS object
+      merchant_sig: EddsaSignature;
+    }
+
+
 .. http:get:: /public/proposal
 
   Retrieve and take ownership (via nonce) over a proposal.
@@ -1148,47 +1202,3 @@ both by the user's browser and their wallet.
       // The order of the signatures matches the planchets list.
       reserve_sigs: EddsaSignature[];
     }
-
-
-.. http:get:: /public/refund
-
-  Pick up refunds for an order.
-
-  **Request**
-
-  :query instance: the merchant instance issuing the request
-  :query order_id: the order id whose refund situation is being queried
-
-  **Response**
-
-  If case of success, an *array of* `RefundLookup`_ objects is returned.
-
-  .. _RefundLookup:
-  .. code-block:: tsref
-
-    interface RefundLookup {
-
-      // Coin from which the refund is going to be taken
-      coin_pub: EddsaPublicKey;
-
-      // Refund amount taken from coin_pub
-      refund_amount: Amount;
-
-      // Refund fee
-      refund_fee: Amount;
-
-      // Identificator of the refund
-      rtransaction_id: number;
-
-      // Merchant public key
-      merchant_pub: EddsaPublicKey
-
-      // Merchant signature of a TALER_RefundRequestPS object
-      merchant_sig: EddsaSignature;
-    }
-
-
-.. http:get:: /public/trigger-pay
-
-  Used to trigger processing of payments, refunds and tips in the browser.  
The exact behavior
-  can be dependent on the user's browser.

-- 
To stop receiving notification emails like this one, please contact
address@hidden.