commit e8ba4a9850c38623c79e5faf94b8a45bc104e0e1
parent 33d99c3106d8f69335d358595c7628958fe089d2
Author: Christian Grothoff <christian@grothoff.org>
Date: Tue, 15 Nov 2022 16:09:59 +0100
Merge branch 'master' of git+ssh://git.taler.net/docs
Diffstat:
1 file changed, 43 insertions(+), 5 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -3173,7 +3173,6 @@ Removing template
-
Dynamic template
----------------
@@ -3189,8 +3188,11 @@ Dynamic template
**Response:**
- :http:statuscode:`204 No content`:
- The creation of the public template is successful.
+ :http:statuscode:`200 OK`:
+ The creation of the dynamic template is successful. Returns a `DynamicTemplateResponse`.
+ :http:statuscode:`202 Accepted`:
+ If the user use a browser, he should be redirected to the provided locations to finish his order. The reponse will be an `RedirectTemplate`. After being redirected, it will returns `DynamicTemplateResponse`.
+ If the user use the application Taler, he will not redirected to another location.
:http:statuscode:`404 Not found`:
The merchant instance is unknown or it is not in our data.
@@ -3200,10 +3202,46 @@ Dynamic template
interface DynamicTemplateDetails {
// Subject of the template
- subject: string;
+ subject?: string;
// The amount entered by the customer
- amount: Amount;
+ amount?: Amount;
+ }
+
+
+ .. ts:def:: DynamicTemplateWebBrowser
+
+ interface DynamicTemplateWebBrowser {
+
+ // Subject of the template
+ subject?: string;
+
+ // The amount entered by the customer
+ amount?: Amount;
+
+ // The button the user needs to complete his order.
+ button_url: RedirectTemplate;
+
+ }
+
+ .. ts:def:: DynamicTemplateResponse
+
+ interface DynamicTemplateResponse {
+
+ // After enter the request. The user will be pay with QR code.
+ public_qrcode: string;
+
+ }
+
+
+ .. ts:def:: RedirectTemplate
+
+ interface RedirectTemplate {
+
+ // The user should go to the URL.
+ // He will be redirected to finish his order and pay on it.
+ public_url: string;
+
}