api/

directory
v0.9.8-RC10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2025 License: MIT

README

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
Field Type Label Description
client_id string
client_key string
admin_secret_key string

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

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse Create client
UpdateCallbackURL UpdateCallbackURLRequest UpdateCallbackURLResponse Change merchant callback url
GetCallbackURL GetCallbackURLRequest GetCallbackURLResponse Get merchant callback url

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
Field Type Label Description
owner_id string
totp string

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
Field Type Label Description
owner_id string
totp string

DisableTwoFactorAuthResponse

GetHotWalletKeysItem
Field Type Label Description
name processing.common.v1.Blockchain
items PrivateKeyItem repeated

GetHotWalletKeysRequest
Field Type Label Description
owner_id string
otp string
wallet_addresses string repeated
excluded_wallet_addresses string repeated

GetHotWalletKeysResponse
Field Type Label Description
entries GetHotWalletKeysItem repeated

GetPrivateKeysRequest
Field Type Label Description
owner_id string
totp string

GetPrivateKeysResponse
Field Type Label Description
keys GetPrivateKeysResponse.KeysEntry repeated

GetPrivateKeysResponse.KeysEntry
Field Type Label Description
key string
value KeyPairSequence

GetSeedsRequest
Field Type Label Description
owner_id string
totp string

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
Field Type Label Description
public_key string
private_key string
address string
kind string

KeyPairSequence
Field Type Label Description
pairs KeyPair repeated

PrivateKeyItem
Field Type Label Description
address string
public_key string
private_key string

ValidateTwoFactorTokenRequest
Field Type Label Description
owner_id string
totp string

ValidateTwoFactorTokenResponse

OwnerService

Service which interacts with owner

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse Create owner of client (creates processing wallet as side effect)
GetSeeds GetSeedsRequest GetSeedsResponse Get owner mnemonic phrases
GetPrivateKeys GetPrivateKeysRequest GetPrivateKeysResponse Get owner private keys (only hot,processing)
GetHotWalletKeys GetHotWalletKeysRequest GetHotWalletKeysResponse Get owner hot wallet keys
ConfirmTwoFactorAuth ConfirmTwoFactorAuthRequest ConfirmTwoFactorAuthResponse Confirm owner two auth
DisableTwoFactorAuth DisableTwoFactorAuthRequest DisableTwoFactorAuthResponse Enable or disable owners two auth
GetTwoFactorAuthData GetTwoFactorAuthDataRequest GetTwoFactorAuthDataResponse Get owner 2fa status data
ValidateTwoFactorToken ValidateTwoFactorTokenRequest ValidateTwoFactorTokenResponse Validate 2fa token

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
Field Type Label Description
version string
commit string

LogEntry
Field Type Label Description
time google.protobuf.Timestamp
level string
message string

UpdateToNewVersionRequest

UpdateToNewVersionResponse
Field Type Label Description
status string

SystemService

Service which provides system information

Method Name Request Type Response Type Description
Info InfoRequest InfoResponse System info (version etc)
CheckNewVersion CheckNewVersionRequest CheckNewVersionResponse Check new version from updater
UpdateToNewVersion UpdateToNewVersionRequest UpdateToNewVersionResponse Update Processing from updater
GetLastLogs GetLastLogsRequest GetLastLogsResponse Get last memory logs

Top

processing/transfer/v1/transfer.proto

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

CreateResponse
Field Type Label Description
item Transfer

GetByRequestIDRequest
Field Type Label Description
request_id string

GetByRequestIDResponse
Field Type Label Description
item Transfer

Transfer

Transfer

Field Type Label Description
id string
status Status
owner_id string
request_id string
blockchain processing.common.v1.Blockchain
from_addresses string repeated
to_addresses string repeated
asset_identifier string
kind string optional used for tron transfers: burntrx, resources. for other blockchains must be empty
whole_amount bool
amount string optional
fee string optional
fee_max string optional
tx_hash string optional
error_message string optional
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp optional
state_data google.protobuf.Struct
workflow_snapshot google.protobuf.Struct
transactions TransferTransaction repeated List of system transactions associated with the transfer, sorted by created_at

TransferTransaction

Transfer transaction

Field Type Label Description
id string UUID
transfer_id string UUID
tx_hash string
bandwidth_amount string Decimal
energy_amount string Decimal
native_token_amount string Decimal
native_token_fee string Decimal
tx_type TransferTransactionType
status TransferTransactionStatus
step string
created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp

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

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

TransferService

Service which interacts with transfers

Method Name Request Type Response Type Description
Create CreateRequest CreateResponse Create a new transfer
GetByRequestID GetByRequestIDRequest GetByRequestIDResponse Get transfer by request ID

Top

processing/wallet/v1/wallets.proto

Asset
Field Type Label Description
identity string
amount string

Assets
Field Type Label Description
asset Asset repeated

AttachOwnerColdWalletsRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain
totp string
addresses string repeated

AttachOwnerColdWalletsResponse

BlockchainAdditionalData
Field Type Label Description
tron_data BlockchainAdditionalData.TronData optional

BlockchainAdditionalData.TronData
Field Type Label Description
available_energy_for_use string
total_energy string
available_bandwidth_for_use string
total_bandwidth string
stacked_trx string
stacked_energy string
stacked_bandwidth string
stacked_energy_trx string
stacked_bandwidth_trx string
total_used_bandwidth string
total_used_energy string

CreateOwnerHotWalletRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain
external_wallet_id string a store customer who has been given a hot wallet for payment
bitcoin_address_type processing.common.v1.BitcoinAddressType optional
litecoin_address_type processing.common.v1.LitecoinAddressType optional
dogecoin_address_type processing.common.v1.DogecoinAddressType optional

CreateOwnerHotWalletResponse
Field Type Label Description
address string

GetOwnerColdWalletsRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain optional

GetOwnerColdWalletsResponse
Field Type Label Description
items WalletPreview repeated

GetOwnerHotWalletsRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain
external_wallet_id string optional a store customer who has been given a hot wallet for payment
bitcoin_address_type processing.common.v1.BitcoinAddressType optional
litecoin_address_type processing.common.v1.LitecoinAddressType optional

GetOwnerHotWalletsResponse
Field Type Label Description
addresses GetOwnerHotWalletsResponse.HotAddress repeated

GetOwnerHotWalletsResponse.HotAddress
Field Type Label Description
address string
external_wallet_id string

GetOwnerProcessingWalletsRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain optional
tiny bool optional

GetOwnerProcessingWalletsResponse
Field Type Label Description
items WalletPreview repeated

MarkDirtyHotWalletRequest
Field Type Label Description
owner_id string
blockchain processing.common.v1.Blockchain
address string

MarkDirtyHotWalletResponse

WalletPreview
Field Type Label Description
address string
blockchain processing.common.v1.Blockchain
assets Assets optional
blockchain_additional_data BlockchainAdditionalData optional

WalletService

Service which interacts with wallets

Method Name Request Type Response Type Description
GetOwnerHotWallets GetOwnerHotWalletsRequest GetOwnerHotWalletsResponse Get owner hot wallets
GetOwnerColdWallets GetOwnerColdWalletsRequest GetOwnerColdWalletsResponse Get owner cold active wallet list
GetOwnerProcessingWallets GetOwnerProcessingWalletsRequest GetOwnerProcessingWalletsResponse Get owner processing wallets
AttachOwnerColdWallets AttachOwnerColdWalletsRequest AttachOwnerColdWalletsResponse Attach owner cold wallets
MarkDirtyHotWallet MarkDirtyHotWalletRequest MarkDirtyHotWalletResponse Mark a dirty hot wallet
CreateOwnerHotWallet CreateOwnerHotWalletRequest CreateOwnerHotWalletResponse Create owner hot wallet

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)

Directories

Path Synopsis
processing
client/v1
client/v1/clientv1connect
common/v1
owner/v1
owner/v1/ownerv1connect
system/v1
system/v1/systemv1connect
transfer/v1
transfer/v1/transferv1connect
wallet/v1
wallet/v1/walletv1connect

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.