package achivx.accounts

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetAccountDetails (AccountDetailsRequest, AccountDetailsResponse)

  accounts.proto:10

  Returns detailed information about single account. Responds with not found error code if the account was not created in the system.

  message AccountDetailsRequest

  accounts.proto:48

  A request to get detailed account info.

  • string id = 1

• rpc UpsertAccount (AccountUpsertRequest, AccountDetailsResponse)

  accounts.proto:17

  Adds account to the system. Must be called for each account before performing any other actions (such as AddWithdrawalAddress, Transactions.PayToAccount, etc.) with it. This procedure is idempotent - repeated calls with the same account id are allowed.

  message AccountUpsertRequest

  accounts.proto:72

  • string id = 1

    Identifier of the account. Use stringified form of any type of identifier your system uses. Note that even if the account identifiers are numbers, they are still compared as strings. So, for example "1", "01", "1.0" are three different account identifiers.

  • optional string registeredAt = 2

    Account registration date, encoded as ISO-8601 string. Defaults to previously provided value (if account document already exists) or current date (if it doesn't).

• rpc TrackAccountActivity (AccountActivityTrackRequest, AccountDetailsResponse)

  accounts.proto:23

  Notify the system that an account did perform some activity. This procedure may update lastActiveAt field of the account, the same way as when an action is created. It enables detection of active/inactive accounts, which is used by some parts of gamification functionality.

  message AccountActivityTrackRequest

  accounts.proto:87

  • string account = 1

  • optional string timestamp = 2

    Timestamp of account activity, encoded as ISO-8601 string. If omitted, the current time will be used. If current lastActiveAt of account is after this timestamp, it will not be updated.

• rpc AddWithdrawalAddress (WithdrawalAddressAddRequest, AccountDetailsResponse)

  accounts.proto:26

  Add a withdrawal wallet address to an account.

  message WithdrawalAddressAddRequest

  accounts.proto:39

  • string account = 1

  • string network = 2

  • string address = 3

Used as response type in: Accounts.AddWithdrawalAddress, Accounts.GetAccountDetails, Accounts.TrackAccountActivity, Accounts.UpsertAccount

• string id = 1

• string balance = 2

  Balance of account's internal wallet.

• repeated WithdrawalAddress withdrawalAddresses = 3

  Blockchain addresses this account uses to withdraw tokens.

• int32 level = 4

• int32 experience = 5

• string lastActiveAt = 6

  Timestamp of most recent account activity, encoded as ISO-8601 string. Can be updated by TrackAccountActivity or when creating an Action.

• string registeredAt = 7

  Account registration date, encoded as ISO-8601 string.

Used in: AccountDetailsResponse

• string network = 1

  Name of blockchain this address is meant for

• string address = 2

  The address represented as string. Address format is different for different networks.