📙CoinGet

Get deposit address

  1. CoinGet will automatically generate a large number of addresses.

  2. CoinGet will sign the generated addresses before submitting them to CoinsDo's server.

  3. The corporate business server can use CoinsDo's API to request those signed addresses.

  4. The corporate business server will verify the signed addresses to ensure that they were generated from CoinGet.

Endpoint description

  • Designate the chain and receive the address accordingly

Request URL

  • {URL}/v1/addressGet

Request method

  • POST

Request parameter

  • Body parameter

Name of parameters
Required
Type
Description

data

Yes

string

Content(JSON string,refer below)

{
  "apiKey": "cd384rt80f5575dc",
  "chain": "TRX",
  "targetDeviceUuid": "085C28EC-0BD6-442B-8232-D23BC8F4D58E",
  "timestamp": "1622775712229",
  "addressRemark": "trx address"
}
  • Data parameter

Name of parameters
Required
Type
Description

apiKey

Yes

string

API Key

chain

Yes

string

Network code, refer to Supported Networks.

targetDeviceUuid

Yes

string

CoinGet device UUID

timestamp

Yes

string

Timestamp (seconds or milliseconds)

addressRemark

No

string

Address remarks

isConvert

No

string

Do you want to convert the address? (0. No - default 1. Yes, only used by BCH currently to convert to legacy address)

Request example 1

{
    "data": "{\"apiKey\":\"cd384rt80f5575dc\",\"mainnet\":\"TRX\",\"targetDeviceUuid\":\"085C28EC-0BD6-442B-8232-D23BC8F4D58E\",\"timestamp\":\"1622775712229\",\"addressRemark\":\"trx address\"}",
    "sign": "67355f9ad0db846edd05761462edfc1f8d396af2624e8998ee52c010c7a60dbd"
}

Request example 2

{
    "data":"{\"mainnet\":\"BCH\",\"targetDeviceUuid\":\"92E30E38-63A1-41DC-B95C-8E729DFDDE7A\",\"apiKey\":\"4c90b98cc97b45b2\",\"isConvert\":\"1\",\"timestamp\":2639477935817}",
    "sign":"7d9ae0b10068422ff30be92f45bdda0fe69bf405224564cefdc81775241d4081"
}

Response example 1

{
  "code": 200, // Status code
  "msg": "Success", // Remarks
  "data": {
    "address": "TKU69qcQPoR5jDEE7ertPpdaxoLGCTX4xR",
    "addrSign": "TESTTESTU4u0dj5xXEoZ9E4EXSes9WawqfpxrRfOIHgXV1BnPNM2tt0DLloCnJkzR7smC26+z6kuZb87s3hitZWgM3UaWWghB8/qNMQImvCZ6MREqChoNmEVyaqCnTbjorKsrU/V0=",
    "convertedAddr": null
  }
}

Response example 2

{
  "code": 200,
  "msg": "Success",
  "data": {
    "address": "bchtest:qzfr5996z72me99flf32jf6yfs38hshcwcp3dx8eja",
    "addrSign": "ZJA+/GJGNUXFw2soBGBaEbWFSOPtNMD8eRdVLTyZyuKHjnyklWvGe8SqkV8xxhwlFcT1+td9AbKstLD6b+lJ4jSCIqm5WbcMJjo0k1mCdihAagsbn5zVyTYEO7LQac341wP/76jopdYnH/yVvP5VtcNq8ZgkrcOi08ReLaQsMO8=",
    "convertedAddr": "mtr8XbbzhJVG2TYy3bYFxfV5TBw8PSEzkB"
  }
}
  • Data parameter

Name of parameters
Required
Type
Description

address

Yes

string

Receiving address

addrSign

Yes

string

Receiving address signature (Verify address through CoinGet’s public key)

convertedAddr

No

string

Converted address (Currently only BCH can be changed to legacy address, a string of your address will be returned for callback, callback will only be based on address parameter)

Response Status

Status code
Description

4042

Failed to verify collection wallet

4043

Collection wallet does not exist

4044

Failed to receive collection address

4045

Insufficient addresses

4050

Currently does not support this mainnet

4051

EOS chain does not require a collection address

4052

Token does not require a collection address

4053

Failed to convert BCH address

4061

Failed to verify linked records

4062

Unable to generate address from a linked mainnet

4063

Failed to verify gas fee address

4064

Mainnet not supported by your dispatch wallet. Please update your dispatch wallet

4071

Select a mainnet

4072

Failed to verify mainnet

Callback notification

Request method

  • POST

Request parameter

  • Body parameter

Name of parameters
Required
Type
Description

data

Yes

string

Content(JSON string,refer below)

Receive token notice

  1. Upon detecting any addresses that belong to a corporate’s collecting wallet, CoinsDo’s node will update the corporate’s collecting wallet that it has new deposits.

  2. Corporate’s collecting wallet will verify the signed addresses to ensure that the addresses were generated by itself.

  3. Corporate’s collecting wallet will use third party block explorers to verify the deposits.

  4. Third party block explorers will update the corporate’s collecting wallet after they have verified the deposits.

  5. After receiving the verified deposits from the third party block explorers, the corporate’s collecting wallet will sign the data before sending it to CoinsDo’s server.

  6. The corporate’s business server will receive a response that has the collecting wallet’s signature through CoinsDo’s API.

  7. Corporate’s business server will verify the response and ensure that it originates from the corporate’s collecting wallet.


  • The notice you will receive when the chain has a confirmed block

Main currency:
{
    "coinType": "0",
    "deviceUuid": "B65EB9AC-75DB-4B08-A84A-1C70349E61E8",
    "blockConfirm": "1",
    "amount": "0.012",
    "flag": "BCH",
    "txTime": "1660604310",
    "mainnet": "BCH",
    "toAddress": "bchtest:qzc0k3j8a8gq3egaw4n7xxd6eanp9vehnuwcu4teup",
    "isReachedConfirm": "0",
    "tokenAddress": "",
    "protocol": "",
    "blockNumber": "1513202",
    "txFee": "0.00001",
    "coinsDoId": "9",
    "fromAddress": "bchtest:qpn3cx8vqd22ut5lpkd0xqzda65nlxphwgu3v7v4na",
    "currency": "BCH",
    "coinName": "BCH",
    "txHash": "e5223b3cce8c54514394e728972a0056ef487b3295026412e12a4bc47cfd659e",
    "txIndex": "0"
}
Token:
{
    "coinType": "1",
    "deviceUuid": "B65EB9AC-75DB-4B08-A84A-1C70349E61E8",
    "blockConfirm": "1",
    "amount": "5",
    "flag": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3",
    "txTime": "1661336430",
    "mainnet": "TRX",
    "toAddress": "TKTBQ6zk8fQazY1r2vJys6VanoiWmJDXqh",
    "isReachedConfirm": "0",
    "txMemo": "0",
    "tokenAddress": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3",
    "protocol": "TRC20",
    "blockNumber": "29232059",
    "txFee": "8.34196",
    "coinsDoId": "38",
    "fromAddress": "TNX41cJ4Cy3WKd6NVkqtUp6nbrGLmT5Vy9",
    "currency": "TRC20",
    "coinName": "JST",
    "txHash": "b29e917066ed433b5d2753ae07a9b4bd71245509f8f9de51ec5a2e43425f91a8",
    "txIndex": "0"
}
  • Request example

Main currency:
{
    "data": "{\"coinType\":\"0\",\"deviceUuid\":\"B65EB9AC-75DB-4B08-A84A-1C70349E61E8\",\"blockConfirm\":\"1\",\"amount\":\"0.012\",\"flag\":\"BCH\",\"txTime\":\"1660604310\",\"mainnet\":\"BCH\",\"toAddress\":\"bchtest:qzc0k3j8a8gq3egaw4n7xxd6eanp9vehnuwcu4teup\",\"isReachedConfirm\":\"0\",\"tokenAddress\":\"\",\"protocol\":\"\",\"blockNumber\":\"1513202\",\"txFee\":\"0.00001\",\"coinsDoId\":\"9\",\"fromAddress\":\"bchtest:qpn3cx8vqd22ut5lpkd0xqzda65nlxphwgu3v7v4na\",\"currency\":\"BCH\",\"coinName\":\"BCH\",\"txHash\":\"e5223b3cce8c54514394e728972a0056ef487b3295026412e12a4bc47cfd659e\",\"txIndex\":\"0\"}",
    "sign": "ef7a1fc9cebe9b135954c8a1a4263c06f9b05e5cb608bdeed45e1c64f4f67b26"
}
Token:
{
    "data": "{\"coinType\":\"1\",\"deviceUuid\":\"B65EB9AC-75DB-4B08-A84A-1C70349E61E8\",\"blockConfirm\":\"1\",\"amount\":\"5\",\"flag\":\"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\"txTime\":\"1661336430\",\"mainnet\":\"TRX\",\"toAddress\":\"TKTBQ6zk8fQazY1r2vJys6VanoiWmJDXqh\",\"isReachedConfirm\":\"0\",\"txMemo\":\"0\",\"tokenAddress\":\"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\"protocol\":\"TRC20\",\"blockNumber\":\"29232059\",\"txFee\":\"8.34196\",\"coinsDoId\":\"38\",\"fromAddress\":\"TNX41cJ4Cy3WKd6NVkqtUp6nbrGLmT5Vy9\",\"currency\":\"TRC20\",\"coinName\":\"JST\",\"txHash\":\"b29e917066ed433b5d2753ae07a9b4bd71245509f8f9de51ec5a2e43425f91a8\",\"txIndex\":\"0\"}",
    "sign": "1ca1cf273bab9f63b5b1dcbbf72d1a56efab7ea4e3e7e2bbc1e7710e130c3f9f"
}
  • After the amount that you are supposed to receive has been confirmed on that chain's address

Main currency:
{
    "coinType": "0",
    "deviceUuid": "85FE7308-A6B8-4D17-9849-1077FC082BA3",
    "blockConfirm": "250",
    "amount": "0.0501",
    "flag": "ETC",
    "checkSign": "aHo/lkSIgYqh76sK3DQi3HdPJJ1BcftunimAnub6ucl8rTnlj4HcXfczgIyhkr4HcOrFqF1PAentnEvRKGu8BzwoxmOyWyHMxjJjYSnLmO9/53MoQ/1Y/0+tS+7YQo0WWa3A2gdnRjGaHoIjLBn5WynM15zgXnEeCiN4qlHEu6o=",
    "txTime": "1673328422",
    "mainnet": "ETC",
    "toAddress": "0x9975843827d799262f2b4209489e9232d52b9a53",
    "isReachedConfirm": "1",
    "checkCode": "0",
    "feeSymbol": "ETC",
    "tokenAddress": "",
    "recordId": "4590533727417345",
    "protocol": "",
    "checkMode": "0",
    "blockNumber": "7954343",
    "txFee": "0.000105",
    "coinsDoId": "7",
    "fromAddress": "0x5e27188508a19e8884ab6a268a39964932301553",
    "currency": "ETC",
    "coinName": "ETC",
    "txHash": "0xb2377b314be008590b70d5ca81892e3d4169a567df7ac2cf810618f30ea68687",
    "txIndex": "null"
}
Token:
{
    "coinType": "1",
    "deviceUuid": "85FE7308-A6B8-4D17-9849-1077FC082BA3",
    "blockConfirm": "15",
    "amount": "10.1",
    "flag": "0x378da755324ee4f1a5735a4f13499a410d82d122",
    "checkSign": "BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=",
    "txTime": "1673328446",
    "mainnet": "BSC",
    "toAddress": "0x30a5c679978b8ab5bfb8b31123366d405d5efa62",
    "isReachedConfirm": "1",
    "checkCode": "0",
    "feeSymbol": "BNB",
    "tokenAddress": "0x378da755324ee4f1a5735a4f13499a410d82d122",
    "recordId": "4590542064244737",
    "protocol": "BEP20",
    "checkMode": "0",
    "blockNumber": "26216212",
    "txFee": "0.00051248",
    "coinsDoId": "139",
    "fromAddress": "0xcbb98240d7cf185ef8c3867d2aa56e500d103d17",
    "currency": "BEP20",
    "coinName": "CD",
    "txHash": "0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d",
    "txIndex": "4"
}
  • Request example

Main currency:
{
    "data": "{\"coinType\":\"0\",\"deviceUuid\":\"85FE7308-A6B8-4D17-9849-1077FC082BA3\",\"blockConfirm\":\"250\",\"amount\":\"0.0501\",\"flag\":\"ETC\",\"checkSign\":\"aHo/lkSIgYqh76sK3DQi3HdPJJ1BcftunimAnub6ucl8rTnlj4HcXfczgIyhkr4HcOrFqF1PAentnEvRKGu8BzwoxmOyWyHMxjJjYSnLmO9/53MoQ/1Y/0+tS+7YQo0WWa3A2gdnRjGaHoIjLBn5WynM15zgXnEeCiN4qlHEu6o=\",\"txTime\":\"1673328422\",\"mainnet\":\"ETC\",\"toAddress\":\"0x9975843827d799262f2b4209489e9232d52b9a53\",\"isReachedConfirm\":\"1\",\"checkCode\":\"0\",\"feeSymbol\":\"ETC\",\"tokenAddress\":\"\",\"recordId\":\"4590533727417345\",\"protocol\":\"\",\"checkMode\":\"0\",\"blockNumber\":\"7954343\",\"txFee\":\"0.000105\",\"coinsDoId\":\"7\",\"fromAddress\":\"0x5e27188508a19e8884ab6a268a39964932301553\",\"currency\":\"ETC\",\"coinName\":\"ETC\",\"txHash\":\"0xb2377b314be008590b70d5ca81892e3d4169a567df7ac2cf810618f30ea68687\",\"txIndex\":\"null\"}",
    "sign": "99b488151db83010585d711fe890dad1a15217d288dd6a74411471616044cba9"
}
Token:
{
    "data": "{\"coinType\":\"1\",\"deviceUuid\":\"85FE7308-A6B8-4D17-9849-1077FC082BA3\",\"blockConfirm\":\"15\",\"amount\":\"10.1\",\"flag\":\"0x378da755324ee4f1a5735a4f13499a410d82d122\",\"checkSign\":\"BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=\",\"txTime\":\"1673328446\",\"mainnet\":\"BSC\",\"toAddress\":\"0x30a5c679978b8ab5bfb8b31123366d405d5efa62\",\"isReachedConfirm\":\"1\",\"checkCode\":\"0\",\"feeSymbol\":\"BNB\",\"tokenAddress\":\"0x378da755324ee4f1a5735a4f13499a410d82d122\",\"recordId\":\"4590542064244737\",\"protocol\":\"BEP20\",\"checkMode\":\"0\",\"blockNumber\":\"26216212\",\"txFee\":\"0.00051248\",\"coinsDoId\":\"139\",\"fromAddress\":\"0xcbb98240d7cf185ef8c3867d2aa56e500d103d17\",\"currency\":\"BEP20\",\"coinName\":\"CD\",\"txHash\":\"0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d\",\"txIndex\":\"4\"}",
    "sign": "2efb88ef2043329e60a5dad1cabc622fd076c1d1fa45648c799a0529e3babf39"
}
  • Receive tokens notice data parameters

Name of parameters
Required
Type
Description

txHash

Yes

string

Transaction hash

txIndex

No

string

Transaction index (does not apply to all the token. Might apply to BTC, ERC20, and TRC20 log sequence number)

fromAddress

Yes

string

Sending address

toAddress

Yes

string

Receiving address

currency

Yes

string

Collection Currency/Token Standard (Refer to the supported token above at 1.2)

flag

Yes

string

Collection token/Contract address/Token ID (refer to supported token at 1.2)

amount

Yes

string

Token amount

txFee

Yes

string

Gas fees

feeSymbol

Yes

string

Gas fees unit/symbol

txTime

Yes

string

Transaction confirmation timestamp(seconds)

txMemo

No

string

Chain remarks (Currently only supports TRX, TRC20, EOS, XRP)

blockNumber

Yes

string

Block height

deviceUuid

Yes

string

wallet’s UUID (receiving address)

checkMode

Yes

string

Verification method (0. Verify through wallet’s address with third parties verification API 1. Verify address through wallet)

isReachedConfirm

Yes

string

Whether the amount has been received (0. Not received 1. Received)

blockConfirm

Yes

string

Block number confirmation

checkSign

Yes

string

Wallet’s signature after verifying collection record

addressRemark

No

string

remark of receiving address

mainnet

Yes

string

mainnet(refer to currency control)

coinName

Yes

string

currency(refer to currency control)

coinsDoId

Yes

string

CoinsDoID (refer to currency control)

protocol

Yes

string

Protocol (refer to currency control)

tokenAddress

Yes

string

Token address (refer to currency control)

coinType

Yes

string

Coin type (refer to currency control)

recordId

Yes

string

CoinsDo Transaction ID

checkCode

No

string

Checking result (Parameter details as below)

checkCode
Address checking
Transaction checking
Description

-1

Checking error

Checking error

Unknown error

0

Checking success

Checking success

Checking success

1

Checking error

Check pending

Address not exists

2

Checking success

Checking success

Data not match

3

Checking success

Checking error

Transaction faied

4

Checking success

Checking error

Transaction checking failed

5

Checking success

Checking error

Transaction not found

6

Checking success

Checking disabled

Checking disabled

7

Checking error

Check pending

Address not found

 ❗Checking requires the wallet to stay online. If check is disabled, wallet will skip checking and trigger callback 
 directly. Under normal circumstances, a callback will only happen if checking is success, however. If checking has encountered an error, callback will be triggered only after 10 check repetitions.
 ❗You may ignore checkSign if checking is disabled, as the parameter value might be empty.
    Checking Signature Verification Method
    The signature is based on RSA-SHA256 method using wallet’s public key and signature (checkSign)
    Example
    checkCode = 0;
    recordId = 4590542064244737;
    txHash = 0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d;
    Sign data hash will be
    045905420642447370x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1
    Next,  use wallet public key to verify against checkSign (signature) based on RSA-SHA256 method.
    Wallet public key
    MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCYmbkVn95lUPYZTybd68Bm5CoW0UjMpEQijaGZLPm6NH0YGJiPsQa6n3jBWEm2zhiG+oLAjZnNNl+SPxEO7dJC/PhTCuFp1muGOn5xm6ItS11ByEbAOZrSMWkV7mqFQZQkTZw0tHGP7X8AqoiXClFwc+m/lkVawHqq2NUSJbafJQIDAQAB,
    checkSign (Signature)
    BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=
 ❗We recommend merchant to use coinsDoId to determine the coin that you are receiving, or you can use mainnet + coinType to determine if you have received the coin, For example  
    Main currency:mainnet=ETH coinType=0 refers to ETH with coinsDoId=2.
    Token:mainnet=ETH coinType=1 ,together with tokenAddress to determine which token it is For example, tokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7 refers to USDT with coinsDoId=6.

 ❗coinName should not be used to determine if you have received the token because different mainnet uses the same token name.

Response example

{
  "code": 200, // Status code
  "msg": "Success", // Response message
  "data": null //Response data
}

Collection notice

{
  "txHash": "54fd07f6695017f6fcecd9a3640aa0eb039d3deed72977ffc26b30d7e23cbe2c",
  "txIndex": null,
  "collectHash":"52f9bd8098c313bafc4b7fef6c4fd19e5722a37f52816adc36f3b3c90d7a2c66",
  "collectTime":"1629787162",
  "collectAddress":"TEN51U1W5hW5bJ833J6CLojvJdFGEQtz39",
  "collectFee":"0"
}
  • Collection notice data parameter

Name of parameters
Required
Type
Description

txHash

Yes

string

Transaction hash

txIndex

No

string

Transaction index (does not apply to all the token. Might apply to BTC, ERC20, and TRC20 log sequence number)

collectHash

Yes

string

Collection transaction hash

collectTime

Yes

string

Collection transaction timestamp (seconds)

collectAddress

Yes

string

Collection address

collectFee

Yes

string

Collection Gas fees

Request example

{
  "data":"{\"txHash\":\"54fd07f6695017f6fcecd9a3640aa0eb039d3deed72977ffc26b30d7e23cbe2c\",\"txIndex\":null,\"fromAddress\":\"TF62aZ4vqyE74vktUFtk3qqbuqdUagmP14\",\"toAddress\":\"TKU69qcQPoR5jDEE7ertPpdaxoLGCTX4xR\",\"currency\":\"TRX\",\"flag\":\"TRX\",\"amount\":\"1022.12\",\"txFee\":\"0\",\"feeSymbol\":\"TRX\",\"txTime\":\"1629777162\",\"txMemo\":\"test\",\"blockNumber\":\"18878341\",\"checkMode\":\"1\",\"deviceUuid\":\"085C28EC-0BD6-442B-8232-D23BC8F4D58E\"}",
  "sign": "d64b363fc9ca8f028fd58ff3152e49efee49ed9ad30b4a62887dd63ea14d94a5"
}

Response example

{
  "code": 200, // Status code
  "msg": "Success", // Response message
  "data": null //Response data
}

Convert BCH address

Endpoint description

  • BCH addresses: There are two different types of addresses - Legacy (classic) and CashAddr (Standard). You can use this interface description to convert addresses when your address is compatible.

Request URL

  • {URL}/v1/bchAddrConvert

Request method

  • POST

  • Body parameters

Name of parameters
Required
Type
Description

data

Yes

string

Contents(JSON string, refer below)

{
  "apiKey": "4c90b98cc97b45b2",
  "address": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
  "timestamp": "2639474345487"
}
  • data parameter

Name of parameters
Required
Type
Description

apiKey

Yes

string

API Key

address

Yes

string

BCH address,Legacy (classic) and CashAddr (Standard)

timestamp

Yes

string

Timestamp(seconds or milliseconds)

Request example 1

{
  "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s\",\"timestamp\":\"2639474345487\"}",
  "sign":"fc2ed2d7713a499ff718e69507cb95b1a49ac00f4be1daf34187381b8afc43c9"
}

Request example 2

{
  "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca\",\"timestamp\":\"2639474345487\"}",
  "sign":"7acecc69f1b8c05be5ebfc8435d9fea0cf39aa9138af22084f3a9aa96b323844"
}

Response example 1

{
  "code": 200,
  "msg": "success",
  "data": {
    "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
    "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
  }
}

Response example 2

{
  "code": 200,
  "msg": "success",
  "data": {
    "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
    "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
  }
}
  • data parameters

Name of parameters
Required
Type
Description

legacyAddr

Yes

string

Legacy format (classic address)

cashAddr

Yes

string

CashAddr format (Standard address)

Response status

Status code
Description

4053

Failed to convert BCH address

4054

Wrong format for BCH address

4055

Failed to verify BCH address

Manual Collection

Endpoint description

  • After submitting a request, the client must wait for the wallet client to process the collection. The collection result can be viewed in the collection record or the wallet client log.

Request URL

  • {URL}/v1/manualCollect

Request method

  • POST

  • Body parameter

Parameter name
Required?
Type
Description

data

Yes

string

Content(JSON string,refer to below)

{
    "apiKey": "4c90b98cc97b45b2",
    "address": "0xd065380c78847bfba75ad158067a5e8e845205f0",
    "coinsDoId": "22",
    "collectAmount": "0.12",
    "timestamp": "1671699594204"
}
  • Data parameter

Parameter name
Required?
Type
Description

apiKey

Yes

string

API KEY

address

Yes

string

Receiving address

coinsDoId

Yes

string

CoinsDo assigned Token ID(Refer to token list)

collectAmount

No

string

Collection amount(will collect all available balance if not filled)

timestamp

Yes

string

Timestamp (in seconds or milliseconds)

Request example 1

{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"timestamp\":\"1671698862478\"}",
    "sign":"bca9130ebc1998e2fea8c81bf480f13dbdd7259f05ac7019f47a70bc8bae407f"
}

Request example 2

{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"collectAmount\":\"0.12\",\"timestamp\":\"1671699594204\"}",
    "sign":"278682f15ae9afba34566b79eb26d90b1ba5d5542f53a2a6b650542265aac429"
}

Response example

{
    "code": 200, // status code
    "msg": "成功", // message
    "data": null // response data
}

Response status code

Status code
Description

4066

Failed to verify supported tokens

4073

CoinsDoId does not exist

4074

Receiving address does not exist

4075

Wallet version not supported

4076

Insufficient balance

4077

Existing collections not yet complete

4078

Wallet collection switch not turned on

4079

Failed to save manual collection record

4080

Failed to query minimum balance configuration

4081

Failed to query manual collection record

4082

Collection amount should be greater than 0

Get address balance

Endpoint description

  • Retrieve address balance info

Request URL

  • {URL}/v1/balanceGet

Request method

  • POST

  • Body parameter

Parameter name
Required?
Type
Description

data

Yes

string

Content(JSON string,refer to below)

{
    "apiKey": "d3a0beaa70474d3b",
    "address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
    "coinsDoId": "30",
    "timestamp": 1679397493762
}
  • Data parameter

Parameter name
Required?
Type
Description

apiKey

Yes

string

API KEY

address

Yes

string

Receiving address

coinsDoId

Yes

string

CoinsDo assigned Token ID(Refer to token list)

timestamp

Yes

string

Timestamp (in seconds or milliseconds)

Request example

{
    "data":"{\"address\":\"r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR\",\"apiKey\":\"d3a0beaa70474d3b\",\"coinsDoId\":\"30\",\"timestamp\":\"1679497593762\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}

Response example

{
    "code": 200,
    "msg": "成功",
    "data": {
        "balance": 15.000000000000000000,
        "balanceUpdateTime": "1669712411"
    }
}
  • Data parameter

Parameter name
Required?
Type
Description

balance

Yes

string

receiving address’ balance

balanceUpdateTime

Yes

string

Transaction confirmation timestamp(seconds)

Response status

Status code
Description

4034

Failed to verify address

4066

Failed to verify supported tokens

4073

CoinsDoId does not exist

4074

Receiving address does not exist

Last updated