summaryrefslogtreecommitdiff
path: root/core/api-bank-integration.rst
diff options
context:
space:
mode:
Diffstat (limited to 'core/api-bank-integration.rst')
-rw-r--r--core/api-bank-integration.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/core/api-bank-integration.rst b/core/api-bank-integration.rst
index cf41af49..3efe6ff3 100644
--- a/core/api-bank-integration.rst
+++ b/core/api-bank-integration.rst
@@ -47,6 +47,7 @@ to tightly integrate with GNU Taler.
// libtool-style representation of the Bank protocol version, see
// https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
+
// The format is "current:revision:age".
version: string;
@@ -67,7 +68,7 @@ Withdrawing
-----------
Withdrawals with a Taler-integrated bank are based on withdrawal operations.
-Some user interaction (on the bank's website or a Taler-enabled ATM) creates a
+Some user interaction (on the bank's websitei) creates a
withdrawal operation record in the bank's database. The wallet can use a unique identifier
for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdrawal operation.
@@ -106,6 +107,11 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
// @since **v1**
status: "pending" | "selected" | "aborted" | "confirmed";
+ // Currency used for the withdrawal.
+ // MUST be present when amount is absent.
+ // @since v2, may become mandatory in the future.
+ currency?: string;
+
// Amount that will be withdrawn with this operation
// (raw amount without fee considerations). Only
// given once the amount is fixed and cannot be changed.
@@ -242,6 +248,7 @@ for the withdrawal operation (the ``WITHDRAWAL_ID``) to interact with the withdr
// It may contain withdrawal operation id
confirm_transfer_url?: string;
+ // @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;