taler-docs

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

list-bank-accounts.rst (1210B)

      1 .. ts:op:: listBankAccounts
      2   :read-only:
      3 
      4   List bank accounts known to the wallet from previous withdrawals.
      5 
      6   **Request:**
      7 
      8     The request must be a `ListBankAccountsRequest` object.
      9 
     10   **Response:**
     11 
     12     On success, the result is a `ListBankAccountsResponse` object.
     13 
     14   **Details:**
     15 
     16     When ``currency`` is specified, only accounts that support the
     17     currency are returned; accounts whose supported currencies are
     18     unknown are always included.  Stored accounts whose ``paytoUri``
     19     can no longer be parsed are silently skipped.
     20 
     21 .. ts:def:: ListBankAccountsRequest
     22 
     23   interface ListBankAccountsRequest {
     24     currency?: string;
     25   }
     26 
     27 .. ts:def:: ListBankAccountsResponse
     28 
     29   interface ListBankAccountsResponse {
     30     accounts: WalletBankAccountInfo[];
     31   }
     32 
     33 .. ts:def:: WalletBankAccountInfo
     34 
     35   interface WalletBankAccountInfo {
     36     bankAccountId: string;
     37 
     38     paytoUri: string;
     39 
     40     // Did we previously complete a KYC process for this bank account?
     41     // Deprecated: the KYC may have been completed for one exchange
     42     // but not for another.
     43     kycCompleted: boolean;
     44 
     45     // Currencies supported by the bank, if known.
     46     currencies: string[] | undefined;
     47 
     48     label: string | undefined;
     49   }