summaryrefslogtreecommitdiff
path: root/api-merchant.rst
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2016-09-21 00:02:47 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2016-09-21 00:02:47 +0200
commit480be98d54fae7045c01f112507c9ebcab7f230c (patch)
tree4d0b961589550e0b0f59bf045372d27731bc491c /api-merchant.rst
parent723d0aabbf86fb2c84449d1b65523ee13953e756 (diff)
downloaddocs-480be98d54fae7045c01f112507c9ebcab7f230c.tar.gz
docs-480be98d54fae7045c01f112507c9ebcab7f230c.tar.bz2
docs-480be98d54fae7045c01f112507c9ebcab7f230c.zip
general documentation works
Diffstat (limited to 'api-merchant.rst')
-rw-r--r--api-merchant.rst17
1 files changed, 8 insertions, 9 deletions
diff --git a/api-merchant.rst b/api-merchant.rst
index b095186e..ff347979 100644
--- a/api-merchant.rst
+++ b/api-merchant.rst
@@ -21,7 +21,7 @@
Merchant API
============
-Before reading the API reference documentation, it is suggested to read the :ref:`merchant-arch`
+Before reading the API reference documentation, see the :ref:`merchant architecture<merchant-arch>` and :ref:`payprot`
---------------------
The Frontent HTTP API
@@ -49,8 +49,7 @@ The Frontent HTTP API
Send the deposit permission to the merchant. The client should POST a `deposit-permission`_
- object. Note that ``pay_url`` is make known by the frontent to the wallet via the DOM event
- ``taler-execute-payment``, documented in :ref:`byoffer`.
+ object.
.. _deposit-permission:
.. code-block:: tsref
@@ -110,7 +109,7 @@ The Frontent HTTP API
// the signature made by the coin's private key on a `struct TALER_DepositRequestPS`. See section `Signatures` on the exchange's API page.
coin_sig: EddsaSignature;
- }
+ }
**Success Response:**
@@ -214,7 +213,7 @@ The following API are made available by the merchant's `backend` to the merchant
:status 200 OK:
The wire transfer is known to the exchange, details about it follow in the body.
- The body of the response is a `TrackTransferResponse`_. Note that
+ The body of the response is a :ref:`TrackTransactionResponse <TrackTransferResponse>`. Note that
the similarity to the response given by the exchange for a /track/transfer
is completely intended.
@@ -240,7 +239,7 @@ The following API are made available by the merchant's `backend` to the merchant
The deposit request has been accepted for processing, but was not yet
executed. Hence the exchange does not yet have a wire transfer identifier.
The merchant should come back later and ask again.
- The response body is a `TrackTransactionAcceptedResponse`_. Note that
+ The response body is a :ref:`TrackTransactionAcceptedResponse <TrackTransactionAcceptedResponse>`. Note that
the similarity to the response given by the exchange for a /track/transaction
is completely intended.
@@ -287,9 +286,9 @@ Data such as dates, binary blobs, and other useful formats, are encoded as descr
.. _instances:
-------------------
-Merchant Instances
-------------------
+------------------------------------------
+Merchant Instances (To be moved elsewhere)
+------------------------------------------
Any backend can account for multiple bank accounts, and we call `instance` or `receiver` (interchangeably)
any of those bank accounts. The backend needs that due to the ability we give to a merchant to route money