taler-docs

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

forget-bank-account.rst (583B)

      1 .. ts:op:: forgetBankAccount
      2 
      3   Remove a known bank account.
      4 
      5   **Request:**
      6 
      7     The request must be a `ForgetBankAccountRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object (`EmptyObject`).
     12 
     13   **Side effects:**
     14 
     15     Removes the bank account from the wallet's database.  A
     16     ``bank-account-change`` notification is emitted.
     17 
     18   **Expected errors:**
     19 
     20     The caller can handle the following errors inline:
     21     ``WALLET_BANK_ACCOUNT_NOT_FOUND``.
     22 
     23 .. ts:def:: ForgetBankAccountRequest
     24 
     25   interface ForgetBankAccountRequest {
     26     bankAccountId: string;
     27   }