Merchant APIs
APIs provided by merchant to be called back by wallet manager servers to send notification or verify requests.
Request Header
X-Message-XXX: 5 extended headers mentioned in Message Format
Content-Type: application/json
APIs
Deposit status callback
Deposit status callback
POST
/MERCHANT_URL/
Request Body
type*
Constant
deposit_status
data*
JSON Object
data/id*
Long
Record ID
data/merchant_id*
Long
Merchant ID
data/chain_type*
Enum
eg. 2 (ETH)
data/chain_id*
Long
data/client_id*
String
eg. 8000001
data/wallet_address*
String
data/from_address*
String
data/asset_name*
String
eg. "USDC"
data/amount*
String
data/decimals*
Integer
data/status*
Enum
eg. 2 (ConfirmedSuccess)
data/updated_time*
Long
data/block_number*
Long
data/block_hash*
String
data/block_time*
Long
data/tx_status*
Boolean
tx status on chain
data/tx_hash
String
data/ref_no*
String
transaction reference No.
data/client_tag
String
data/wallet_tag
String
data/risk_level
Enum
enum_risk_level
{
"result":true
}
Operation status callback
Operation status callback
POST
/MERCHANT_URL/
Request Body
type*
Constant
operation_status
data*
JSON Object
data/batch_id*
Long
data/operation_type*
Enum
enum_operation_type
eg. 1 (Withdraw)
data/operation_seq*
Integer
Operation sequence in a batch
data/merchant_order_id*
String
data/merchant_id*
Long
data/chain_type*
Enum
enum_chain_type
2 (ETH)
data/chain_id*
Long
data/asset_name*
String
eg. "USDT"
data/amount*
String
eg. "30000000"
data/decimals*
Integer
eg. 6
data/wallet_version
Integer
data/path
String
eg. "m/44'/60'/0'/0/0"
data/from_address*
String
data/to_address*
String
data/invoker_address
String
data/client_data
String
data/status*
Enum
enum_operation_status
2 (Submitted)
data/update_time
Long
eg. 1658215829310
data/transactions
JSON Object
data/transactions/block_number
Long
eg. 10441055
data/transactions/block_hash*
String
eg. "0x712002f4ae00b664d7bed3f82d9403bec80c74fcef976a9ba4924f0cdfc497f5"
data/transactions/block_time*
Long
eg. 1658142658
data/transactions/tx_status*
Boolean
data/transactions/tx_hash
String
eg. "0x3cdcde2c66a1c9bdbe872051ef6e24de2787b7b635fc514cd73d58a9bc14bbc9"
data/transactions/status*
Enum
enum_operation_transaction_status
4 (CoinfirmSuccess)
data/transactions/remarks
String
{
"result":true
}
Request Examples
The operation status chart please refer to enum_operation_status
Batch operation status callback
Batch operation status callback
POST
/MERCHANT_URL/
Request Body
type*
Constant
operation_batch_status
data*
JSON
data/batch_id*
Long
data/operation_type*
Enum
data/merchant_id*
Long
data/chain_type*
Enum
data/chain_id
Long
data/asset_name*
String
data/client_data
String
date/status
Enum
enum_operation_batch_status
eg. 2 (Submitted)
data/update_time
Long
{
"result":true
}
Examples
The batch operation status chart please refer to enum_operation_batch_status
Verify withdraw request
Verify withdraw transaction
POST
/MERCHANT_URL/
Request Body
type*
Constant
verify_withdraw_transaction
data
JSON Object
data/merchant_id*
Long
Merchant ID
data/operation_type*
Enum
enum_operation_type
2 (Withdraw)
data/chain_type*
Enum
enum_chain_type
eg. 2 (ETH)
data/chain_id*
Long
data/total_operation*
Integer
data/client_data
String
data/request_time*
Long
data/operations*
JSON Array
data/operations/merchant_order_id*
String
Unique order id for each merchant
data/operations/merchant_id*
Long
data/operations/operation_seq*
Integer
data/operations/operation_type*
Enum
enum_operation_type
2 (Withdraw)
data/operations/batch_id*
Long
data/operations/wallet_version
Integer
data/operations/wallet_path*
String
data/operations/asset_name*
String
data/operations/amount*
String
data/operations/decimals*
Integer
data/operations/from_address*
String
data/operations/to_address
String
data/operations/request_time*
Long
data/batch_id*
Long
data/operations/to_wallet_tag
String
wallet tag for XRP wallet.
{
"result":true
}
Last updated