From f0aa7dfecf94c1af3d767e6f50f9e195a3c46138 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 12 Jan 2017 15:05:18 +0100 Subject: clarify frontend API --- api-merchant.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/api-merchant.rst b/api-merchant.rst index a6b28096..9eccc2fa 100644 --- a/api-merchant.rst +++ b/api-merchant.rst @@ -29,10 +29,11 @@ Before reading the API reference documentation, see the :ref:`merchant architect The Frontend HTTP API --------------------- +This frontend API is non-normative, and only gives an example of what a typical frontend API would look like. + .. http:get:: contract_url - Triggers the contract generation. Note that the URL may differ between - merchants. + Requesting this URL generates a contract, typically with a new (and unique) transaction id. **Request:** @@ -51,7 +52,8 @@ The Frontend HTTP API Send the deposit permission to the merchant. The client should POST a `DepositPermission`_ - object. + object. If the payment was processed successfully by the merchant, this URL will set session + state that allows the fulfillment URL to show the final product. .. _DepositPermission: .. code-block:: tsref -- cgit v1.2.3