diff options
| author | Florian Dold <florian.dold@gmail.com> | 2017-01-12 15:05:18 +0100 |
|---|---|---|
| committer | Florian Dold <florian.dold@gmail.com> | 2017-01-12 15:05:18 +0100 |
| commit | f0aa7dfecf94c1af3d767e6f50f9e195a3c46138 (patch) | |
| tree | 2b4ff99d98b2965dec990b8962584dccb2ee6841 | |
| parent | 26c74ea709e7306752c757425708089546f77e34 (diff) | |
| download | docs-f0aa7dfecf94c1af3d767e6f50f9e195a3c46138.tar.gz docs-f0aa7dfecf94c1af3d767e6f50f9e195a3c46138.tar.bz2 docs-f0aa7dfecf94c1af3d767e6f50f9e195a3c46138.zip | |
clarify frontend API
| -rw-r--r-- | api-merchant.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/api-merchant.rst b/api-merchant.rst index a6b2809..9eccc2f 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 |