Protocol Documentation
Table of Contents
Top
processing/client/v1/client.proto
CreateRequest
| Field |
Type |
Label |
Description |
| callback_url |
string |
|
|
| backend_ip |
string |
optional |
|
| merchant_domain |
string |
optional |
|
| backend_version |
string |
|
|
CreateResponse
GetCallbackURLRequest
| Field |
Type |
Label |
Description |
| client_id |
string |
|
|
GetCallbackURLResponse
| Field |
Type |
Label |
Description |
| callback_url |
string |
|
|
UpdateCallbackURLRequest
| Field |
Type |
Label |
Description |
| client_id |
string |
|
|
| callback_url |
string |
|
|
UpdateCallbackURLResponse
ClientService
Service which interacts with client
Top
processing/common/v1/common.proto
BitcoinAddressType
| Name |
Number |
Description |
| BITCOIN_ADDRESS_TYPE_UNSPECIFIED |
0 |
|
| BITCOIN_ADDRESS_TYPE_P2PKH |
1 |
Legacy |
| BITCOIN_ADDRESS_TYPE_P2SH |
2 |
SegWit |
| BITCOIN_ADDRESS_TYPE_SEGWIT |
3 |
Native SegWit or Bech32 |
| BITCOIN_ADDRESS_TYPE_P2TR |
4 |
Taproot address or Bech32m |
Blockchain
| Name |
Number |
Description |
| BLOCKCHAIN_UNSPECIFIED |
0 |
|
| BLOCKCHAIN_TRON |
1 |
|
| BLOCKCHAIN_BITCOIN |
2 |
|
| BLOCKCHAIN_ETHEREUM |
3 |
|
| BLOCKCHAIN_LITECOIN |
4 |
|
| BLOCKCHAIN_BITCOINCASH |
5 |
|
| BLOCKCHAIN_BINANCE_SMART_CHAIN |
6 |
|
| BLOCKCHAIN_POLYGON |
7 |
|
| BLOCKCHAIN_ARBITRUM |
8 |
|
| BLOCKCHAIN_OPTIMISM |
9 |
|
| BLOCKCHAIN_LINEA |
10 |
|
| BLOCKCHAIN_SOLANA |
11 |
|
| BLOCKCHAIN_MONERO |
12 |
|
| BLOCKCHAIN_DOGECOIN |
13 |
|
| BLOCKCHAIN_TON |
14 |
|
DogecoinAddressType
| Name |
Number |
Description |
| DOGECOIN_ADDRESS_TYPE_UNSPECIFIED |
0 |
|
| DOGECOIN_ADDRESS_TYPE_P2PKH |
1 |
Legacy |
IncomingWalletType
| Name |
Number |
Description |
| INCOMING_WALLET_TYPE_UNSPECIFIED |
0 |
|
| INCOMING_WALLET_TYPE_HOT |
1 |
|
| INCOMING_WALLET_TYPE_PROCESSING |
2 |
|
LitecoinAddressType
| Name |
Number |
Description |
| LITECOIN_ADDRESS_TYPE_UNSPECIFIED |
0 |
|
| LITECOIN_ADDRESS_TYPE_P2PKH |
1 |
Legacy |
| LITECOIN_ADDRESS_TYPE_P2SH |
2 |
SegWit |
| LITECOIN_ADDRESS_TYPE_SEGWIT |
3 |
Native SegWit or Bech32 |
| LITECOIN_ADDRESS_TYPE_P2TR |
4 |
Taproot address or Bech32m |
TransactionType
| Name |
Number |
Description |
| TRANSACTION_TYPE_UNSPECIFIED |
0 |
|
| TRANSACTION_TYPE_TRANSFER |
1 |
|
| TRANSACTION_TYPE_DEPOSIT |
2 |
|
TransferStatus
| Name |
Number |
Description |
| TRANSFER_STATUS_UNSPECIFIED |
0 |
|
| TRANSFER_STATUS_ACCEPTED |
1 |
|
| TRANSFER_STATUS_SUCCESS |
2 |
|
| TRANSFER_STATUS_FAILED |
3 |
|
Top
processing/owner/v1/owner.proto
ConfirmTwoFactorAuthRequest
ConfirmTwoFactorAuthResponse
CreateRequest
| Field |
Type |
Label |
Description |
| client_id |
string |
|
|
| external_id |
string |
|
External id of store |
| mnemonic |
string |
|
|
CreateResponse
| Field |
Type |
Label |
Description |
| id |
string |
|
|
DisableTwoFactorAuthRequest
DisableTwoFactorAuthResponse
GetHotWalletKeysItem
GetHotWalletKeysRequest
| Field |
Type |
Label |
Description |
| owner_id |
string |
|
|
| otp |
string |
|
|
| wallet_addresses |
string |
repeated |
|
| excluded_wallet_addresses |
string |
repeated |
|
GetHotWalletKeysResponse
GetPrivateKeysRequest
GetPrivateKeysResponse
GetPrivateKeysResponse.KeysEntry
GetSeedsRequest
GetSeedsResponse
| Field |
Type |
Label |
Description |
| mnemonic |
string |
|
|
| pass_phrase |
string |
|
|
GetTwoFactorAuthDataRequest
| Field |
Type |
Label |
Description |
| owner_id |
string |
|
|
GetTwoFactorAuthDataResponse
| Field |
Type |
Label |
Description |
| secret |
string |
optional |
|
| is_confirmed |
bool |
|
|
KeyPair
KeyPairSequence
| Field |
Type |
Label |
Description |
| pairs |
KeyPair |
repeated |
|
PrivateKeyItem
ValidateTwoFactorTokenRequest
ValidateTwoFactorTokenResponse
OwnerService
Service which interacts with owner
Top
processing/system/v1/system.proto
CheckNewVersionRequest
CheckNewVersionResponse
| Field |
Type |
Label |
Description |
| name |
string |
|
|
| installed_version |
string |
|
|
| available_version |
string |
|
|
| need_for_update |
bool |
|
|
GetLastLogsRequest
GetLastLogsResponse
| Field |
Type |
Label |
Description |
| logs |
LogEntry |
repeated |
|
InfoRequest
InfoResponse
LogEntry
UpdateToNewVersionRequest
UpdateToNewVersionResponse
| Field |
Type |
Label |
Description |
| status |
string |
|
|
SystemService
Service which provides system information
Top
processing/transfer/v1/transfer.proto
CancelRequest
| Field |
Type |
Label |
Description |
| owner_id |
string |
|
|
| request_id |
string |
|
|
CancelResponse
| Field |
Type |
Label |
Description |
| item |
Transfer |
|
|
CheckRefundRequest
CheckRefundResponse
| Field |
Type |
Label |
Description |
| estimated_fee |
string |
optional |
Estimated network fee paid by the hot wallet in the native coin. Empty if it is calculated only on sending (btc like blockchains) |
| fee_from_amount |
bool |
|
The fee is subtracted from the refund amount (refunds of the native coin) |
| to_sender |
bool |
|
The destination is the sender of the deposit: the refund does not require TOTP |
| fee_balance |
string |
optional |
Native coin balance of the hot wallet that pays the fee (refunds of tokens only) |
| fee_shortage |
string |
optional |
Native coin to add to the hot wallet to pay the fee, "0" when the fee is covered (tokens only) |
| activation_required |
bool |
|
TRON: the hot wallet is not activated, it must receive TRX before the refund |
CreateRequest
| Field |
Type |
Label |
Description |
| owner_id |
string |
|
|
| request_id |
string |
|
|
| blockchain |
processing.common.v1.Blockchain |
|
|
| from_addresses |
string |
repeated |
|
| to_addresses |
string |
repeated |
|
| asset_identifier |
string |
|
|
| whole_amount |
bool |
|
withdraw the entire amount from the wallet |
| amount |
string |
optional |
|
| kind |
string |
optional |
delegate / burn / etc... |
| fee |
string |
optional |
|
| fee_max |
string |
optional |
|
| purpose |
TransferPurpose |
|
|
| source_tx_hash |
string |
optional |
Required for refunds: hash of the incoming deposit to the from address. Amount must not exceed the deposited amount, one active refund per deposit |
| totp |
string |
optional |
Owner's TOTP code. Required for withdrawals to external addresses and refunds to addresses other than the deposit sender. For refunds to the sender it skips the cooldown |
CreateResponse
| Field |
Type |
Label |
Description |
| item |
Transfer |
|
|
ExecuteNowRequest
ExecuteNowResponse
| Field |
Type |
Label |
Description |
| item |
Transfer |
|
|
GetByRequestIDRequest
| Field |
Type |
Label |
Description |
| request_id |
string |
|
|
GetByRequestIDResponse
| Field |
Type |
Label |
Description |
| item |
Transfer |
|
|
Transfer
Transfer
TransferTransaction
Transfer transaction
Status
Transfer status
| Name |
Number |
Description |
| STATUS_UNSPECIFIED |
0 |
|
| STATUS_NEW |
1 |
|
| STATUS_PENDING |
2 |
|
| STATUS_PROCESSING |
3 |
|
| STATUS_IN_MEMPOOL |
4 |
|
| STATUS_UNCONFIRMED |
5 |
|
| STATUS_COMPLETED |
6 |
|
| STATUS_FAILED |
7 |
|
| STATUS_FROZEN |
8 |
|
| STATUS_CANCELED |
9 |
Scheduled transfer was canceled before execution |
TransferPurpose
Transfer purpose
| Name |
Number |
Description |
| TRANSFER_PURPOSE_UNSPECIFIED |
0 |
Regular transfer between owner's wallets (hot -> cold/processing, etc.) |
| TRANSFER_PURPOSE_WITHDRAWAL |
1 |
Withdrawal to an external address, requires TOTP and is executed immediately |
| TRANSFER_PURPOSE_REFUND |
2 |
Refund of an incoming deposit (source_tx_hash) from a hot wallet. Without TOTP it is allowed only back to the sender of the deposit and is executed after the configured cooldown. With TOTP - to any external address, immediately |
TransferTransactionStatus
Transfer transaction status
| Name |
Number |
Description |
| TRANSFER_TRANSACTION_STATUS_UNSPECIFIED |
0 |
|
| TRANSFER_TRANSACTION_STATUS_PENDING |
1 |
|
| TRANSFER_TRANSACTION_STATUS_UNCONFIRMED |
2 |
|
| TRANSFER_TRANSACTION_STATUS_CONFIRMED |
3 |
|
| TRANSFER_TRANSACTION_STATUS_FAILED |
4 |
|
TransferTransactionType
Transfer transaction type
| Name |
Number |
Description |
| TRANSFER_TRANSACTION_TYPE_UNSPECIFIED |
0 |
|
| TRANSFER_TRANSACTION_TYPE_TRANSFER |
1 |
|
| TRANSFER_TRANSACTION_TYPE_DELEGATE |
2 |
|
| TRANSFER_TRANSACTION_TYPE_RECLAIM |
3 |
|
| TRANSFER_TRANSACTION_TYPE_SEND_BURN_BASE_ASSET |
4 |
|
| TRANSFER_TRANSACTION_TYPE_ACCOUNT_ACTIVATION |
5 |
|
WalletType
Wallet type of transfer source or destination
| Name |
Number |
Description |
| WALLET_TYPE_UNSPECIFIED |
0 |
|
| WALLET_TYPE_HOT |
1 |
|
| WALLET_TYPE_COLD |
2 |
|
| WALLET_TYPE_PROCESSING |
3 |
|
| WALLET_TYPE_EXTERNAL |
4 |
Address does not belong to the owner |
TransferService
Service which interacts with transfers
Top
processing/wallet/v1/wallets.proto
Asset
Assets
| Field |
Type |
Label |
Description |
| asset |
Asset |
repeated |
|
AttachOwnerColdWalletsRequest
AttachOwnerColdWalletsResponse
BlockchainAdditionalData
BlockchainAdditionalData.TronData
CreateOwnerHotWalletRequest
CreateOwnerHotWalletResponse
| Field |
Type |
Label |
Description |
| address |
string |
|
|
GetOwnerColdWalletsRequest
GetOwnerColdWalletsResponse
GetOwnerHotWalletsRequest
GetOwnerHotWalletsResponse
GetOwnerHotWalletsResponse.HotAddress
| Field |
Type |
Label |
Description |
| address |
string |
|
|
| external_wallet_id |
string |
|
|
GetOwnerProcessingWalletsRequest
GetOwnerProcessingWalletsResponse
MarkDirtyHotWalletRequest
MarkDirtyHotWalletResponse
WalletPreview
WalletService
Service which interacts with wallets
Scalar Value Types
| .proto Type |
Notes |
C++ |
Java |
Python |
Go |
C# |
PHP |
Ruby |
| double |
|
double |
double |
float |
float64 |
double |
float |
Float |
| float |
|
float |
float |
float |
float32 |
float |
float |
Float |
| int32 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| int64 |
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| uint32 |
Uses variable-length encoding. |
uint32 |
int |
int/long |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
| uint64 |
Uses variable-length encoding. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum or Fixnum (as required) |
| sint32 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| sint64 |
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| fixed32 |
Always four bytes. More efficient than uint32 if values are often greater than 2^28. |
uint32 |
int |
int |
uint32 |
uint |
integer |
Bignum or Fixnum (as required) |
| fixed64 |
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. |
uint64 |
long |
int/long |
uint64 |
ulong |
integer/string |
Bignum |
| sfixed32 |
Always four bytes. |
int32 |
int |
int |
int32 |
int |
integer |
Bignum or Fixnum (as required) |
| sfixed64 |
Always eight bytes. |
int64 |
long |
int/long |
int64 |
long |
integer/string |
Bignum |
| bool |
|
bool |
boolean |
boolean |
bool |
bool |
boolean |
TrueClass/FalseClass |
| string |
A string must always contain UTF-8 encoded or 7-bit ASCII text. |
string |
String |
str/unicode |
string |
string |
string |
String (UTF-8) |
| bytes |
May contain any arbitrary sequence of bytes. |
string |
ByteString |
str |
[]byte |
ByteString |
string |
String (ASCII-8BIT) |