summaryrefslogtreecommitdiff
path: root/core/api-exchange.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-01-11 17:33:20 +0100
committerChristian Grothoff <christian@grothoff.org>2023-01-11 17:33:20 +0100
commit55e214061688073779f305abe6432c65b718c9a9 (patch)
tree4ab61da1ebc10567328375a2c36c5821ab908bae /core/api-exchange.rst
parentd101a65394eae7d2a50cb3e4c443ef6cae470230 (diff)
downloaddocs-55e214061688073779f305abe6432c65b718c9a9.tar.gz
docs-55e214061688073779f305abe6432c65b718c9a9.tar.bz2
docs-55e214061688073779f305abe6432c65b718c9a9.zip
-return EC as part of 451 KYC required replies
Diffstat (limited to 'core/api-exchange.rst')
-rw-r--r--core/api-exchange.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index 34f6957a..6b7031c0 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1791,6 +1791,14 @@ exchange.
interface KycNeededRedirect {
+ // Numeric `error code <error-codes>` unique to the condition.
+ // Should always be ``TALER_EC_EXCHANGE_GENERIC_KYC_REQUIRED``.
+ code: number;
+
+ // Human-readable description of the error, i.e. "missing parameter", "commitment violation", ...
+ // Should give a human-readable hint about the error's nature. Optional, may change without notice!
+ hint?: string;
+
// Hash of the payto:// account URI that identifies
// the account which is being KYCed.
h_payto: PaytoHash;