summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--core/api-exchange.rst42
1 files changed, 14 insertions, 28 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
index da406add..1aae8e75 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;
-
}