commit 69bcca030ed79837b74f2fce16a9aeadf9623f29
parent 4573bd12bc1c4d1cf27afac63c312f0b276c58bc
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 9 Nov 2025 21:46:22 +0100
clarify refund_delay (#10564)
Diffstat:
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -3371,9 +3371,12 @@ Creating orders
// order detail, but can override all.
order: Order;
- // If set, the backend will then set the refund deadline to the current
- // time plus the specified delay. If it's not set, refunds will not be
- // possible.
+ // If set, the backend will then set the refund deadline to the
+ // payment deadline plus the specified delay.
+ // If it's not set, the default value of the backend might be
+ // used. Note that both this value and the backend default
+ // will be ignored if ``refund_deadline`` is set in ``order``
+ // as the ``refund_deadline`` takes precedence.
refund_delay?: RelativeTime;
// Specifies the payment target preferred by the client. Can be used