0% found this document useful (0 votes)
262 views26 pages

BitHide Public API

The BitHide Public API Guide provides comprehensive instructions for managing cryptocurrency wallets, including methods for obtaining address information, checking wallet balances, creating transactions, and integrating with external systems. Key components for using the API include the API URL, API key, and callback settings for transaction notifications. The document outlines various API methods and their respective request and response formats to facilitate seamless interaction with the wallet.

Uploaded by

nikolay.sakhnin
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
262 views26 pages

BitHide Public API

The BitHide Public API Guide provides comprehensive instructions for managing cryptocurrency wallets, including methods for obtaining address information, checking wallet balances, creating transactions, and integrating with external systems. Key components for using the API include the API URL, API key, and callback settings for transaction notifications. The document outlines various API methods and their respective request and response formats to facilitate seamless interaction with the wallet.

Uploaded by

nikolay.sakhnin
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 26

BitHide Public API Guide

This document provides a detailed guide on using the BitHide Public


API for seamless interaction with your cryptocurrency wallet. The
API enables you to manage addresses, retrieve wallet balance
information, create and track transactions, and integrate BitHide
with external systems.

Version 2.2503.2
Table of Contents
Public API ..................................................................................................................... 2
Introduction .............................................................................................................. 2
Overview ................................................................................................................... 3
API methods.............................................................................................................. 3
Address .................................................................................................................. 3
Obtaining Address Information (POST /Address/Get) ......................................... 3
Creating a new Address (POST /Address/GetAddress) ........................................ 6
Currency ................................................................................................................ 8
Getting a list of currencies (POST /Currency/List) ............................................... 8
Wallet .................................................................................................................. 10
Getting Wallet information (POST /Merchant/Get) .......................................... 10
Report .................................................................................................................. 12
Getting Wallet balance (POST /Report/WalletBalance)..................................... 12
Transaction .......................................................................................................... 14
Getting the total Queued Transaction count (POST
/Transaction/QueuedTotalCount) ..................................................................... 14
Getting Transaction List (POST /Transaction/List) ............................................. 16
Withdraw Request (POST /Transaction/Withdraw)........................................... 22
Callback example .............................................................................................. 24

BitHide Copyright © 2025


Public API
[Back to Table of Contents]

Introduction
This API guide describes a set of methods for interacting with the wallet. The API allows
you to create and view address information, get data about available wallet currencies,
balance and wallet data information, current queued transactions, and a list of
transactions. The API also provides the ability to withdraw funds if it is allowed in the
wallet settings on the client side. The API is designed for integration with various
systems and applications, ensuring secure and efficient data exchange.

To successfully interact with the API, you'll need the following essential components:

API URL:

The API URL serves as the endpoint for sending API requests. It includes the server
address and port (8645).

• This URL serves as the endpoint for sending API requests.


• Construct the API URL using the following format:
https://<server_address>:<port>

API Key:

Your API key for interacting with the API is a unique identifier for your wallet within the
application. Each wallet has its distinct key. You can find your API key in the application
on the "Wallets" page under the "API Key" column. To retrieve information specific to
a particular wallet, use the corresponding API key associated with that wallet.

• An API key is a unique identifier of the Wallet that grants access to your client
application's API endpoints.
• You can locate your API key within the client application on the "Wallets" page
under the "API Key" column.
• Copy your API key for use in API requests.

Callbacks:
Instant notifications upon detecting incoming transactions.

• This Backlink URL is the address on your side where the application will send
callbacks upon detecting incoming transactions.
• To receive callbacks notifying you of incoming transactions, you must set your
Backlink URL in the wallet settings in the client application (field Backlink).
2

BitHide Copyright © 2025


Overview
What can you do with this API?
Topic Description
Address Get cryptocurrency address information or create a new address in
your wallet.
Currency Get a list of available currencies in your wallet.
Wallet Get information about your wallet.
Report Get information about your wallet balance.
Transaction Create a withdrawal transaction from an address in the wallet or get
information about transactions in the queue and transaction list.

API methods
Address
[Back to Table of Contents]
API Address Interaction
Topic Description
Obtaining Address Information Get information about the crypto
address.
Creating a new Address Create a new crypto address in your
wallet.

Obtaining Address Information (POST /Address/Get)


This method aims to obtain detailed information about cryptocurrency addresses.
Endpoint:
POST /Address/Get
Request parameters:
Parameter Type Req.? Description
Address String Yes The address you want to retrieve information
about.
ApiKey String Yes Your API key can be found on your client
application's "Wallets" page under the "API
key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

BitHide Copyright © 2025


Request example:
{
"Address": "string",
"ApiKey": "string"
}

Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"AddressesResponce": [
{
"Address": "string",
"Balance": 0,
"AvailableBalance": 0,
"Merchant": "string",
"MerchantId": 0,
"Label": "string",
"Created": "2024-05-20T12:29:21.075Z",
"LastTransactionDate": "2024-05-20T12:29:21.075Z",
"IncomingTransactionsCount": 0,
"OutgoingTransactionsCount": 0,
"Currency": "string",
"RiskScore": 0,
"LastCheckDate": "2025-04-02T08:45:47.479Z",
"IsActual": true
}
],
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
AddressesResponce Array List of address info records
Address String Cryptocurrency address
Balance Number (double) Address balance
AvailableBalance Number (double) Available balance for withdrawal
Merchant String Address wallet name
MerchantId Integer (int64) Wallet ID
4

BitHide Copyright © 2025


Parameter Type Description
Label String Address label
Created String (date-time) Date and time the address was
created
LastTransactionDate String (date-time) Date and time of the last
transaction
IncomingTransactionCount Integer (int32) Number of incoming transactions
OutgoingTransactionCount Integer (int32) Number of outgoing transactions
Currency String Address currency symbol
RiskScore Number (double) AML risk level for the address
LastCheckDate String (date-time) Date and time of the last AML check
IsActual Boolean AML address check actuality flag:
True – address was checked and the
risk data is current.
False – no check performed or risk
data is outdated.
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Code": "string",
"AddInfo": "string",
"Exception": "string"
}

Response parameters:
Parameter Type Description
Code String Error code
AddInfo String Additional information
Exception String Exception

BitHide Copyright © 2025


Creating a new Address (POST /Address/GetAddress)
[Back to Table of Contents]
This method is used to request the creation of a new cryptocurrency address.
Endpoint:
POST /Address/GetAddress

Request parameters:
Parameter Type
Req.? Description
ExternalId String
No User ID on your platform.
Currency String
Yes Currency symbol. Available options: BTC,
USTD-TRC20, TRX, ETH, USDT-ERC20.
New Boolean Yes False – use an existing address
True – create a new address
ExpectedAmount Number No Expected amount
CallBackLink String No Callback reference
AdditionalInfo String No It’s a deprecated field. Please use Label instead.
Label String No Address label
ApiKey String Yes Your API key can be found on your client
application's "Wallets" page under the "API
key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey
instead.

Request example:
{
"ExternalId": "string",
"Currency": "string",
"New": true,
"ExpectedAmount": 0,
"CallBackLink": "string",
"AdditionalInfo": "string",
"Label": "string",
"ApiKey": "string"
}

BitHide Copyright © 2025


Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"Id": 0,
"ExternalId": "string",
"Label": "string",
"Address": "string",
"Created": "2024-05-20T12:30:05.333Z",
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Id Integer (int64) Address ID
ExternalId String Address external ID. It’s a deprecated field.
Please use Label instead.
Label String Address label
Address String Cryptocurrency address
Created String (date-time) Date and time the address was created
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Code": "string",
"AddInfo": "string",
"Exception": "string"
}

BitHide Copyright © 2025


Response parameters:
Parameter Type Description
Code String Error code
AddInfo String Additional information
Exception String Exception

Currency
[Back to Table of Contents]
API Currency Interaction
Topic Description
Getting a list of currencies Retrieve information about the list of currencies
available in the wallet.

Getting a list of currencies (POST /Currency/List)


This method is used to request a list of available currencies.
Endpoint:
POST /Currency/List

Request parameters:
Parameter Type Req.? Description
ApiKey String Yes Your API key can be found on your client application's
"Wallets" page under the "API key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

Request example:
{
"ApiKey": "string"
}

BitHide Copyright © 2025


Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"Cryptocurrencies": [
{
"Id": 0,
"Symbol": "string",
"Name": "string"
}
],
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Cryptocurrencies Array List of available currencies. Use Currency Symbol in
requests.
Id Integer Currency ID
(int64)
Symbol String Currency symbol
Name String Currency name
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Code": "string",
"AddInfo": "string",
"Exception": "string"
}
9

BitHide Copyright © 2025


Response parameters:
Parameter Type Description
Code String Error code
AddInfo String Additional information
Exception String Exception

Wallet
[Back to Table of Contents]
API Wallet Interaction
Topic Description
Getting Wallet information Retrieve information about the wallet.

Getting Wallet information (POST /Merchant/Get)


This method retrieves information about a wallet based on its API key.
Endpoint:
POST /Merchant/Get

Request parameters:
Parameter Type Req.? Description
ApiKey String Yes Your API key can be found on your client application's
"Wallets" page under the "API key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

Request example:
{
"ApiKey": "string"
}

10

BitHide Copyright © 2025


Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"Merchant": {
"Id": 0,
"Name": "string",
"Label": "string",
"PublicKey": "string",
"CallBackLink": "string",
"PublicWithdrawalIPs": "string",
"IsArchive": true,
"Logo": "string",
"Modified": "2024-05-20T12:31:15.385Z",
"Created": "2024-05-20T12:31:15.385Z"
},
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Merchant Object An object containing wallet information
Id Integer (int64) Wallet ID
Name String Wallet name
Label String Optional Wallet label
PublicKey String Your API key can be found on your client
application's "Wallets" page under the
"API key" column.
CallBackLink String Callback reference
PublicWithdrawalIPs String List of trusted IP addresses for withdrawal
requests. (CIDR notation. Separated by
“;”)
IsArchive Boolean True – wallet is archived
False – wallet is not archived
Logo String Encoded picture of wallet logo
Modified String (date-time) Date and time the wallet modified last
time
Created String (date-time) Date and time the wallet was created
11

BitHide Copyright © 2025


Parameter Type Description
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Code": "string"
}

Response parameters:
Parameter Type Description
Code String Error code

Report
API Report Interaction
Topic Description
Getting Wallet balance Retrieve information about the wallet balance.

Getting Wallet balance (POST /Report/WalletBalance)


[Back to Table of Contents]
This method retrieves wallet balance information using the provided API key.
Endpoint:
POST /Report/WalletBalance
Request parameters:
Parameter Type Req.? Description
ApiKey String Yes Your API key can be found on your client application's
"Wallets" page under the "API key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

12

BitHide Copyright © 2025


Request example:
{
"ApiKey": "string"
}

Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"Wallets": [
{
"WalletId": 0,
"WalletName": "string",
"Balance": [
{
"CurrencyId": 0,
"CurrencyName": "string",
"Balance": 0
}
]
}
],
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Wallets Array List of wallet info records
WalletId Integer (int64) Wallet ID
WalletName String Wallet name
Balance Array List of balance records for the wallet
CurrencyId Integer (int64) Currency ID
CurrencyName String Currency name
Balance Number (double) Balance of the specified currency in the wallet
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object
13

BitHide Copyright © 2025


• 400 Bad Request:
o Description: Bad request
o Example response body:
{
"Code": "string",
"AddInfo": "string",
"Exception": "string"
}

Response parameters:
Parameter Type Description
Code String Error code
AddInfo String Additional information
Exception String Exception

Transaction
[Back to Table of Contents]
API Transaction Interaction
Topic Description
Getting the total Queued Transaction Retrieve the total number of transactions in
count the queue.
Getting Transaction List Retrieve a list of transactions with pagination,
sorting, and filtering capabilities.
Withdraw Request Create a withdrawal request from an address.

Getting the total Queued Transaction count (POST


/Transaction/QueuedTotalCount)
This method is used to retrieve the total number of queued transactions.
Endpoint:
POST /Transaction/QueuedTotalCount

Request parameters:
Parameter Type Req.? Description
ApiKey String Yes Your API key can be found on your client application's
"Wallets" page under the "API key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

14

BitHide Copyright © 2025


Request example:
{
"ApiKey": "string"
}

Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"QueuedTotalCount": 0,
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
QueuedTotalCount Integer (int64) Total number of queued transactions
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object
• 400 Bad Request:
o Description: Bad request
o Example response body:
{
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

15

BitHide Copyright © 2025


Response parameters:
Parameter Type Description
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

Getting Transaction List (POST /Transaction/List)


[Back to Table of Contents]
This method retrieves a list of transactions with pagination, sorting, and filtering
capabilities.
Endpoint:
POST /Transaction/List

Request parameters:
Parameter Type Req.? Description
Page Integer Yes Page number in the pagination (greater than 0).
(int32) Min: 1
Max: 2147483647
Count Integer Yes Number of items per page (greater than 0, less
(int32) than 200).
Min: 1
Max: 200
Search String No Value to search for
SortField String No Sorting field
SortDirection String No Sorting direction
Filter Object No Filtering object
ApiKey String Yes Your API key can be found on your client
application's "Wallets" page under the "API key"
column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey instead.

Request example:
{
"Page": 2147483647,
"Count": 200,
"Search": "string",
"SortField": "string",
"SortDirection": "string",
16

BitHide Copyright © 2025


"Filter": "string",
"ApiKey": "string"
}

Responses:
• 200 Success:
o Description: Successful request
o Example response body:
{
"Page": 0,
"Count": 0,
"List": [
{
"Id": 0,
"Type": 1,
"Date": "2024-05-20T09:53:04.643Z",
"NodeTime": "2024-05-20T09:53:04.643Z",
"BlockNumber": 0,
"TxId": "string",
"Cryptocurrency": "string",
"MerchantId": 0,
"MerchantName": "string",
"Initiator": "string",
"InitiatorType": "None",
"InitiatorId": "string",
"Amount": 0,
"AmountUSD": 0,
"Rate": 0,
"Commission": 0,
"CommissionCurrency": "string",
"DestinationAddress": "string",
"Comment": "string",
"Status": 0,
"FailReason": "string",
"OrderType": "string",
"BroadcastCompleted": "2025-04-29T14:45:21.444Z",
"ApproveStatus": 0,
"Direction": 0,
"UserId": 0,
"AmountMinusCommission": 0,
"CommissionType": "None",
"HasRepeats": true,
"OrderId": 0,
"UserName": "string",
"ApproveUserId": 0,
"UserApproved": "string",
"ApprovedDate": "2025-04-29T14:45:21.444Z",
"ApproveComments": "string",
"CallbackConfirmationStatus": 0,
"SenderAddresses": [
"string"
],

17

BitHide Copyright © 2025


"AddressLabels": [
"string"
]
}
],
"Offset": 0,
"Total": 0,
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Page Integer Page number in the pagination (greater
(int32) than 0).
Min: 1
Max: 2147483647
Count Integer Number of items per page (greater than 0,
(int32) less than 200).
Min: 1
Max: 200
List Array List of transactions
Id Integer Transaction ID in your client application
(int64)
Type Integer Transaction type (enum, numbers):
(int32) Deposit = 1
Withdrawal = 2
ChangeDeposit = 3
ChangeWithdrawal = 4
AddressActivation = 5
CommissionPayment = 6
DepositCommissionPayment = 7
BlockchainWithdrawalFee = 8
ProxyAggregationWithdrawal = 9
ProxyAggregationDeposit = 10
ExchangeProxyAggregationWithdrawal = 11
ExchangeProxyAggregationDeposit = 12
Date String Date and time the transaction was created
(date-time)
NodeTime String Date and time the transaction was added
(date-time) to the node

18

BitHide Copyright © 2025


Parameter Type Description
BlockNumber Integer Number of the blockchain block in which
(int64) the transaction was recorded
TxId String Blockchain transaction ID
Cryptocurrency String Transaction currency
MerchantId Integer Wallet ID
(int64)
MerchantName String Wallet name
Initiator String Transaction initiator
InitiatorType String Transaction initiator type (enum, string):
None = 0
ExternalDeposit = 1
User = 2
AutoWithdrawal = 3
Merchant = 4
BlockchainSync = 5
BulkWithdrawal= 6
Transaction = 7
ProxyWithdrawal = 8
Exchange = 9
ExchangeProxyWithdrawal = 10
InitiatorId String Transaction initiator ID
Amount Number Transaction amount
(double)
AmountUSD Number Transaction amount in USD
(double)
Rate Number Exchange rate to USD
(double)
Commission Number Transaction fee
(double)
CommissionCurrency String Currency used for transaction fee payment
DestinationAddress String Destination address
Comment String Transaction comment
Status Integer Transaction status (enum, numbers):
(int32) None = 0
Queued = 1
Completed = 2
Failed = 3
Processing = 4
WaitingConfirmation = 5
Cancelled = 6
OnReview = 7
FailReason String Transaction failure reason
19

BitHide Copyright © 2025


Parameter Type Description
OrderType String Type of transaction order (enum, string):
None
ExternalDeposit = 1
Manual = 2
AutoWithdrawal = 3
Merchant = 4
BlockchainSync = 5
BulkWithdrawal = 6
Transaction = 7
ProxyWithdrawal = 8
Exchange = 9
ExchangeProxyWithdrawal = 10
BroadcastCompleted String Date and time when the transaction was
(date-time) successfully broadcast to the blockchain
network
ApproveStatus Integer Approval status for a withdrawal
(int32) transaction:
None = 0
Approved = 1
Rejected = 2
Direction Integer Direction of the transaction:
(int32) None (unspecified) = 0
Internal = 1
External = 2
UserId Integer ID of the user associated with the
(int64) transaction
AmountMinusCommission Number Net amount transferred after deducting
(double) the transaction fee
CommissionType String Fee calculation mode selected for the
transaction (string, enum):
None
Fast
Medium
Slow
HasRepeats Boolean Indicates whether the transaction had
repeated attempts (e.g., network retries)
OrderId Integer ID of the related order, if any
(int64)
UserName String Name of the user associated with the
transaction
ApproveUserId Integer ID of the BitHide user who approved the
(int64) withdrawal
20

BitHide Copyright © 2025


Parameter Type Description
UserApproved String Name of the BitHide user who approved
the withdrawal
ApprovedDate String Date and time when the withdrawal
(date-time) approval was completed
ApproveComments String Comments provided during the approval
process
CallbackConfirmationStatus Integer Callback confirmation status (enum,
(int32) numbers):
None = 0
Success = 1
Pending = 2
Failed = 3
SenderAddresses Array List of sender addresses related to the
(String) transaction
AddressLabels Array Labels assigned to the addresses involved
(String) in the transaction
Offset Integer Pagination offset
(int32)
Total Integer Total number of transactions matching
(int64) the query
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Status String Request execution status
ErrorCode String Error code
21

BitHide Copyright © 2025


Parameter Type Description
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

Withdraw Request (POST /Transaction/Withdraw)


[Back to Table of Contents]
This method is used to create a withdrawal request.
Endpoint:
POST /Transaction/Withdraw
Request parameters:
Parameter Type Req.? Description
RequestId String No Request ID. Used to identify the response
SourceAddress String No Address to withdraw from
DestinationAddress String No Address to withdraw to
Amount Number Yes Withdrawal amount
Currency String No Withdrawal currency
IsSenderCommission Boolean Yes True – sender pays the fee
False – recipient pays the fee
Comment String No Payment comment
ApiKey String Yes Your API key can be found on your client
application's "Wallets" page under the
"API key" column.
PublicKey String Yes It’s a deprecated field. Please use ApiKey
instead.
Request example:
{
"RequestId": "string",
"SourceAddress": "string",
"DestinationAddress": "string",
"Amount": 0,
"Currency": "string",
"IsSenderCommission": true,
"Comment": "string",
"ApiKey": "string"
}

Responses:
• 200 Success:

22

BitHide Copyright © 2025


o Description: Successful request
o Example response body:
{
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

• 400 Bad Request:


o Description: Bad request
o Example response body:
{
"Status": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"Error": {
"Code": "string"
}
}

Response parameters:
Parameter Type Description
Status String Request execution status
ErrorCode String Error code
ErrorMessage String Error message
Error Object Error object
Code String Error code within the Error object

23

BitHide Copyright © 2025


Callback example
[Back to Table of Contents]
You receive a notification (callback) every time a deposit is made to your address. The
notification is sent to the URL specified in the Wallet settings ("Wallet backlink" field).
Example value:
{
"RequestId": "string",
"Id": 0,
"ExternalId": "string",
"AdditionalInfo": "string",
"Label": "string",
"Address": "string",
"Amount": 0,
"Currency": "string",
"Rate": 0,
"TxId": "string",
"Date": "2024-05-27T15:13:09.554Z",
"Error": "string",
"Comment": "string",
"Initiator": "None",
"Type": 1,
"Checksum": "string"
}

Callback parameters:
Parameter Type Description
RequestId String Withdrawal request ID
Id String Transaction ID in your client application
ExternalId String Client-side external ID. It’s a deprecated field.
Please use Label instead.
AdditionalInfo String Additional information. It’s a deprecated field.
Please use Label instead.
Label String Address label
Address String Transaction address
Amount Number (double) Transaction amount
Currency String Transaction currency
Rate Number (double) Exchange rate to USD
TxId String Blockchain transaction ID
Date String (date-time) Date and time the transaction was created
Error String Transaction error
Comment String Payment comment
Initiator String Event initiator (enum, string):
None = 0
ExternalDeposit = 1
24

BitHide Copyright © 2025


Parameter Type Description
User = 2
AutoWithdrawal = 3
Merchant = 4
BlockchainSync = 5
BulkWithdrawal = 6
Transaction = 7
ProxyWithdrawal = 8
Type Integer (int32) Transaction type (enum, numbers):
Deposit = 1
Withdrawal = 2
ChangeDeposit = 3
ChangeWithdrawal = 4
AddressActivation = 5
CommissionPayment = 6
DepositCommissionPayment = 7
BlockchainWithdrawalFee = 8
Checksum String Transaction notification checksum. *
* Concatenate callback field values (except “null” values) into one string using this
formula:
RequestId+Id+ExternalId+AdditionalInfo+Address+Amount+Currency+TxId
+Date+Error+Comment+Initiator+Type+”Key For Hashing Callbacks”

You can find the Key in the app's Wallet Settings. Then, calculate the SHA256 hash for
the result string and compare it with the value of the checksum field. If the values are
equal, the callback is trusted.

[Back to Table of Contents]

25

BitHide Copyright © 2025

You might also like