package achivx.transactions

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc PayToAccount (AccountPaymentRequest, TransactionDetails)

  transactions.proto:11

  * Pay specified amount of internal tokens to given account. Creates a transaction and returns it's details.

  message AccountPaymentRequest

  transactions.proto:168

  • string account = 1

    Id of account to pay to

  • string amount = 2

    How much tokens should the account receive. Must be a positive number.

  • TransactionStatus status = 3

    Initial status of transaction. Acceptable statuses are HOLD, PAID. The transaction will not be created and invalid argument error will be returned if any other status is provided. If not provided, transaction will be created as PAID.

  • repeated MetadataEntry meta = 4

    Metadata to attach to the transaction.

• rpc GetTransactionDetails (TransactionDetailsRequest, TransactionDetails)

  transactions.proto:16

  * Get detailed information about single transaction.

  message TransactionDetailsRequest

  transactions.proto:164

  • string id = 1

• rpc GetTransactionsList (TransactionListRequest, stream TransactionDetails)

  transactions.proto:21

  * Get multiple transactions matching specified conditions.

  message TransactionListRequest

  transactions.proto:188

  • int64 offset = 1

    Number of matching transactions from beginning of list to skip.

  • int64 limit = 2

    Max. number of transactions to return. If 0 or missing, all matching transactions will be returned.

  • string account = 3

    Return only transactions for given account

  • repeated TransactionStatus includeStatuses = 4

    Return only transactions in one of these statuses. If no statuses are given here - transactions in any status will be returned.

  • optional bool isWithdrawal = 5

    Return only transactions that are (or are not) withdrawal transactions. If omitted, both withdrawal and non-withdrawal transactions will be returned.

• rpc ApproveTransaction (TransactionApprovalRequest, TransactionDetails)

  transactions.proto:28

  * Approve a transaction currently in HOLD status. This will change transaction's status to either PAID or APPROVED, depending on if the transaction requires any blockchain operations.

  message TransactionApprovalRequest

  transactions.proto:211

  • string id = 1

    Id of transaction to approve

• rpc DenyTransaction (TransactionDenialRequest, TransactionDetails)

  transactions.proto:35

  * Deny a transaction currently in HOLD status. This will change transaction's status to DENIED.

  message TransactionDenialRequest

  transactions.proto:216

  • string id = 1

    Id of transaction to deny

• rpc RequestWithdrawal (WithdrawalRequest, TransactionDetails)

  transactions.proto:44

  * Request withdrawal of tokens. In case of success, it creates a transaction in HOLD status and returns it's details. The transaction can then be either approved or denied using ApproveTransaction or DenyTransaction procedures. When approved, the transaction will have APPROVED status and will wait for blockchain operations to be performed.

  message WithdrawalRequest

  transactions.proto:221

  • string account = 1

    Id of an account requesting withdrawal.

  • string currency = 2

    Id of blockchain currency/token to use.

  • string rate = 3

    Cost of one unit of target currency in internal tokens.

  • string amount = 4

    Amount of internal tokens to withdraw. If omitted, all available tokens will be withdrawn.

  • repeated MetadataEntry meta = 5

    Metadata to add to withdrawal transaction.

• rpc RestoreWithdrawalStatus (WithdrawalRestorationRequest, TransactionDetails)

  transactions.proto:55

  * Update status of a withdrawal transaction in SENDING or SEND_UNKNOWN_ERROR statuses. This procedure can be used to: - restore transaction after an unknown error which cannot be handled automatically happened while sending it to blockchain (status SEND_UNKNOWN_ERROR) - notify system about change of blockchain transaction status change before it is detected automatically or when it could not be detected automatically (status SENDING)

  message WithdrawalRestorationRequest

  transactions.proto:240

  • string id = 1

    Id of the transaction.

  • TransactionStatus status = 2

    New transaction status. Should be either: - SEND_FAILED if transaction has failed and should be re-sent - DENIED if the transaction has failed an should not be re-sent - MINED if the transaction has succeed

Key-value pair for transaction metadata. TODO: This is necessary 'cause grpc-node + @grpc/reflection + grpcurl don't work well together when there are maps in protocol definition.

Used in: AccountPaymentRequest, TransactionDetails, WithdrawalRequest

• string name = 1

• string value = 2

Used as response type in: Transactions.ApproveTransaction, Transactions.DenyTransaction, Transactions.GetTransactionDetails, Transactions.GetTransactionsList, Transactions.PayToAccount, Transactions.RequestWithdrawal, Transactions.RestoreWithdrawalStatus

• string id = 1

  Id of transaction.

• string account = 2

  Id of account.

• string amount = 3

  Amount of account's balance change.

• TransactionStatus status = 4

  Current status of the transaction.

• repeated MetadataEntry meta = 5

  Metadata of the transaction. Metadata can be used to store additional information about transaction. E.g.: - a flag that indicates that a transaction is a reward for certain action - identifier of what action is this reward given for

• string timestamp = 6

  Transaction creation timestamp. Represented as ISO-8601 string.

• optional TransactionWithdrawalDetails withdrawal = 7

  If this transaction is a withdrawal transaction - contains withdrawal-related data

Used in: AccountPaymentRequest, TransactionDetails, TransactionListRequest, WithdrawalRestorationRequest

• PAID = 0

  * Transaction does not have associated blockchain operations and was performed successfully.

• HOLD = 1

  * Transaction was created but requires confirmation. Transaction from this status can also be safely cancelled (by changing status to DENIED).

• DENIED = 2

  * Transaction was cancelled.

• APPROVED = 3

  * Transaction was approved but requires associated blockchain operations to be performed.

• SENDING = 4

  * Associated blockchain operations are being performed with no known result yet.

• SEND_FAILED = 5

  * The transaction was approved but attempt to send associated operation to blockchain failed and should be retried again.

• SEND_UNKNOWN_ERROR = 6

  * The transaction was approved but attempt to send associated operation to blockchain ended with unknown result. This status requires manual update of transaction status after check of blockchain content.

• MINED = 7

  * Transaction did require associated blockchain operations but now they're completed.

Used in: TransactionDetails

• bool isWithdrawal = 1

  True iff this is a withdrawal transaction

• string currencyId = 2

  Name of target currency the user receives in exchange for internal tokens

• string withdrawalAddress = 3

  Address to withdraw tokens to This is user's withdrawal wallet for blockchain network corresponding to the target currency. It is stored at the moment of withdrawal transaction creation and cannot be changed later.

• string amount = 4

  How much of target currency the user receives

• string transactionId = 5

  Id/hash of the transaction

• string transactionUrl = 6

  URL of the transaction in blockchain explorer such as tronscan or etherscan

• string error = 7

  Text of the last error. Note that this field may exist for a successfully completed transaction. Use transaction status to determine if transaction was successful or not.