taler-docs

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

patch-accounts-USERNAME.rst (3163B)

      1 .. http:patch:: /accounts/$USERNAME
      2 
      3   Allows reconfiguring the account data of ``$USERNAME``.
      4 
      5   **Request:**
      6 
      7   .. ts:def:: AccountReconfiguration
      8 
      9     interface AccountReconfiguration {
     10       // Addresses where to send the TAN for protected operations.
     11       contact_data?: ChallengeContactData;
     12 
     13       // Payto URI of a fiat bank account.
     14       // Payments will be sent to this bank account
     15       // when the user wants to convert the regional currency
     16       // back to fiat currency outside bank.
     17       // Only admin can change this property if not allowed in config
     18       // Sending null will disable cashout
     19       cashout_payto_uri?: string | null;
     20 
     21       // If present, change the legal name associated with $username.
     22       // Only admin can change this property if not allowed in config
     23       name?: string;
     24 
     25       // Make this account visible to anyone?
     26       is_public?: boolean;
     27 
     28       // If present, change the max debit allowed for this user
     29       // Only admin can change this property.
     30       debit_threshold?: Amount;
     31 
     32       // If present, set the user conversion rate class
     33       // Only admin can set this property.
     34       // Sending null will remove the class and switch to default class
     35       // @since **v9**
     36       conversion_rate_class_id?: Integer | null;
     37 
     38       // @deprecated in **v10**
     39       // If present, enables 2FA and set the TAN channel used for challenges
     40       // Sending null will disable 2FA
     41       tan_channel?: TanChannel | null;
     42 
     43       // If present and not empty, enables 2FA and set the TAN channels used for challenges
     44       // Sending null or an empty array will disable 2FA
     45       // @since **v10**
     46       tan_channels?: TanChannel[] | null;
     47 
     48       // @deprecated in **v9**, user conversion rate classes instead
     49       min_cashout?: Amount;
     50     }
     51 
     52   **Response:**
     53 
     54   :http:statuscode:`202 Accepted`:
     55     2FA is required for this operation. This returns the `ChallengeResponse` response. @since **v10**
     56   :http:statuscode:`204 No content`:
     57     Operation successful.
     58   :http:statuscode:`401 Unauthorized`:
     59     Invalid or missing credentials.
     60   :http:statuscode:`403 Forbidden`:
     61     Missing rights.
     62   :http:statuscode:`404 Not found`:
     63     The account pointed by ``$USERNAME`` was not found.
     64   :http:statuscode:`409 Conflict`:
     65     * ``TALER_EC_BANK_NON_ADMIN_PATCH_LEGAL_NAME`` : a non-admin user has tried to change their legal name.
     66     * ``TALER_EC_BANK_NON_ADMIN_PATCH_CASHOUT`` : a non-admin user has tried to change their cashout account.
     67     * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT`` : a non-admin user has tried to change their debt limit.
     68     * ``TALER_EC_BANK_NON_ADMIN_SET_CONVERSION_RATE_CLASS`` : a non-admin user has tried to create an account with a conversion rate class. Since **v9**
     69     * ``TALER_EC_BANK_TAN_CHANNEL_NOT_SUPPORTED`` : ``tan_channel`` or one of ``tan_channels`` is not supported, check bank config to find supported ones.
     70     * ``TALER_EC_BANK_MISSING_TAN_INFO`` : the user did not share any contact data where to send the TAN via ``tan_channel`` or one of ``tan_channels``.
     71     * ``TALER_EC_BANK_CONVERSION_RATE_CLASS_UNKNOWN`` : no conversion rate class found for this id. Since **v9**