summaryrefslogtreecommitdiff
path: root/taler-merchant-api-tutorial.rst
diff options
context:
space:
mode:
authorThien-Thi Nguyen <ttn@gnuvola.org>2020-11-24 20:42:47 -0500
committerThien-Thi Nguyen <ttn@gnuvola.org>2020-11-24 20:42:47 -0500
commita4ae813f68e49b3a846480f425a353e538ce6490 (patch)
treeaf4d0bf53d3d6368226f5cd8fa6c75fdbaa58c6f /taler-merchant-api-tutorial.rst
parent7bb54b26f81074704f2637e6909e9b5fd88e7276 (diff)
downloaddocs-a4ae813f68e49b3a846480f425a353e538ce6490.tar.gz
docs-a4ae813f68e49b3a846480f425a353e538ce6490.tar.bz2
docs-a4ae813f68e49b3a846480f425a353e538ce6490.zip
move ‘.. index::’ lines prior to their referrent (15 instances)
Diffstat (limited to 'taler-merchant-api-tutorial.rst')
-rw-r--r--taler-merchant-api-tutorial.rst41
1 files changed, 26 insertions, 15 deletions
diff --git a/taler-merchant-api-tutorial.rst b/taler-merchant-api-tutorial.rst
index a721a5e..2f3ce11 100644
--- a/taler-merchant-api-tutorial.rst
+++ b/taler-merchant-api-tutorial.rst
@@ -551,26 +551,31 @@ describes each of the fields in depth.
Financial amounts are always specified as a string in the format
``"CURRENCY:DECIMAL_VALUE"``.
+.. index:: amount
amount
Specifies the total amount to be paid to the merchant by the
customer.
- .. index:: amount
+
+.. index:: fees
+.. index:: maximum deposit fee
max_fee
This is the maximum total amount of deposit fees that the merchant is
willing to pay. If the deposit fees for the coins exceed this amount,
the customer has to include it in the payment total. The fee is
specified using the same triplet used for amount.
- .. index:: fees
- .. index:: maximum deposit fee
+
+.. index:: fees
+.. index:: maximum wire fee
max_wire_fee
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.
- .. index:: fees
- .. index:: maximum wire fee
+
+.. index:: fees
+.. index:: maximum fee amortization
wire_fee_amortization
Over how many customer transactions does the merchant expect to
@@ -581,35 +586,39 @@ wire_fee_amortization
’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.
- .. index:: fees
- .. index:: maximum fee amortization
+
+.. index:: pay_url
pay_url
Which URL accepts payments. This is the URL where the wallet will
POST coins.
- .. index:: pay_url
+
+.. index:: fulfillment URL
fulfillment_url
Which URL should the wallet go to for obtaining the fulfillment, for
example the HTML or PDF of an article that was bought, or an order
tracking system for shipments, or a simple human-readable Web page
indicating the status of the contract.
- .. index:: fulfillment URL
+
+.. index:: order ID
order_id
Alphanumeric identifier, freely definable by the merchant. Used by
the merchant to uniquely identify the transaction.
- .. index:: order ID
+
+.. index:: summary
summary
Short, human-readable summary of the contract. To be used when
displaying the contract in just one line, for example in the
transaction history of the customer.
- .. index:: summary
timestamp
Time at which the offer was generated.
+.. index:: payment deadline
+
pay_deadline
Timestamp of the time by which the merchant wants the exchange to
definitively wire the money due from this contract. Once this
@@ -618,7 +627,8 @@ pay_deadline
payment for them. Amounts will be rounded down to the wire transfer
unit; if the total amount is still below the wire transfer unit, it
will not be disbursed.
- .. index:: payment deadline
+
+.. index:: refund deadline
refund_deadline
Timestamp until which the merchant willing (and able) to give refunds
@@ -627,12 +637,12 @@ refund_deadline
the merchant will be able to sign a message to trigger a refund to
the customer. After this time, it will no longer be possible to
refund the customer. Must be smaller than the pay_deadline.
- .. index:: refund deadline
products
Array of products that are being sold to the customer. Each entry
contains a tuple with the following values:
- .. index:: product description
+
+.. index:: product description
description
Description of the product.
@@ -690,6 +700,8 @@ merchant
This should give a label in the locations map, specifying the
jurisdiction under which this contract is to be arbitrated.
+.. index:: location
+
locations
Associative map of locations used in the contract. Labels for
locations in this map can be freely chosen and used whenever a
@@ -698,7 +710,6 @@ locations
the customer or the merchant), it only needs to be listed (and
transmitted) once, and can otherwise be referred to via the label. A
non-exhaustive list of location attributes is the following:
- .. index:: location
name
receiver name for delivery, either business or person name.