taler-docs

commit b5cfd5ddc9399ce44ea665afdea023bd60ba1c98
parent 39b3196bfe3fc4e7dddf0c2e46a80fd355db8071
Author: Christian Grothoff <christian@grothoff.org>
Date:   Tue, 25 Apr 2023 23:54:50 +0200

return refund status as part of /paid endpoint

Diffstat:
M
core/api-merchant.rst
 | 
15
+++++++++++++--

1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -457,10 +457,10 @@ again.
 
   **Response:**
 
-  :http:statuscode:`204 No content`:
+  :http:statuscode:`200 Ok`:
     The merchant accepted the signature.
     The ``frontend`` should now fulfill the contract.
-    Note that it is possible that refunds have been granted.
+    Note that it is possible that refunds have been granted.  Response is of type `PaidRefundStatusResponse`.
   :http:statuscode:`400 Bad request`:
     Either the client request is malformed or some specific processing error
     happened that may be the fault of the client as detailed in the JSON body
@@ -471,6 +471,17 @@ again.
     The merchant backend could not find the order or the instance
     and thus cannot process the request.
 
+  **Details**:
+
+  .. ts:def:: PaidRefundStatusResponse
+
+    interface PaidRefundStatusResponse {
+
+      // True if the order has been subjected to
+      // refunds. False if it was simply paid.
+      refunded: boolean;
+    }
+
   .. ts:def:: PaidRequest
 
     interface PaidRequest {