diff options
Diffstat (limited to 'core')
| -rw-r--r-- | core/api-exchange.rst | 44 | ||||
| -rw-r--r-- | core/api-merchant.rst | 8 |
2 files changed, 19 insertions, 33 deletions
diff --git a/core/api-exchange.rst b/core/api-exchange.rst index d25c2e52..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; - } @@ -3373,7 +3359,7 @@ KYC status updates // EdDSA signature of the exchange affirming the account // is KYC'ed, must be of purpose - // ``TALER_SIGNATURE_ACCOUNT_SETUP_SUCCESS`` + // ``TALER_SIGNATURE_EXCHANGE_ACCOUNT_SETUP_SUCCESS`` // and over `TALER_AccountSetupStatusSignaturePS`. exchange_sig: EddsaSignature; diff --git a/core/api-merchant.rst b/core/api-merchant.rst index c9981543..519a4324 100644 --- a/core/api-merchant.rst +++ b/core/api-merchant.rst @@ -1219,7 +1219,7 @@ KYC status checks :query h_wire=H_WIRE: *Optional*. If specified, the KYC check should return the KYC status only for this wire account. Otherwise, for all wire accounts. :query exchange_url=URL: *Optional*. If specified, the KYC check should return the KYC status only for the given exchange. Otherwise, for all exchanges we interacted with. - :query timeout_ms=NUMBER: *Optional.* If specified, the exchange will + :query timeout_ms=NUMBER: *Optional.* If specified, the merchant will wait up to ``timeout_ms`` milliseconds for the exchanges to confirm completion of the KYC process(es). **Response:** @@ -1261,7 +1261,7 @@ KYC status checks // URL that the user should open in a browser to // proceed with the KYC process (as returned - // by the exchange's ``/kyc/`` endpoint). + // by the exchange's ``/kyc-check/`` endpoint). kyc_url: string; // Base URL of the exchange this is about. @@ -1272,9 +1272,9 @@ KYC status checks } - .. ts:def:: MerchantAccountKycRedirect + .. ts:def:: ExchangeKycTimeout - interface MerchantAccountKycRedirect { + interface ExchangeKycTimeout { // Base URL of the exchange this is about. exchange_url: string; |