GET /accounts/$USERNAME

Obtains information relative to the account owned by $USERNAME. The request is available to the administrator and $USERNAME itself.

Response:

200 OK:

The bank responds with an AccountData object.

401 Unauthorized:

Invalid or missing credentials.

403 Forbidden:

Missing rights.

404 Not found:

The account pointed by $USERNAME was not found.

Details:

interface AccountData {
  // Legal name of the account owner.
  name: string;

  // Available balance on the account.
  balance: Balance;

  // Full payto URI of the account.
  payto_uri: string;

  // Number indicating the max debit allowed for the requesting user.
  debit_threshold: Amount;

  // Custom minimum cashout amount for this account.
  // If null or absent, the global conversion fee is used.
  // @since **v6**
  // @deprecated in **v9**, use conversion_rate_class_id instead
  min_cashout?: Amount;

  // Addresses where to send the TAN for transactions.
  // Currently only used for cashouts.
  // If missing, cashouts will fail.
  // In the future, might be used for other transactions
  // as well.
  contact_data?: ChallengeContactData;

  // Full 'payto' URI of a fiat bank account where to send cashouts with
  // name as the 'receiver-name'.
  // This field is optional
  // because not all the accounts are required to participate
  // in the merchants' circuit.  One example is the exchange:
  // that never cashouts.  Registering these accounts can
  // be done via the access API.
  cashout_payto_uri?: string;

  // Is this account visible to anyone?
  is_public: boolean;

  // Is this a taler exchange account?
  is_taler_exchange: boolean;

  // Is the account locked.
  // Defaults to false.
  // @deprecated since **v7**
  is_locked?: boolean;

  // @deprecated in **v10**
  // Is 2FA enabled and what channel is used for challenges?
  tan_channel?: TanChannel;

  // Is 2FA enabled and what channels are used for challenges?
  // @since **v10**
  tan_channels?: TanChannel[];

  // Current status of the account
  // active: the account can be used
  // locked: the account can be used but cannot create new tokens
  // @since **v7**
  // deleted: the account has been deleted but is retained for compliance
  // reasons, only the administrator can access it
  // Defaults to 'active' is missing
  // @since **v4**, will become mandatory in the next version.
  status?: "active" | "locked" | "deleted";

  // Conversion rate class of the user
  // Only present if conversion is activated on the server
  // @since **v9**
  conversion_rate_class_id?: Integer;
}