taler-docs

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

testing-wait-wallet-kyc.rst (812B)

      1 .. ts:op:: testingWaitWalletKyc
      2   :read-only:
      3 
      4   Wait for the wallet KYC process at an exchange.  With ``passed`` set
      5   to true, waits until KYC has been passed for at least the given
      6   ``amount``; otherwise already returns when legitimization is
      7   required.  The operation blocks until this condition is met or the
      8   wait fails, for example when the request is cancelled.
      9 
     10   **Request:**
     11 
     12     The request must be a `TestingWaitWalletKycRequest` object.
     13 
     14   **Response:**
     15 
     16     On success, the result is an empty object.
     17 
     18 .. ts:def:: TestingWaitWalletKycRequest
     19 
     20   interface TestingWaitWalletKycRequest {
     21     exchangeBaseUrl: string;
     22     amount: AmountString;
     23 
     24     // Do we wait for the KYC to be passed (true),
     25     // or do we already return if legitimization is
     26     // required (false).
     27     passed: boolean;
     28   }