summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2016-10-03 14:29:53 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2016-10-03 14:29:53 +0200
commit8c0b4797806abbf86bc80f1d6fd878d580af4feb (patch)
treea71b177bcc4c9a58303e5339d80d8d26aabda3d9
parentaf0073e95ec56b810d6cc32e0ba9cf339e8fc49a (diff)
downloaddocs-8c0b4797806abbf86bc80f1d6fd878d580af4feb.tar.gz
docs-8c0b4797806abbf86bc80f1d6fd878d580af4feb.tar.bz2
docs-8c0b4797806abbf86bc80f1d6fd878d580af4feb.zip
documenting #4702
-rw-r--r--api-exchange.rst4
-rw-r--r--api-merchant.rst17
2 files changed, 13 insertions, 8 deletions
diff --git a/api-exchange.rst b/api-exchange.rst
index 58d08758..d8f38f72 100644
--- a/api-exchange.rst
+++ b/api-exchange.rst
@@ -609,9 +609,9 @@ denomination.
signature: EddsaSignature;
}
-------------------
+----------
Refreshing
-------------------
+----------
Refreshing creates `n` new coins from `m` old coins, where the sum of
denominations of the new coins must be smaller than the sum of the old coins'
diff --git a/api-merchant.rst b/api-merchant.rst
index a0c4b938..fa0d2a63 100644
--- a/api-merchant.rst
+++ b/api-merchant.rst
@@ -50,10 +50,10 @@ The Frontent HTTP API
.. http:post:: pay_url
- Send the deposit permission to the merchant. The client should POST a `deposit-permission`_
+ Send the deposit permission to the merchant. The client should POST a `DepositPermission`_
object.
- .. _deposit-permission:
+ .. _DepositPermission:
.. code-block:: tsref
interface DepositPermission {
@@ -171,7 +171,7 @@ The following API are made available by the merchant's `backend` to the merchant
**Request:**
- The `frontend` passes the :ref:`deposit permission <deposit-permission>`
+ The `frontend` passes the :ref:`deposit permission <DepositPermission>`
received from the wallet, and optionally adding a field named `pay_deadline`,
indicating a deadline by which he would expect to receive the bank transfer
for this deal. Note that the `pay_deadline` must be after the `refund_deadline`.
@@ -181,9 +181,8 @@ The following API are made available by the merchant's `backend` to the merchant
**Response:**
:status 200 OK:
- The exchange accepted all of the coins. The `frontend` should now fullfill the
- contract. This response has no meaningful body, the frontend needs to
- generate the fullfillment page.
+ The exchange accepted all of the coins. The body is a `PaymentResponse`_.
+ The `frontend` should now fullfill the contract.
:status 412 Precondition Failed:
The given exchange is not acceptable for this merchant, as it is not in the
list of accepted exchanges and not audited by an approved auditor.
@@ -200,7 +199,13 @@ The following API are made available by the merchant's `backend` to the merchant
`backend` is unavailable, in which case the customer might appreciate some
reassurance that the merchant is working on getting his systems back online.
+ .. _PaymentResponse:
+ .. code-block:: tsref
+ interface PaymentResponse {
+ // Signature of TALER_SIGNATURE_MERCHANT_PAYMENT_OK made by the merchant
+ merchant_sig: EddsaSignature;
+ }
.. http:get:: /track/transfer