taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

start-exchange-wallet-kyc.rst (1056B)

      1 .. ts:op:: startExchangeWalletKyc
      2 
      3   Start the wallet KYC process at an exchange, requesting
      4   authorization to hold funds up to the given amount threshold.
      5 
      6   **Request:**
      7 
      8   The request arguments must be a `StartExchangeWalletKycRequest`
      9   object.
     10 
     11   **Response:**
     12 
     13   On success, the result is an empty object.
     14 
     15   **Side effects:**
     16 
     17   Starts the wallet KYC process at the exchange over the network;
     18   progress is reported via transactions and notifications.
     19 
     20   **Details:**
     21 
     22   The request only initiates the KYC process; the wallet then drives
     23   it in the background and reports status changes via notifications.
     24   If a KYC threshold of at least ``amount`` was already granted or
     25   is already being requested, the operation does nothing.  Once
     26   started, the exchange entry is marked as used, as the wallet keeps
     27   an account at the exchange.
     28 
     29 .. ts:def:: StartExchangeWalletKycRequest
     30 
     31   interface StartExchangeWalletKycRequest {
     32     exchangeBaseUrl: string;
     33 
     34     // Amount threshold that the KYC process should authorize.
     35     amount: AmountString;
     36   }