commit b8d08792ca8c1cda50f965ee9b7a6981fee316fe
parent 1b404c2d1f5ec16dbca30e245d51a91e136ddcc6
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Sat, 16 Dec 2023 09:43:09 +0800
update protocol specification for v6
Diffstat:
1 file changed, 8 insertions(+), 0 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -121,6 +121,7 @@ such as the implemented version of the protocol and the currency used.
.. http:get:: /config
Return the protocol version and currency supported by this merchant backend.
+ This specification corresponds to ``current`` protocol being version **6**.
**Response:**
@@ -2005,6 +2006,11 @@ Creating orders
// to select among the various (active) wire methods supported by the instance.
payment_target?: string;
+ // The session for which the payment is made (or replayed).
+ // Only set for session-based payments.
+ // Since protocol v6.
+ session_id?: string;
+
// Specifies that some products are to be included in the
// order from the inventory. For these inventory management
// is performed (so the products must be in stock) and
@@ -2132,6 +2138,8 @@ Inspecting orders
:query date_s: *Optional.* Non-negative date in seconds after the UNIX Epoc, see ``delta`` for its interpretation. If not specified, we default to the oldest or most recent entry, depending on ``delta``.
:query start: *Optional*. Row number threshold, see ``delta`` for its interpretation. Defaults to ``INT64_MAX``, namely the biggest row id possible in the database.
:query timeout_ms: *Optional*. Timeout in milliseconds to wait for additional orders if the answer would otherwise be negative (long polling). Only useful if delta is positive. Note that the merchant MAY still return a response that contains fewer than ``delta`` orders.
+ :query session_id: *Optional*. Since protocol v6. Filters by session ID.
+ :query fulfillment_url: *Optional*. Since protocol v6. Filters by fulfillment URL.
**Response:**