📗General

Below is the general information regarding our API URL and the tokens supported.

API URL

Make sure to use the correct API URL corresponding to the account you are using. To verify, please check your current login URL based on below.

Mainnet: https://merchant.coinsdo.com Testnet: https://merchant.coinsdotest.com/

Environment	URL
Mainnet	https://open.coinsdo.com/coinsdo/open
Testnet	https://open.coinsdotest.com/coinsdo/open

Supported Tokens

Please go to currency control list in your CoinSend/CoinGet center for the most up-to-date list of support tokens and also coinsDoId for making API request.

How to make API request

Below are the standard rules for making an API request with the CoinsDo Open API.

Request parameters

• Header

Parameter	Required	Value
Content-Type	Yes	application/json

• Body

Parameter	Required	Type	Description
sign	Yes	string	Signature
data	Yes	string	Content（JSON string, depends on each API）

Signing

Generate the signature by hashing the data using HMAC-SHA256 with the Secret-KEY linked to your API-KEY or merchant account. The resulting hash is the signature.

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

Response

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

Status code

Below is a general list of status codes, and each API endpoint may have its own differences.

Status code	Description
-2	System error
200	Success
4001	API endpoints not found
4002	Parameters in wrong format
4003	JSON data conversion abnormal
4004	API Key does not exists
4005	IP Restricted
4007	Signature verification failed
4010	Request expired
4068	Failed to verify APIKEY

Webhook notification

Below are the details of the webhook requests are sent from CoinsDo to webhook URL.

Request

POST /{webhookURL}

• Header

Parameter	Required	Value
Content-Type	Yes	application/json

• Body

Parameter	Required	Type	Description
sign	Yes	string	Signature
data	Yes	string	Content（JSON string）

Response

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

How you should respond?

This section suggests whether you should respond to the callback.

When you execute, the return code should display 200 if the callback is successful. Once it is successful, there will be no further callbacks.

If you choose to ignore, the return code should display 202 if it is successful. There will be no callbacks (Choosing to ignore is similar to the 200 status in terms of effect. The only difference is whether you want to handle the suggested display).

Scenario	Example	Suggestion
Transfer	Transfer request on the in CoinSend (success/rejected/cancelled).	Respond with code 200
Receive (confirmed by 1 block)	Transaction confirmed by 1 block.	Respond with code 200 /ignore
Receive (confirm by specific number of blocks)	Target blockchain confirmations have been reached and verified successfully (final status) and credited.	Respond with code 200 and update