diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-10-15 23:26:47 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-10-15 23:26:47 +0200 |
commit | ad183309a3e159371e3a8dc04da9a8497c68aefa (patch) | |
tree | 04d6826f5476ecb7ad5a59d4acf1cfa9e220879d | |
parent | 412a3623679297e50c6e6e10e5f4397cddad9644 (diff) | |
download | docs-ad183309a3e159371e3a8dc04da9a8497c68aefa.tar.gz docs-ad183309a3e159371e3a8dc04da9a8497c68aefa.tar.bz2 docs-ad183309a3e159371e3a8dc04da9a8497c68aefa.zip |
fix docs for /refund, add refund permission to /pay
-rw-r--r-- | api-merchant.rst | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/api-merchant.rst b/api-merchant.rst index 3dbc33cf..abee1d52 100644 --- a/api-merchant.rst +++ b/api-merchant.rst @@ -239,6 +239,11 @@ The following API are made available by the merchant's `backend` to the merchant // can do order processing without a second lookup on // a successful payment proposal: Proposal; + + // Refund permissions for the order. This array will only + // be non-empty when this payment is a replay and a refund happened + // between the first successful payment request and a refund. + refund_permissions: RefundPermission[]; } .. http:post:: /refund @@ -295,12 +300,21 @@ The following API are made available by the merchant's `backend` to the merchant **Response** - If case of success, an *array of* `RefundLookup`_ objects is returned. + :status 200 OK: + Refund loopup was successful. The backend responds with a `RefundLookupResponse`_ object. + If there were no refunds for a contract, the array of refund permissions is empty. + :status 404 Not Found: + The transaction was not found. Note that this is *not* the same as + there being no refunds for the transaction. .. _RefundLookup: .. code-block:: tsref + + interface RefundLookupResponse { + refund_permissions: RefundPermission[]; + } - interface RefundLookup { + interface RefundPermission { // Coin from which the refund is going to be taken coin_pub: EddsaPublicKey; |