summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoine A <>2024-04-04 16:20:02 +0200
committerAntoine A <>2024-04-04 16:20:37 +0200
commit974384a36e9b8aadf09d3f6bb2bd04a18e821e81 (patch)
tree4c40d271303f76775c6eec89c1b629eb2a316a7c
parent053a2f78557287762799970a9ebff1f9df906e34 (diff)
downloaddocs-974384a36e9b8aadf09d3f6bb2bd04a18e821e81.tar.gz
docs-974384a36e9b8aadf09d3f6bb2bd04a18e821e81.tar.bz2
docs-974384a36e9b8aadf09d3f6bb2bd04a18e821e81.zip
Update corebank API
-rw-r--r--core/api-bank-integration.rst12
-rw-r--r--core/api-corebank.rst5
2 files changed, 11 insertions, 6 deletions
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
index a4d91f33..b5f076ad 100644
--- a/core/api-bank-integration.rst
+++ b/core/api-bank-integration.rst
@@ -103,7 +103,7 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
// selected: the operations has been selected and is pending confirmation
// aborted: the operation has been aborted
// confirmed: the transfer has been confirmed and registered by the bank
- // Since protocol v1.
+ // @since v1
status: "pending" | "selected" | "aborted" | "confirmed";
// Amount that will be withdrawn with this operation
@@ -128,25 +128,25 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
// Reserve public key selected by the exchange,
// only non-null if ``status`` is ``selected`` or ``confirmed``.
- // Since protocol v1.
+ // @since v1
selected_reserve_pub?: string;
// Exchange account selected by the wallet
// only non-null if ``status`` is ``selected`` or ``confirmed``.
- // Since protocol v1.
+ // @since v1
selected_exchange_account?: string;
- // Deprecated field since protocol v1 use ``status`` instead
+ // @deprecated since v1, use ``status`` instead
// Indicates whether the withdrawal was aborted.
aborted: boolean;
- // Deprecated field since protocol v1 use ``status`` instead
+ // @deprecated since v1, use ``status`` instead
// Has the wallet selected parameters for the withdrawal operation
// (exchange and reserve public key) and successfully sent it
// to the bank?
selection_done: boolean;
- // Deprecated field since protocol v1 use ``status`` instead
+ // @deprecated since v1, use ``status`` instead
// The transfer has been confirmed and registered by the bank.
// Does not guarantee that the funds have arrived at the exchange already.
transfer_done: boolean;
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
index ec1d23d2..2817185c 100644
--- a/core/api-corebank.rst
+++ b/core/api-corebank.rst
@@ -1091,10 +1091,15 @@ Monitor
* month
* year
+ :query date_s: *Optional*.
+ Non-negative date in seconds after the UNIX Epoch. Default to current time.
+ @since v4
+
:query which: *Optional*.
This parameter points at a particular element of the *timeframe* parameter.
Following are the admitted values for each one.
Default to the last snapshot taken of the *timeframe* parameter.
+ @deprecated since v4
* hour: from 00 to 23
* day: from 1 to the last day of the current month.