summaryrefslogtreecommitdiff
path: root/api-merchant.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2016-06-10 23:54:27 +0200
committerChristian Grothoff <christian@grothoff.org>2016-06-10 23:54:27 +0200
commitc18d4b3cc3049e001d2e1e98e275b70805ab7b4a (patch)
treef0234b6466d723653b41147730487690facbafe3 /api-merchant.rst
parent90133fced04faeee80ff696e5c4216e5d2d6fa0f (diff)
downloaddocs-c18d4b3cc3049e001d2e1e98e275b70805ab7b4a.tar.gz
docs-c18d4b3cc3049e001d2e1e98e275b70805ab7b4a.tar.bz2
docs-c18d4b3cc3049e001d2e1e98e275b70805ab7b4a.zip
fix issues in documentation of the /track APIs
Diffstat (limited to 'api-merchant.rst')
-rw-r--r--api-merchant.rst34
1 files changed, 31 insertions, 3 deletions
diff --git a/api-merchant.rst b/api-merchant.rst
index bba5c367..9992ae86 100644
--- a/api-merchant.rst
+++ b/api-merchant.rst
@@ -230,9 +230,8 @@ The following API are made available by the merchant's `backend` to the merchant
:status 200 OK:
The deposit has been executed by the exchange and we have a wire transfer identifier.
- The response body is a `TrackTransactionResponse`_ object. Note that
- the similarity to the response given by the exchange for a /track/transaction
- is completely intended.
+ The response body is a JSON array of `TransactionWireTransfer`_ objects.
+
:status 202 Accepted:
The deposit request has been accepted for processing, but was not yet
@@ -245,6 +244,35 @@ The following API are made available by the merchant's `backend` to the merchant
:status 404 Not Found: The transaction is unknown to the backend.
+ **Details:**
+
+ .. _tsref-type-TransactionWireTransfer:
+ .. _TransactionWireTransfer:
+ .. code-block:: tsref
+
+ interface TransactionWireTransfer {
+ // 32-byte wire transfer identifier
+ wtid: Base32;
+
+ // Array of data about coins
+ coins: CoinWireTransfer[];
+ }
+
+ .. _tsref-type-CoinWireTransfer:
+ .. _CoinWireTransfer:
+ .. code-block:: tsref
+
+ interface CoinWireTransfer {
+ // public key of the coin that was deposited
+ coin_pub: EddsaPublicKey;
+
+ // Amount the coin was worth (including deposit fee)
+ amount_with_fee: Amount;
+
+ // Deposit fee retained by the exchange for the coin
+ deposit_fee: Amount;
+ }
+
---------
Encodings
---------