[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated (a06ea33 -> ccc0473)
From: |
gnunet |
Subject: |
[taler-docs] branch master updated (a06ea33 -> ccc0473) |
Date: |
Wed, 17 Mar 2021 09:27:00 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a change to branch master
in repository docs.
from a06ea33 remove spurious space
new cb55e38 add missing question mark
new 5d5043e mark up ‘h_contract’
new 9176bad typo: s/then/than/
new 35b8fe9 capitalize first word in sentence
new 7a56f9d diction: s/completed/have completed/
new ee3f93a capitalize first word in sentence
new 0dd91cf change markup of ‘coins’ from ' to ``
new 291fdd8 mark up ‘rtransaction_id’
new 79249d8 add missing trailing semicolon
new b78d162 add missing trailing semicolon
new c77755b capitalize first word in sentence; add period at end of
sentence
new 2a19010 capitalize first word in sentence
new 9639080 mark up ‘/keys’
new 11d208d capitalize first word in sentence
new 5c4c861 capitalize first word in sentence; add period at end of
sentence
new 0771e3d capitalize first word in sentence; add period at end of
sentence
new 9cba840 capitalize first word in sentence
new ccc0473 capitalize first word in sentence; add period at end of
sentence
The 18 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
core/api-merchant.rst | 40 ++++++++++++++++++++--------------------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 2a8844b..406743b 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -368,7 +368,7 @@ Querying payment status
// Was the payment refunded (even partially, via refund or abort)?
refunded: boolean;
- // Is any amount of the refund still waiting to be picked up (even
partially)
+ // Is any amount of the refund still waiting to be picked up (even
partially)?
refund_pending: boolean;
// Amount that was refunded in total.
@@ -401,7 +401,7 @@ Querying payment status
.. ts:def:: StatusGoneResponse
// The client tried to access the order via the claim
- // token (and not a valid h_contract), but the order can't be claimed
+ // token (and not a valid ``h_contract``), but the order can't be claimed
// anymore, as it is already paid.
interface StatusGoneResponse {
// Fulfillment URL for the order.
@@ -428,7 +428,7 @@ again.
Prove that the client previously paid for an order by providing
the merchant's signature from the `payment response <PaymentResponse>`.
Typically used by the customer's wallet if it receives a request for
- payment for an order that it already paid. This is more compact then
+ payment for an order that it already paid. This is more compact than
re-transmitting the full payment details.
Note that this request does include the
usual ``h_contract`` argument to authenticate the wallet and
@@ -464,7 +464,7 @@ again.
// key of the merchant instance.
sig: EddsaSignature;
- // hash of the order's contract terms (this is used to authenticate the
+ // Hash of the order's contract terms (this is used to authenticate the
// wallet/customer and to enable signature verification without
// database access).
h_contract: HashCode;
@@ -481,7 +481,7 @@ In rare cases (such as a wallet restoring from an outdated
backup) it is possibl
that a wallet fails to complete a payment because it runs out of e-cash in the
middle of the process. The abort API allows the wallet to abort the payment for
such an incomplete payment and to regain control over the coins that were spent
-so far. Aborts are not permitted for payments that completed. In contrast to
+so far. Aborts are not permitted for payments that have completed. In
contrast to
refunds, aborts do not require approval by the merchant because aborts always
are for incomplete payments for an order and never for established contracts.
@@ -541,7 +541,7 @@ are for incomplete payments for an order and never for
established contracts.
interface AbortRequest {
- // hash of the order's contract terms (this is used to authenticate the
+ // Hash of the order's contract terms (this is used to authenticate the
// wallet/customer in case $ORDER_ID is guessable).
h_contract: HashCode;
@@ -570,9 +570,9 @@ are for incomplete payments for an order and never for
established contracts.
interface AbortResponse {
// List of refund responses about the coins that the wallet
- // requested an abort for. In the same order as the 'coins'
+ // requested an abort for. In the same order as the ``coins``
// from the original request.
- // The rtransaction_id is implied to be 0.
+ // The ``rtransaction_id`` is implied to be 0.
refunds: MerchantAbortPayRefundStatus[];
}
@@ -587,7 +587,7 @@ are for incomplete payments for an order and never for
established contracts.
// Details about why a refund failed.
interface MerchantAbortPayRefundFailureStatus {
// Used as tag for the sum type RefundStatus sum type.
- type: "failure"
+ type: "failure";
// HTTP status of the exchange request, must NOT be 200.
exchange_status: Integer;
@@ -606,18 +606,18 @@ are for incomplete payments for an order and never for
established contracts.
// to the wallet and thus not included.
interface MerchantAbortPayRefundSuccessStatus {
// Used as tag for the sum type MerchantCoinRefundStatus sum type.
- type: "success"
+ type: "success";
// HTTP status of the exchange request, 200 (integer) required for
refund confirmations.
exchange_status: 200;
- // the EdDSA :ref:`signature` (binary-only) with purpose
+ // The EdDSA :ref:`signature` (binary-only) with purpose
// `TALER_SIGNATURE_EXCHANGE_CONFIRM_REFUND` using a current signing key
of the
- // exchange affirming the successful refund
+ // exchange affirming the successful refund.
exchange_sig: EddsaSignature;
- // public EdDSA key of the exchange that was used to generate the
signature.
- // Should match one of the exchange's signing keys from /keys. It is
given
+ // Public EdDSA key of the exchange that was used to generate the
signature.
+ // Should match one of the exchange's signing keys from ``/keys``. It
is given
// explicitly as the client might otherwise be confused by clock skew as
to
// which signing key was used.
exchange_pub: EddsaPublicKey;
@@ -655,7 +655,7 @@ the contract. Refunds must be approved by the merchant's
business logic.
.. ts:def:: WalletRefundRequest
interface WalletRefundRequest {
- // hash of the order's contract terms (this is used to authenticate the
+ // Hash of the order's contract terms (this is used to authenticate the
// wallet/customer).
h_contract: HashCode;
}
@@ -699,7 +699,7 @@ the contract. Refunds must be approved by the merchant's
business logic.
// Refund transaction ID.
rtransaction_id: Integer;
- // public key of a coin that was refunded
+ // Public key of a coin that was refunded.
coin_pub: EddsaPublicKey;
// Amount that was refunded, including refund fee charged by the exchange
@@ -719,12 +719,12 @@ the contract. Refunds must be approved by the merchant's
business logic.
// HTTP status of the exchange request, 200 (integer) required for
refund confirmations.
exchange_status: 200;
- // the EdDSA :ref:`signature` (binary-only) with purpose
+ // The EdDSA :ref:`signature` (binary-only) with purpose
// `TALER_SIGNATURE_EXCHANGE_CONFIRM_REFUND` using a current signing key
of the
- // exchange affirming the successful refund
+ // exchange affirming the successful refund.
exchange_sig: EddsaSignature;
- // public EdDSA key of the exchange that was used to generate the
signature.
+ // Public EdDSA key of the exchange that was used to generate the
signature.
// Should match one of the exchange's signing keys from /keys. It is
given
// explicitly as the client might otherwise be confused by clock skew as
to
// which signing key was used.
@@ -733,7 +733,7 @@ the contract. Refunds must be approved by the merchant's
business logic.
// Refund transaction ID.
rtransaction_id: Integer;
- // public key of a coin that was refunded
+ // Public key of a coin that was refunded.
coin_pub: EddsaPublicKey;
// Amount that was refunded, including refund fee charged by the exchange
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (a06ea33 -> ccc0473),
gnunet <=
- [taler-docs] 03/18: typo: s/then/than/, gnunet, 2021/03/17
- [taler-docs] 02/18: mark up ‘h_contract’, gnunet, 2021/03/17
- [taler-docs] 06/18: capitalize first word in sentence, gnunet, 2021/03/17
- [taler-docs] 01/18: add missing question mark, gnunet, 2021/03/17
- [taler-docs] 08/18: mark up ‘rtransaction_id’, gnunet, 2021/03/17
- [taler-docs] 04/18: capitalize first word in sentence, gnunet, 2021/03/17
- [taler-docs] 05/18: diction: s/completed/have completed/, gnunet, 2021/03/17
- [taler-docs] 07/18: change markup of ‘coins’ from ' to ``, gnunet, 2021/03/17
- [taler-docs] 15/18: capitalize first word in sentence; add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 11/18: capitalize first word in sentence; add period at end of sentence, gnunet, 2021/03/17