summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorpriscilla <priscilla.huang@efrei.net>2022-11-15 09:43:33 -0500
committerpriscilla <priscilla.huang@efrei.net>2022-11-15 09:43:33 -0500
commit7587fa2502d05c12230d4b1ae2dc659236817dc3 (patch)
tree5689bb29851f5eea222feeb23aad5ad9c9d8d648 /core
parent26016c8cc02139ee864e37b8e5ac0c511342a2c9 (diff)
downloaddocs-7587fa2502d05c12230d4b1ae2dc659236817dc3.tar.gz
docs-7587fa2502d05c12230d4b1ae2dc659236817dc3.tar.bz2
docs-7587fa2502d05c12230d4b1ae2dc659236817dc3.zip
Update
Diffstat (limited to 'core')
-rw-r--r--core/api-merchant.rst33
1 files changed, 28 insertions, 5 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index ca7e0355..2d3a365a 100644
--- 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,31 @@ Dynamic template
interface DynamicTemplateDetails {
// Subject of the template
- subject: string;
+ subject?: string;
// The amount entered by the customer
- amount: Amount;
+ amount?: Amount;
+ }
+
+
+ .. 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;
+
}