summaryrefslogtreecommitdiff
path: root/core/api-merchant.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2020-06-07 21:58:00 +0200
committerChristian Grothoff <christian@grothoff.org>2020-06-07 21:58:00 +0200
commit1d396d031a03e12501bb9b06b642366c7fbe4313 (patch)
treeb4c1f4907a216d9bb648acfc537c1807e4c6ab80 /core/api-merchant.rst
parenta8a4774c1abec363cc7f178804ac56c558b069f0 (diff)
downloaddocs-1d396d031a03e12501bb9b06b642366c7fbe4313.tar.gz
docs-1d396d031a03e12501bb9b06b642366c7fbe4313.tar.bz2
docs-1d396d031a03e12501bb9b06b642366c7fbe4313.zip
work on spec for GET /private/orders/ID
Diffstat (limited to 'core/api-merchant.rst')
-rw-r--r--core/api-merchant.rst31
1 files changed, 29 insertions, 2 deletions
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
index 03aefed7..2110a897 100644
--- a/core/api-merchant.rst
+++ b/core/api-merchant.rst
@@ -1079,19 +1079,32 @@ Receiving Payments
.. ts:def:: CheckPaymentPaidResponse
interface CheckPaymentPaidResponse {
+ // did the customer pay for this contract
paid: true;
// Was the payment refunded (even partially)
refunded: boolean;
- // Amount that was refunded, only present if refunded is true.
+ // Total amount the exchange deposited into our bank account
+ // for this contract, excluding fees.
+ deposits_total: Amount;
+
+ // Total value of the coins the exchange deposited into our bank account
+ // for this contract, includes the fees (which the exchange charged).
+ transfer_value_total: Amount;
+
+ // Total amount that was refunded, only present if refunded is true.
refund_amount?: Amount;
// Contract terms
contract_terms: ContractTerms;
// If available, the wire transfer status from the exchange for this order
- wire_details?: TransactionWireTransfer;
+ wire_details?: TransactionWireTransfer[];
+
+ // If available, the refund details for this order. One entry per
+ // refunded coin.
+ refund_details?: RefundDetails[];
}
.. ts:def:: CheckPaymentUnpaidResponse
@@ -1110,6 +1123,20 @@ Receiving Payments
// exist in case the wallet did not yet claim them.
}
+ .. ts:def:: RefundDetails
+
+ interface RefundDetails {
+
+ // Reason given for the refund
+ reason: string;
+
+ // when was the refund approved
+ timestamp: Timestamp;
+
+ // Total amount that was refunded (minus a refund fee).
+ amount: Amount;
+ }
+
.. ts:def:: TransactionWireTransfer
interface TransactionWireTransfer {