taler-docs

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

testing-wait-exchange-state.rst (818B)

      1 .. ts:op:: testingWaitExchangeState
      2   :read-only:
      3 
      4   Wait until an exchange entry is in a particular state.  Currently,
      5   only the wallet KYC status of the exchange entry can be waited on.
      6   The operation blocks until this condition is met or the wait fails,
      7   for example when the request is cancelled.
      8 
      9   **Request:**
     10 
     11     The request must be a `TestingWaitExchangeStateRequest` object.
     12 
     13   **Response:**
     14 
     15     On success, the result is an empty object.
     16 
     17 .. ts:def:: TestingWaitExchangeStateRequest
     18 
     19   interface TestingWaitExchangeStateRequest {
     20     exchangeBaseUrl: string;
     21     walletKycStatus?: ExchangeWalletKycStatus;
     22   }
     23 
     24 .. ts:def:: ExchangeWalletKycStatus
     25 
     26   type ExchangeWalletKycStatus =
     27     | "done"
     28     // Wallet needs to request KYC status.
     29     | "legi-init"
     30     // User requires KYC or AML.
     31     | "legi";