[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated (d0c163b -> f916df2)
|
From: |
gnunet |
|
Subject: |
[taler-docs] branch master updated (d0c163b -> f916df2) |
|
Date: |
Wed, 17 Mar 2021 12:28:59 +0100 |
This is an automated email from the git hooks/post-receive script.
ttn pushed a change to branch master
in repository docs.
from d0c163b capitalize first word in sentence; add period at end of
sentence (six instances)
new e0f54f9 fold long line; add missing trailing semicolon
new dae7b2b capitalize first word in sentence; add period at end of
sentence
new 48aa759 add question mark at end of sentence
new aac5625 add question mark at end of sentence
new 3181931 add period at end of sentence
new 76acef3 fold long line; add period at end of sentence
new 10e90d6 fold long line
new e899013 capitalize first word in sentence; add period at end of
sentence
new 0ff4bbe add period at end of sentence
new 2eb881e capitalize first word in sentence; add period at end of
sentence
new 6887368 add period at end of sentence
new 832a79a capitalize first word in sentence; add period at end of
sentence
new 404f9b1 add period at end of sentence (two instances)
new 5466f4c capitalize first word in sentence; add period at end of
sentence
new 293cafa add period at end of sentence
new 8124e26 add period at end of sentence (two instances)
new 69f8ea6 s/abort/forget/
new 90be622 fold long line; add period at end of sentence
new 5dd442c fold long line
new b7f6993 add period at end of sentence
new ea54c41 add period at end of sentence
new 640509f add period at end of sentence (two instances)
new 474821a change markup of ‘GET /transfer’ from " to ``
new 2635915 capitalize first word in sentence; add period at end of
sentence (four instances)
new b10fcd8 add period at end of sentence (three instances)
new 07241cb capitalize first word in sentence; add period at end of
sentence
new 5176284 capitalize first word in sentence; add period at end of
sentence
new 37b3542 fold long line; add missing trailing semicolon
new 772ab91 fix typo: s/missbehavior/misbehavior/
new 0d6367e remove spurious blank line
new 5e5115c add period at end of sentence (seven instances)
new 42685e5 add period at end of sentence
new 01f3810 add period at end of sentence
new c27a428 change markup of ‘exchange_sig’ from \ to ``
new 476a24c mark up ‘exchange_sig’
new 2078c31 capitalize first word in sentence; add period at end of
sentence (three instances)
new 216fe5f mark up ‘/keys’
new 4a2e897 change markup of ‘before’ and ‘after’ from " to ``
new 9bad535 add period at end of sentence (three instances)
new b6a699c mark up ‘-20’
new c12d385 mark up ‘transfer_serial_id’
new c6e9d31 capitalize first word in sentence; add period at end of
sentence (five instances)
new c599c58 s/setup/set up/
new 6c347cf mark up ‘/wire’
new f7b935d add period at end of sentence (five instances)
new 7c0bd44 add period at end of sentence (seven instances)
new 08aec58 add question mark at end of sentence
new f32c83b add period at end of sentence
new f181cb4 add period at end of sentence (three instances)
new 619029d add question mark at end of sentence
new 5574b0f add period at end of sentence
new 5f66f95 add period at end of sentence
new d0e1e3a add period at end of sentence (three instances)
new 7cbb2f9 capitalize first word in sentence; add question mark at end
of sentence
new d34e500 add period at end of sentence
new 7743e54 mark up ‘/authorize-tip’
new 7c8a7cc add period at end of sentence
new 2ce3b94 capitalize first word in sentence; add period at end of
sentence
new a5c3abb add period at end of sentence (two instances)
new 7aab57b mark up ‘row_id’
new 3e48dda capitalize first word in sentence; add period at end of
sentence
new 8b79553 capitalize first word in sentence
new b267b1c add period at end of sentence
new 682fcce mark up ‘order_id’
new 12960db fix typo: s/is/it/
new 4b57654 add period at end of sentence
new 7185e64 change markup of ‘wire_fee_amortization’ and ‘max_fee’ from '
to ``
new 40c2e5c change markup of ‘max_wire_fee’ and ‘max_fee’ from ' to ``
new db8cb36 add period at end of sentence
new 69bfa9b add period at end of sentence
new d04ec94 add period at end of sentence
new cfc5e19 add period at end of sentence
new c070913 mark up ‘h_wire’
new 856e804 fold long line
new 84d1171 capitalize first word in sentence
new c655a40 capitalize first word in sentence; add period at end of
sentence
new 9d70234 capitalize first word in sentence; add period at end of
sentence (four instances)
new e398736 capitalize first word in sentence
new 9e06b2a capitalize first word in sentence; add period at end of
sentence (three instances)
new f916df2 add period at end of sentence (two instances)
The 80 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 | 259 ++++++++++++++++++++++++++------------------------
1 file changed, 133 insertions(+), 126 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index ca4505f..f38fb53 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1763,22 +1763,24 @@ Inspecting orders
.. ts:def:: MerchantOrderStatusResponse
- type MerchantOrderStatusResponse = CheckPaymentPaidResponse |
CheckPaymentClaimedResponse | CheckPaymentUnpaidResponse
+ type MerchantOrderStatusResponse = CheckPaymentPaidResponse |
+ CheckPaymentClaimedResponse |
+ CheckPaymentUnpaidResponse;
.. ts:def:: CheckPaymentPaidResponse
interface CheckPaymentPaidResponse {
- // the customer paid for this contract
+ // The customer paid for this contract.
order_status: "paid";
- // Was the payment refunded (even partially)
+ // Was the payment refunded (even partially)?
refunded: boolean;
// True if there are any approved refunds that the wallet has
// not yet obtained.
refund_pending: boolean;
- // Did the exchange wire us the funds
+ // Did the exchange wire us the funds?
wired: boolean;
// Total amount the exchange deposited into our bank account
@@ -1799,13 +1801,15 @@ Inspecting orders
// Total amount that was refunded, 0 if refunded is false.
refund_amount: Amount;
- // Contract terms
+ // Contract terms.
contract_terms: ContractTerms;
- // The wire transfer status from the exchange for this order if
available, otherwise empty array
+ // The wire transfer status from the exchange for this order if
+ // available, otherwise empty array.
wire_details: TransactionWireTransfer[];
- // Reports about trouble obtaining wire transfer details, empty array if
no trouble were encountered.
+ // Reports about trouble obtaining wire transfer details,
+ // empty array if no trouble were encountered.
wire_reports: TransactionWireReport[];
// The refund details for this order. One entry per
@@ -1820,10 +1824,10 @@ Inspecting orders
.. ts:def:: CheckPaymentClaimedResponse
interface CheckPaymentClaimedResponse {
- // a wallet claimed the order, but did not yet pay for the contract
+ // A wallet claimed the order, but did not yet pay for the contract.
order_status: "claimed";
- // Contract terms
+ // Contract terms.
contract_terms: ContractTerms;
}
@@ -1831,7 +1835,7 @@ Inspecting orders
.. ts:def:: CheckPaymentUnpaidResponse
interface CheckPaymentUnpaidResponse {
- // the order was neither claimed nor paid
+ // The order was neither claimed nor paid.
order_status: "unpaid";
// URI that the wallet must process to complete the payment.
@@ -1856,10 +1860,10 @@ Inspecting orders
.. ts:def:: RefundDetails
interface RefundDetails {
- // Reason given for the refund
+ // Reason given for the refund.
reason: string;
- // when was the refund approved
+ // When was the refund approved.
timestamp: Timestamp;
// Total amount that was refunded (minus a refund fee).
@@ -1869,17 +1873,17 @@ Inspecting orders
.. ts:def:: TransactionWireTransfer
interface TransactionWireTransfer {
- // Responsible exchange
+ // Responsible exchange.
exchange_url: string;
- // 32-byte wire transfer identifier
+ // 32-byte wire transfer identifier.
wtid: Base32;
- // execution time of the wire transfer
+ // Execution time of the wire transfer.
execution_time: Timestamp;
// Total amount that has been wire transferred
- // to the merchant
+ // to the merchant.
amount: Amount;
// Was this transfer confirmed by the merchant via the
@@ -1890,10 +1894,10 @@ Inspecting orders
.. ts:def:: TransactionWireReport
interface TransactionWireReport {
- // Numerical `error code <error-codes>`
+ // Numerical `error code <error-codes>`.
code: number;
- // Human-readable error description
+ // Human-readable error description.
hint: string;
// Numerical `error code <error-codes>` from the exchange.
@@ -1950,7 +1954,7 @@ the contract!) to minimize risks from information leakage.
The request is malformed or one of the paths is invalid.
:http:statuscode:`404 Not found`:
The merchant backend could not find the order or the instance
- and thus cannot process the abort request.
+ and thus cannot process the forget request.
:http:statuscode:`409 Conflict`:
The request includes a field that was not marked as forgettable, so
the merchant cannot delete that field.
@@ -1999,24 +2003,26 @@ Giving Refunds
**Response:**
:http:statuscode:`200 OK`:
- The refund amount has been increased, the backend responds with a
`MerchantRefundResponse`
+ The refund amount has been increased, the backend
+ responds with a `MerchantRefundResponse`.
:http:statuscode:`403 Forbidden`:
- For the given order, the refund delay was zero and thus refunds are
categorically not allowed.
+ For the given order, the refund delay was zero and thus
+ refunds are categorically not allowed.
:http:statuscode:`404 Not found`:
- The order is unknown to the merchant
+ The order is unknown to the merchant.
:http:statuscode:`410 Gone`:
It is too late for aborting, the exchange may have already wired the funds
to the merchant.
:http:statuscode:`409 Conflict`:
- The refund amount exceeds the amount originally paid
+ The refund amount exceeds the amount originally paid.
.. ts:def:: RefundRequest
interface RefundRequest {
- // Amount to be refunded
+ // Amount to be refunded.
refund: Amount;
- // Human-readable refund justification
+ // Human-readable refund justification.
reason: string;
}
@@ -2084,7 +2090,7 @@ Informing the backend about incoming wire transfers
The wire transfer identifier is already known to us, but for a different
amount,
wire method or exchange.
:http:statuscode:`502 Bad gateway`:
- The exchange returned an error when we asked it about the "GET /transfer"
status
+ The exchange returned an error when we asked it about the ``GET
/transfer`` status
for this wire transfer. Details of the exchange error are returned.
:http:statuscode:`504 Gateway timeout`:
The merchant's interaction with the exchange took too long.
@@ -2095,32 +2101,32 @@ Informing the backend about incoming wire transfers
.. ts:def:: TransferInformation
interface TransferInformation {
- // how much was wired to the merchant (minus fees)
+ // How much was wired to the merchant (minus fees).
credit_amount: Amount;
- // raw wire transfer identifier identifying the wire transfer (a
base32-encoded value)
+ // Raw wire transfer identifier identifying the wire transfer (a
base32-encoded value).
wtid: WireTransferIdentifierRawP;
- // target account that received the wire transfer
+ // Target account that received the wire transfer.
payto_uri: string;
- // base URL of the exchange that made the wire transfer
+ // Base URL of the exchange that made the wire transfer.
exchange_url: string;
}
.. ts:def:: MerchantTrackTransferResponse
interface MerchantTrackTransferResponse {
- // Total amount transferred
+ // Total amount transferred.
total: Amount;
- // Applicable wire fee that was charged
+ // Applicable wire fee that was charged.
wire_fee: Amount;
- // Time of the execution of the wire transfer by the exchange, according
to the exchange
+ // Time of the execution of the wire transfer by the exchange, according
to the exchange.
execution_time: Timestamp;
- // details about the deposits
+ // Details about the deposits.
deposits_sums: MerchantTrackTransferDetail[];
}
@@ -2134,19 +2140,20 @@ Informing the backend about incoming wire transfers
// The total amount the exchange paid back for ``order_id``.
deposit_value: Amount;
- // applicable fees for the deposit
+ // Applicable fees for the deposit.
deposit_fee: Amount;
}
.. ts:def:: ExchangeConflictDetails
- type ExchangeConflictDetails = WireFeeConflictDetails |
TrackTransferConflictDetails
+ type ExchangeConflictDetails = WireFeeConflictDetails |
+ TrackTransferConflictDetails;
.. ts:def:: WireFeeConflictDetails
- // Note: this is not the full 'proof' of missbehavior, as
+ // Note: this is not the full 'proof' of misbehavior, as
// the bogus message from the exchange with a signature
// over the 'different' wire fee is missing.
//
@@ -2162,30 +2169,29 @@ Informing the backend about incoming wire transfers
// Text describing the issue for humans.
hint: string;
-
// Wire fee (wrongly) charged by the exchange, breaking the
- // contract affirmed by the exchange_sig.
+ // contract affirmed by the ``exchange_sig``.
wire_fee: Amount;
- // Timestamp of the wire transfer
+ // Timestamp of the wire transfer.
execution_time: Timestamp;
- // The expected wire fee (as signed by the exchange)
+ // The expected wire fee (as signed by the exchange).
expected_wire_fee: Amount;
- // Expected closing fee (needed to verify signature)
+ // Expected closing fee (needed to verify signature).
expected_closing_fee: Amount;
- // Start date of the expected fee structure
+ // Start date of the expected fee structure.
start_date: Timestamp;
- // End date of the expected fee structure
+ // End date of the expected fee structure.
end_date: Timestamp;
- // Signature of the exchange affirming the expected fee structure
+ // Signature of the exchange affirming the expected fee structure.
master_sig: EddsaSignature;
- // Master public key of the exchange
+ // Master public key of the exchange.
master_pub: EddsaPublicKey;
}
@@ -2193,7 +2199,7 @@ Informing the backend about incoming wire transfers
.. ts:def:: TrackTransferConflictDetails
interface TrackTransferConflictDetails {
- // Numerical `error code <error-codes>`
+ // Numerical `error code <error-codes>`.
code: "TALER_EC_MERCHANT_PRIVATE_POST_TRANSFERS_CONFLICTING_REPORTS";
// Text describing the issue for humans.
@@ -2222,14 +2228,14 @@ Informing the backend about incoming wire transfers
// Signs over a ``struct TALER_DepositConfirmationPS``.
deposit_exchange_sig: EddsaSignature;
- // Hash of the merchant's bank account the wire transfer went to
+ // Hash of the merchant's bank account the wire transfer went to.
h_wire: HashCode;
// Hash of the contract terms with the conflicting deposit.
h_contract_terms: HashCode;
// At what time the exchange received the deposit. Needed
- // to verify the \exchange_sig\.
+ // to verify the ``exchange_sig``.
deposit_timestamp: Timestamp;
// At what time the refund possibility expired (needed to verify
``exchange_sig``).
@@ -2255,17 +2261,17 @@ Informing the backend about incoming wire transfers
.. ts:def:: TrackTransferProof
interface TrackTransferProof {
- // signature from the exchange made with purpose
- // ``TALER_SIGNATURE_EXCHANGE_CONFIRM_WIRE_DEPOSIT``
+ // Signature from the exchange made with purpose
+ // ``TALER_SIGNATURE_EXCHANGE_CONFIRM_WIRE_DEPOSIT``.
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. Again
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``.
Again given
// explicitly as the client might otherwise be confused by clock skew as
to
// which signing key was used.
exchange_pub: EddsaSignature;
- // hash of the wire details (identical for all deposits)
+ // Hash of the wire details (identical for all deposits).
// Needed to check the ``exchange_sig``
h_wire: HashCode;
}
@@ -2277,7 +2283,7 @@ Querying known wire transfers
.. http:get:: [/instances/$INSTANCE]/private/transfers
Obtain a list of all wire transfers the backend has checked. Note that when
- filtering by timestamp (using "before" and/or "after"), we use the time
+ filtering by timestamp (using ``before`` and/or ``after``), we use the time
reported by the exchange and thus will ONLY return results for which we
already
have a response from the exchange. This should be virtually all transfers,
however
it is conceivable that for some transfer the exchange responded with a
temporary
@@ -2287,15 +2293,15 @@ Querying known wire transfers
**Request:**
- :query payto_uri: *Optional*. Filter for transfers to the given bank account
(subject and amount MUST NOT be given in the payto URI)
+ :query payto_uri: *Optional*. Filter for transfers to the given bank account
(subject and amount MUST NOT be given in the payto URI).
- :query before: *Optional*. Filter for transfers executed before the given
timestamp
+ :query before: *Optional*. Filter for transfers executed before the given
timestamp.
- :query after: *Optional*. Filter for transfers executed after the given
timestamp
+ :query after: *Optional*. Filter for transfers executed after the given
timestamp.
- :query limit: *Optional*. At most return the given number of results.
Negative for descending in execution time, positive for ascending in execution
time. Default is -20.
+ :query limit: *Optional*. At most return the given number of results.
Negative for descending in execution time, positive for ascending in execution
time. Default is ``-20``.
- :query offset: *Optional*. Starting transfer_serial_id for an iteration.
+ :query offset: *Optional*. Starting ``transfer_serial_id`` for an iteration.
:query verified: *Optional*. Filter transfers by verification status.
@@ -2308,23 +2314,23 @@ Querying known wire transfers
.. ts:def:: TransferList
interface TransferList {
- // list of all the transfers that fit the filter that we know
+ // List of all the transfers that fit the filter that we know.
transfers : TransferDetails[];
}
.. ts:def:: TransferDetails
interface TransferDetails {
- // how much was wired to the merchant (minus fees)
+ // How much was wired to the merchant (minus fees).
credit_amount: Amount;
- // raw wire transfer identifier identifying the wire transfer (a
base32-encoded value)
+ // Raw wire transfer identifier identifying the wire transfer (a
base32-encoded value).
wtid: WireTransferIdentifierRawP;
- // target account that received the wire transfer
+ // Target account that received the wire transfer.
payto_uri: string;
- // base URL of the exchange that made the wire transfer
+ // Base URL of the exchange that made the wire transfer.
exchange_url: string;
// Serial number identifying the transfer in the merchant backend.
@@ -2368,7 +2374,7 @@ not used to tip customers will automatically be wired
back from the exchange to the originating account.
To begin tipping, a merchant must tell the backend
-to setup a reserve. The backend will return a
+to set up a reserve. The backend will return a
reserve public key which must be used as the wire
transfer subject when wiring the tipping campaign
funds to the exchange.
@@ -2398,7 +2404,7 @@ funds to the exchange.
:http:statuscode:`409 Conflict`:
The exchange does not support the requested wire method.
:http:statuscode:`502 Bad gateway`:
- We could not obtain /wire details from the specified exchange base URL.
+ We could not obtain ``/wire`` details from the specified exchange base URL.
:http:statuscode:`504 Gateway timeout`:
The merchant's interaction with the exchange took too long.
The client might want to try again later.
@@ -2406,23 +2412,23 @@ funds to the exchange.
.. ts:def:: ReserveCreateRequest
interface ReserveCreateRequest {
- // Amount that the merchant promises to put into the reserve
+ // Amount that the merchant promises to put into the reserve.
initial_balance: Amount;
- // Exchange the merchant intends to use for tipping
+ // Exchange the merchant intends to use for tipping.
exchange_url: string;
- // Desired wire method, for example "iban" or "x-taler-bank"
+ // Desired wire method, for example "iban" or "x-taler-bank".
wire_method: string;
}
.. ts:def:: ReserveCreateConfirmation
interface ReserveCreateConfirmation {
- // Public key identifying the reserve
+ // Public key identifying the reserve.
reserve_pub: EddsaPublicKey;
- // Wire account of the exchange where to transfer the funds
+ // Wire account of the exchange where to transfer the funds.
payto_uri: string;
}
@@ -2432,8 +2438,8 @@ funds to the exchange.
**Request:**
- :query after: *Optional*. Only return reserves created after the given
timestamp in milliseconds
- :query active: *Optional*. Only return active/inactive reserves depending
on the boolean given
+ :query after: *Optional*. Only return reserves created after the given
timestamp in milliseconds.
+ :query active: *Optional*. Only return active/inactive reserves depending
on the boolean given.
:query failures: *Optional*. Only return reserves where we disagree with
the exchange about the initial balance.
**Response:**
@@ -2445,23 +2451,23 @@ funds to the exchange.
.. ts:def:: TippingReserveStatus
interface TippingReserveStatus {
- // Array of all known reserves (possibly empty!)
+ // Array of all known reserves (possibly empty!).
reserves: ReserveStatusEntry[];
}
.. ts:def:: ReserveStatusEntry
interface ReserveStatusEntry {
- // Public key of the reserve
+ // Public key of the reserve.
reserve_pub: EddsaPublicKey;
- // Timestamp when it was established
+ // Timestamp when it was established.
creation_time: Timestamp;
- // Timestamp when it expires
+ // Timestamp when it expires.
expiration_time: Timestamp;
- // Initial amount as per reserve creation call
+ // Initial amount as per reserve creation call.
merchant_initial_amount: Amount;
// Initial amount as per exchange, 0 if exchange did
@@ -2474,7 +2480,7 @@ funds to the exchange.
// Amount approved for tips that exceeds the pickup_amount.
committed_amount: Amount;
- // Is this reserve active (false if it was deleted but not purged)
+ // Is this reserve active (false if it was deleted but not purged)?
active: boolean;
}
@@ -2488,7 +2494,7 @@ Query funds remaining
**Request:**
- :query tips: *Optional*. If set to "yes", returns also information about all
of the tips created
+ :query tips: *Optional*. If set to "yes", returns also information about all
of the tips created.
**Response:**
@@ -2511,13 +2517,13 @@ Query funds remaining
.. ts:def:: ReserveDetail
interface ReserveDetail {
- // Timestamp when it was established
+ // Timestamp when it was established.
creation_time: Timestamp;
- // Timestamp when it expires
+ // Timestamp when it expires.
expiration_time: Timestamp;
- // Initial amount as per reserve creation call
+ // Initial amount as per reserve creation call.
merchant_initial_amount: Amount;
// Initial amount as per exchange, 0 if exchange did
@@ -2534,7 +2540,7 @@ Query funds remaining
// Only present if asked for explicitly.
tips?: TipStatusEntry[];
- // Is this reserve active (false if it was deleted but not purged)
+ // Is this reserve active (false if it was deleted but not purged)?
active: boolean;
}
@@ -2542,7 +2548,7 @@ Query funds remaining
interface TipStatusEntry {
- // Unique identifier for the tip
+ // Unique identifier for the tip.
tip_id: HashCode;
// Total amount of the tip that can be withdrawn.
@@ -2567,7 +2573,7 @@ Authorizing tips
**Response:**
:http:statuscode:`200 OK`:
- A tip has been created. The backend responds with a `TipCreateConfirmation`
+ A tip has been created. The backend responds with a
`TipCreateConfirmation`.
:http:statuscode:`404 Not found`:
The instance or the reserve is unknown to the backend.
:http:statuscode:`412 Precondition failed`:
@@ -2576,10 +2582,10 @@ Authorizing tips
.. ts:def:: TipCreateRequest
interface TipCreateRequest {
- // Amount that the customer should be tipped
+ // Amount that the customer should be tipped.
amount: Amount;
- // Justification for giving the tip
+ // Justification for giving the tip.
justification: string;
// URL that the user should be directed to after tipping,
@@ -2593,14 +2599,14 @@ Authorizing tips
// Unique tip identifier for the tip that was created.
tip_id: HashCode;
- // taler://tip URI for the tip
+ // taler://tip URI for the tip.
taler_tip_uri: string;
// URL that will directly trigger processing
- // the tip when the browser is redirected to it
+ // the tip when the browser is redirected to it.
tip_status_url: string;
- // when does the tip expire
+ // When does the tip expire?
tip_expiration: Timestamp;
}
@@ -2609,7 +2615,7 @@ Authorizing tips
Authorize creation of a tip from the given reserve, except with
automatic selection of a working reserve of the instance by the
- backend. Intentionally otherwise identical to the /authorize-tip
+ backend. Intentionally otherwise identical to the ``/authorize-tip``
endpoint given above.
**Request:**
@@ -2619,7 +2625,7 @@ Authorizing tips
**Response:**
:http:statuscode:`200 OK`:
- A tip has been created. The backend responds with a `TipCreateConfirmation`
+ A tip has been created. The backend responds with a
`TipCreateConfirmation`.
:http:statuscode:`404 Not found`:
The instance is unknown to the backend.
:http:statuscode:`412 Precondition failed`:
@@ -2661,12 +2667,12 @@ Checking tip status
**Request:**
- :query pickups: if set to "yes", returns also information about all of the
pickups
+ :query pickups: If set to "yes", returns also information about all of the
pickups.
**Response:**
:http:statuscode:`200 OK`:
- The tip is known. The backend responds with a `TipDetails` message
+ The tip is known. The backend responds with a `TipDetails` message.
:http:statuscode:`404 Not found`:
The tip is unknown to the backend.
@@ -2685,7 +2691,7 @@ Checking tip status
// Timestamp indicating when the tip is set to expire (may be in the
past).
expiration: Timestamp;
- // Reserve public key from which the tip is funded
+ // Reserve public key from which the tip is funded.
reserve_pub: EddsaPublicKey;
// Array showing the pickup operations of the wallet (possibly empty!).
@@ -2717,7 +2723,7 @@ Checking tip status
:query limit: *Optional*. At most return the given number of results.
Negative for descending in database row id, positive for ascending in database
row id.
- :query offset: *Optional*. Starting row_id for an iteration.
+ :query offset: *Optional*. Starting ``row_id`` for an iteration.
**Response:**
@@ -2737,13 +2743,13 @@ Checking tip status
interface Tip {
- // id of the tip in the backend database
+ // ID of the tip in the backend database.
row_id: number;
// Unique identifier for the tip.
tip_id: HashCode;
- // (remaining) amount of the tip (including fees).
+ // (Remaining) amount of the tip (including fees).
tip_amount: Amount;
}
@@ -2767,7 +2773,7 @@ The contract terms must have the following structure:
.. ts:def:: ContractTerms
interface ContractTerms {
- // Human-readable description of the whole purchase
+ // Human-readable description of the whole purchase.
summary: string;
// Map from IETF BCP 47 language tags to localized summaries.
@@ -2776,7 +2782,7 @@ The contract terms must have the following structure:
// Unique, free-form identifier for the proposal.
// Must be unique within a merchant instance.
// For merchants that do not store proposals in their DB
- // before the customer paid for them, the order_id can be used
+ // before the customer paid for them, the ``order_id`` can be used
// by the frontend to restore a proposal from the information
// encoded in it (such as a short product identifier and timestamp).
order_id: string;
@@ -2786,25 +2792,25 @@ The contract terms must have the following structure:
// before transferring it to the merchant.
amount: Amount;
- // The URL for this purchase. Every time is is visited, the merchant
+ // The URL for this purchase. Every time it is visited, the merchant
// will send back to the customer the same proposal. Clearly, this URL
// can be bookmarked and shared by users.
fulfillment_url?: string;
- // Maximum total deposit fee accepted by the merchant for this contract
+ // 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.
+ // 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
+ // 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.
+ // 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: number;
@@ -2812,13 +2818,13 @@ The contract terms must have the following structure:
// List of products that are part of the purchase (see `Product`).
products: Product[];
- // Time when this contract was generated
+ // Time when this contract was generated.
timestamp: Timestamp;
// After this deadline has passed, no refunds will be accepted.
refund_deadline: Timestamp;
- // After this deadline, the merchant won't accept payments for the contact
+ // After this deadline, the merchant won't accept payments for the contact.
pay_deadline: Timestamp;
// Transfer deadline for the exchange. Must be in the
@@ -2826,20 +2832,20 @@ The contract terms must have the following structure:
wire_transfer_deadline: Timestamp;
// Merchant's public key used to sign this proposal; this information
- // is typically added by the backend Note that this can be an ephemeral
key.
+ // is typically added by the backend. Note that this can be an ephemeral
key.
merchant_pub: EddsaPublicKey;
// Base URL of the (public!) merchant backend API.
// Must be an absolute URL that ends with a slash.
merchant_base_url: string;
- // More info about the merchant, see below
+ // More info about the merchant, see below.
merchant: Merchant;
// The hash of the merchant instance's wire details.
h_wire: HashCode;
- // Wire transfer method identifier for the wire method associated with
h_wire.
+ // Wire transfer method identifier for the wire method associated with
``h_wire``.
// The wallet may only select exchanges via a matching auditor if the
// exchange also supports this wire method.
// The wire transfer fees must be added based on this wire transfer method.
@@ -2895,12 +2901,13 @@ The wallet must select a exchange that either the
merchant accepts directly by
listing it in the exchanges array, or for which the merchant accepts an auditor
that audits that exchange by listing it in the auditors array.
-The `Product` object describes the product being purchased from the merchant.
It has the following structure:
+The `Product` object describes the product being purchased from the merchant.
+It has the following structure:
.. ts:def:: Product
interface Product {
- // merchant-internal identifier for the product.
+ // Merchant-internal identifier for the product.
product_id?: string;
// Human-readable product description.
@@ -2924,30 +2931,30 @@ The `Product` object describes the product being
purchased from the merchant. It
// A list of taxes paid by the merchant for this product. Can be empty.
taxes?: Tax[];
- // time indicating when this product should be delivered
+ // Time indicating when this product should be delivered.
delivery_date?: Timestamp;
}
.. ts:def:: Tax
interface Tax {
- // the name of the tax
+ // The name of the tax.
name: string;
- // amount paid in tax
+ // Amount paid in tax.
tax: Amount;
}
.. ts:def:: Merchant
interface Merchant {
- // label for a location with the business address of the merchant
+ // Label for a location with the business address of the merchant.
address: Location;
- // the merchant's legal name of business
+ // The merchant's legal name of business.
name: string;
- // label for a location that denotes the jurisdiction for disputes.
+ // Label for a location that denotes the jurisdiction for disputes.
// Some of the typical fields for a location (such as a street address)
may be absent.
jurisdiction: Location;
}
@@ -2993,22 +3000,22 @@ The `Product` object describes the product being
purchased from the merchant. It
.. ts:def:: Auditor
interface Auditor {
- // official name
+ // Official name.
name: string;
- // Auditor's public key
+ // Auditor's public key.
auditor_pub: EddsaPublicKey;
- // Base URL of the auditor
+ // Base URL of the auditor.
url: string;
}
.. ts:def:: Exchange
interface Exchange {
- // the exchange's base URL
+ // The exchange's base URL.
url: string;
- // master public key of the exchange
+ // Master public key of the exchange.
master_pub: EddsaPublicKey;
}
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
- [taler-docs] branch master updated (d0c163b -> f916df2),
gnunet <=
- [taler-docs] 02/80: capitalize first word in sentence; add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 01/80: fold long line; add missing trailing semicolon, gnunet, 2021/03/17
- [taler-docs] 04/80: add question mark at end of sentence, gnunet, 2021/03/17
- [taler-docs] 03/80: add question mark at end of sentence, gnunet, 2021/03/17
- [taler-docs] 13/80: add period at end of sentence (two instances), gnunet, 2021/03/17
- [taler-docs] 09/80: add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 12/80: capitalize first word in sentence; add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 05/80: add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 06/80: fold long line; add period at end of sentence, gnunet, 2021/03/17
- [taler-docs] 11/80: add period at end of sentence, gnunet, 2021/03/17