summaryrefslogtreecommitdiff
path: root/api
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2017-03-05 18:40:28 +0100
committerChristian Grothoff <christian@grothoff.org>2017-03-05 18:40:28 +0100
commit2373aa4e1ada44d39932c7c662388bd451bc9451 (patch)
tree984254bcfcd50f176f98571fde3a459e5e6093c7 /api
parent9608f228ec0a07310f785669ec4f2a0f0c503357 (diff)
downloaddocs-2373aa4e1ada44d39932c7c662388bd451bc9451.tar.gz
docs-2373aa4e1ada44d39932c7c662388bd451bc9451.tar.bz2
docs-2373aa4e1ada44d39932c7c662388bd451bc9451.zip
expand contract specification to include wire fee details
Diffstat (limited to 'api')
-rw-r--r--api/api-merchant.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/api/api-merchant.rst b/api/api-merchant.rst
index 3bad4917..5b0e71e9 100644
--- a/api/api-merchant.rst
+++ b/api/api-merchant.rst
@@ -477,6 +477,21 @@ The `offer` must have the following structure:
// Maximum total deposit fee accepted by the merchant for this contract
max_fee: Amount;
+ // Maximum wire fee accepted by the merchant (customer share to be
+ // divided by the 'wire_fee_amortization' factor, and further reduced
+ // if deposit fees are below 'max_fee'). Default if missing is zero.
+ max_wire_fee: Amount;
+
+ // Over how many customer transactions does the merchant expect to
+ // amortize wire fees on average? If the exchange's wire fee is
+ // above 'max_wire_fee', the difference is divided by this number
+ // to compute the expected customer's contribution to the wire fee.
+ // The customer's contribution may further be reduced by the difference
+ // between the 'max_fee' and the sum of the actual deposit fees.
+ // Optional, default value if missing is 1. 0 and negative values are
+ // invalid and also interpreted as 1.
+ wire_fee_amortization: Integer;
+
// A free-form identifier for this transaction.
transaction_id: string;
@@ -512,7 +527,7 @@ The `offer` must have the following structure:
locations: { [label: string]: [location: Location], ... };
// Extra data that is only interpreted by the merchant frontend.
- // Useful when the merchant needs to store extra information on a
+ // Useful when the merchant needs to store extra information on a
// contract without storing it separately in their database.
extra: any;
}