summaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2020-08-03 16:46:21 +0200
committerChristian Grothoff <christian@grothoff.org>2020-08-03 16:46:21 +0200
commit124d53ee53cabc2df6f0549e4211eb338e380f27 (patch)
treefe02597d1a5aa3341eca2772b246ed9ce42615d7 /core
parenta5abc58ad85d0b9050deb82c8be30693c36f0339 (diff)
downloaddocs-124d53ee53cabc2df6f0549e4211eb338e380f27.tar.gz
docs-124d53ee53cabc2df6f0549e4211eb338e380f27.tar.bz2
docs-124d53ee53cabc2df6f0549e4211eb338e380f27.zip
document HTML-handling endpoints
Diffstat (limited to 'core')
-rw-r--r--core/api-merchant.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 1262742..6e6629c 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1375,6 +1375,11 @@ Payment processing
Query the payment status of an order. This endpoint is for the wallet.
When the wallet goes to this URL and it is unpaid,
they will be prompted for payment.
+ This endpoint typically also supports requests with the "Accept" header
+ requesting "text/html". In this case, an HTML response suitable for
+ triggering the interaction with the wallet is returned. If the backend
+ installation does not include the required HTML templates, a 406 status
+ code is returned.
**Request:**
@@ -2204,12 +2209,22 @@ Giving Customer Tips
Handle request from wallet to provide details about a tip.
+ This endpoint typically also supports requests with the "Accept" header
+ requesting "text/html". In this case, an HTML response suitable for
+ triggering the interaction with the wallet is returned. If the backend
+ installation does not include the required HTML templates, a 406 status
+ code is returned.
+
**Response:**
:status 200 OK:
- A tip is being returned. The backend responds with a `TipInformation`
+ A tip is being returned. The backend responds with a `TipInformation`.
:status 404 Not Found:
The tip identifier is unknown.
+ :status 406 Not Acceptable:
+ The merchant backend could not load the template required to generate a reply in the desired format. (Likely HTML templates were not properly installed.)
+ :status 410 Gone:
+ A tip has been fully claimed. The JSON reply still contains the `TipInformation`.
.. ts:def:: TipInformation