commit f281f18d3c79c4aa460d4f172d3ddd02e87240c1 parent 92d5b8a707f1071c67ad992eb3f82422a43bf9b9 Author: Florian Dold <florian.dold@gmail.com> Date: Wed, 31 Jan 2018 19:58:04 +0100 document /tip-query Diffstat:
| M | api-error.rst | | | 2 | +- |
| M | api-merchant.rst | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
2 files changed, 39 insertions(+), 1 deletion(-)
diff --git a/api-error.rst b/api-error.rst @@ -23,7 +23,7 @@ Error Codes ----------- The following list shows error codes defined in -``<EXCHANGE-REPO>/src/include/taler_error_codes.h`` +`<EXCHANGE-REPO>/src/include/taler_error_codes.h <https://git.taler.net/exchange.git/tree/src/include/taler_error_codes.h>`_ .. _error-codes: .. code-block:: c diff --git a/api-merchant.rst b/api-merchant.rst @@ -287,6 +287,44 @@ Giving tips to customers } +.. http:post:: /tip-query + + Query the status of an instance's tipping reserve. + + **Request** + + :query instance: instance to query + + **Response** + + :status 200 OK: + A tip has been created. The backend responds with a `TipQueryResponse`_ + :status 404 Not Found: + The instance is unknown to the backend. + :status 412 Precondition Failed: + The instance does not have a tipping reserve configured. + + .. _TipQueryResponse: + .. code-block:: tsref + + interface TipQueryResponse { + // Amount still available + amount_available: Amount; + + // Amount that we authorized for tips + amount_authorized: Amount; + + // Amount that was picked up by users already + amount_used: Amount; + + // Timestamp indicating when the tipping reserve will expire + expiration: Timestamp; + + // Reserve public key of the tipping reserve + reserve_pub: string; + } + + ------------------------ Tracking wire transfers ------------------------