taler-docs

commit ca5a81e94c7c148f55841c38fcb69a3008310ec2
parent 2e186a67bd60a775fa8028a917db2057112b0665
Author: Florian Dold <dold@taler.net>
Date:   Mon, 17 Aug 2026 18:57:38 +0200

merchant API: specify order expiration filter

Diffstat:
M
core/merchant/get-private-orders.rst
 | 
5
+++++

1 file changed, 5 insertions(+), 0 deletions(-)
diff --git a/core/merchant/get-private-orders.rst b/core/merchant/get-private-orders.rst
@@ -14,6 +14,7 @@
   :query paid: *Optional*. If set to yes, only return paid orders, if no only unpaid orders. Do not give (or use "all") to see all orders regardless of payment status.
   :query refunded: *Optional*. If set to yes, only return refunded orders, if no only unrefunded orders. Do not give (or use "all") to see all orders regardless of refund status.
   :query wired: *Optional*. If set to yes, only return wired orders, if no only orders with missing wire transfers. Do not give (or use "all") to see all orders regardless of wire transfer status.
+  :query expired: *Optional*. If set to yes, only return expired orders, if no exclude expired orders. Do not give (or use "all") to see all orders regardless of expiration status. An order is expired if it is unpaid and its payment deadline is strictly before the merchant backend's current time. Paid orders are never considered expired. This filter is combined conjunctively with all other filters. Since protocol **v37**.
   :query delta: *Optional*. takes value of the form ``N (-N)``, so that at most ``N`` values strictly older (younger) than ``start`` and ``date_s`` are returned.  Defaults to ``-20`` to return the last 20 entries (before ``start`` and/or ``date_s``).  Deprecated in protocol **v12**. Use *limit* instead.
   :query limit: *Optional*. At most return the given number of results. Negative for descending by row ID, positive for ascending by row ID. Default is ``20``.  Since protocol **v12**.
   :query date_s: *Optional.* Non-negative date in seconds after the UNIX Epoc. Only return orders created after the specified timestamp.
@@ -74,6 +75,10 @@
       // When the order was created.
       timestamp: Timestamp;
 
+      // Deadline by which the order must be paid.
+      // Since protocol **v37**.
+      pay_deadline: Timestamp;
+
       // The amount of money the order is for. If the contract
       // has multiple choices and the user has not yet made a choice,
       // we return the amount of the first choice.