summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcello Stanisci <marcello.stanisci@inria.fr>2017-06-20 20:44:01 +0200
committerMarcello Stanisci <marcello.stanisci@inria.fr>2017-06-20 20:44:01 +0200
commit9509d74dc5b0711910572ad091b281a1f128e02a (patch)
tree1dc2856c60ef42b7a6b3ed66ba8dca8e54c7b9bf
parent0eb8dd33350a490d19e1d82a2fb4db3eaee22dd4 (diff)
downloaddocs-9509d74dc5b0711910572ad091b281a1f128e02a.tar.gz
docs-9509d74dc5b0711910572ad091b281a1f128e02a.tar.bz2
docs-9509d74dc5b0711910572ad091b281a1f128e02a.zip
spec /refund increase out
-rw-r--r--api-merchant.rst43
1 files changed, 42 insertions, 1 deletions
diff --git a/api-merchant.rst b/api-merchant.rst
index e8eafdff..c5ec07bb 100644
--- a/api-merchant.rst
+++ b/api-merchant.rst
@@ -227,11 +227,52 @@ The following API are made available by the merchant's `backend` to the merchant
proposal: Proposal;
}
+.. http:post:: /refund
+
+ Increase the refund amount associated with a given order.
+
+ **Request**
+
+ The request body is a `RefundRequest`_ object.
+
+ **Response**
+
+ If the operation was successful, the backend responds with a signed confirmation,
+ see `RefundConfirmation`_
+
+ .. _RefundRequest:
+ .. code-block:: tsref
+
+ interface RefundRequest {
+ // Order id of the transaction to be refunded
+ order_id: string;
+
+ // Amount to be refunded
+ refund: Amount;
+
+ // Human-readable refund justification
+ reason: string;
+
+ // Merchant instance issuing the request
+ instance: string;
+ }
+
+ .. _RefundConfirmation:
+ .. code-block:: tsref
+
+ interface RefundConfirmation {
+ // Merchant signature over the hashed order id. Note
+ // that the purpose is set to zero. However, this value
+ // is not meant to be soon verified by the frontend, but
+ // could be showed in court.
+ sig: EddsaSignature
+ }
+
.. http:get:: /track/transfer
Provides deposits associated with a given wire transfer.
- **Request:**
+ **Request**
:query wtid: raw wire transfer identifier identifying the wire transfer (a base32-encoded value)
:query exchange: base URI of the exchange that made the wire transfer