[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[taler-docs] branch master updated: make API more uniform, fix typos
From: |
gnunet |
Subject: |
[taler-docs] branch master updated: make API more uniform, fix typos |
Date: |
Wed, 13 Oct 2021 16:50:35 +0200 |
This is an automated email from the git hooks/post-receive script.
grothoff pushed a commit to branch master
in repository docs.
The following commit(s) were added to refs/heads/master by this push:
new 9f838cc make API more uniform, fix typos
9f838cc is described below
commit 9f838cc4c19c3e9c815757d8616393d9dd3b457f
Author: Christian Grothoff <christian@grothoff.org>
AuthorDate: Wed Oct 13 16:50:28 2021 +0200
make API more uniform, fix typos
---
core/api-exchange.rst | 42 ++++++++++++++----------------------------
1 file changed, 14 insertions(+), 28 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index da406ad..1aae8e7 100644
--- a/core/api-exchange.rst
+++ b/core/api-exchange.rst
@@ -1395,12 +1395,7 @@ exchange.
The user should be redirected to the provided location to perform
the required KYC checks to open the account before withdrawing.
Afterwards, the request should be repeated.
- The response will be an `AccountKycRedirect` object.
-
- FIXME: Alternatively, we could return only a
- PAYMENT_TARGET_UUID and expect the client to
- then do a ``/kyc/`` request. That might be
- more uniform with other APIs.
+ The response will be an `KycNeededRedirect` object.
Implementation note: internally, we need to
distinguish between upgrading the reserve to an
@@ -1492,6 +1487,16 @@ exchange.
}
+ .. ts:def:: KycNeededRedirect
+
+ interface KycNeededRedirect {
+ // Payment target that the merchant should
+ // use to check for its KYC status using
+ // the ``/kyc-check/$PAYMENT_TARGET_UUID`` endpoint.
+ payment_target_uuid: Integer;
+
+ }
+
.. ts:def:: WithdrawError
interface WithdrawError {
@@ -1694,7 +1699,7 @@ denomination.
// Payment target that the merchant should
// use to check for its KYC status using
- // the ``/kyc/$PAYMENT_TARGET_UUID`` endpoint.
+ // the ``/kyc-check/$PAYMENT_TARGET_UUID`` endpoint.
payment_target_uuid: Integer;
// Timestamp when the deposit was received by the exchange.
@@ -2547,7 +2552,7 @@ typically also view the balance.)
// Payment target that the merchant should
// use to check for its KYC status using
- // the ``/kyc/$PAYMENT_TARGET_UUID`` endpoint.
+ // the ``/kyc-check/$PAYMENT_TARGET_UUID`` endpoint.
payment_target_uuid: Integer;
// Raw wire transfer identifier of the deposit.
@@ -2580,7 +2585,7 @@ typically also view the balance.)
// Payment target that the merchant should
// use to check for its KYC status using
- // the ``/kyc/$PAYMENT_TARGET_UUID`` endpoint.
+ // the ``/kyc-check/$PAYMENT_TARGET_UUID`` endpoint.
payment_target_uuid: Integer;
// Time by which the exchange currently thinks the deposit will be
executed.
@@ -3183,15 +3188,6 @@ Wallet-to-wallet transfers
// public key used to create the signature.
exchange_pub: EddsaPublicKey;
- // Payment target that the recipient should
- // use to check for its KYC status using
- // the ``/kyc/$PAYMENT_TARGET_UUID`` endpoint.
- //
- // FIXME: may need to be a URL in case the
- // exchange is foreign, alas, in this case
- // we ALSO don't know the target UUID!
- // => make optional?
- payment_target_uuid: Integer;
}
.. ts:def:: MergeAccepted
@@ -3202,16 +3198,6 @@ Wallet-to-wallet transfers
// under the given account.
remaining_purses: Integer;
- // Payment target that the recipient should
- // use to check for its KYC status using
- // the ``/kyc/$PAYMENT_TARGET_UUID`` endpoint.
- //
- // FIXME: may need to be a URL in case the
- // exchange is foreign, alas, in this case
- // we ALSO don't know the target UUID!
- // => make optional?
- payment_target_uuid: Integer;
-
}
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [taler-docs] branch master updated: make API more uniform, fix typos,
gnunet <=