summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2024-03-18 23:24:00 +0100
committerChristian Grothoff <christian@grothoff.org>2024-03-18 23:24:00 +0100
commit6f68e4f3f922370763d8bafbbabdc13027c6a04f (patch)
tree867158f5708d96737406e3a57895f5830c7152a6
parentb924e099b65f9578d3012fe5969a4152c303e017 (diff)
downloaddocs-6f68e4f3f922370763d8bafbbabdc13027c6a04f.tar.gz
docs-6f68e4f3f922370763d8bafbbabdc13027c6a04f.tar.bz2
docs-6f68e4f3f922370763d8bafbbabdc13027c6a04f.zip
spec protocol v13 for #8638
-rw-r--r--core/api-merchant.rst24
1 files changed, 21 insertions, 3 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index efc2d5b9..ef745dc2 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -123,7 +123,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 **12**.
+ This specification corresponds to ``current`` protocol being version **13**.
**Response:**
@@ -2895,9 +2895,27 @@ Adding templates
// This parameter is optional.
otp_id?: string;
- // Additional information in a separate template.
+ // Fixed contract information for orders created from
+ // this template.
template_contract: TemplateContractDetails;
- }
+
+ // Key-value pairs matching a subset of the
+ // fields from `template_contract` that are
+ // user-editable defaults for this template.
+ // Since protocol **v13**.
+ editable_defaults: Object;
+
+ // Required currency for payments. Useful if no
+ // amount is specified in the `template_contract`
+ // but the user should be required to pay in a
+ // particular currency anyway. Merchant backends
+ // may reject requests if the `template_contract`
+ // or `editable_defaults` do
+ // specify an amount in a different currency.
+ // This parameter is optional.
+ // Since protocol **v13**.
+ required_currency?: string;
+ }
.. ts:def:: TemplateContractDetails