We’re happy to inform you that the new Get Processing Info (get_processing_info) method is available and fully operational for all our Clients using REST and WebSocket APIs.
If you wish to receive detailed specifications and samples on how to use Get Processing Info (get_processing_info) request and on how to use "blockchain" parameter in Get Deposit Address (get_deposit_address), Funds Withdrawal (do_withdrawal_funds) and Withdrawal Status (get_withdrawal_status ) requests, checkout our updated API Documentation via the following links:
REST | WebSocket |
What information is available via Get Processing Info method?
Basically, Get Processing Info method allows our Clients to receive detailed information about available options to make deposits from external wallets and withdrawals to external wallets as to each supported cryptocurrency.
Such information includes available blockchains for deposit\withdrawals, type of cryptocurrency on each blockchain, current deposit\withdrawal availability, min deposit\withdrawal amounts, external withdrawal fees etc.
Considering mentioned our Clients receive the following key advantages from usage of Get Processing Info method:
Client can now get the list of all available blockchains as to all cryptocurrencies, for which deposit\withdrawal options are supported OR get the list of all supported blockchains for specific cryptocurrency in which Client is interested in.
Client can observe current blockchain status (enabled\disabled) for carrying out deposits\withdrawals as to each supported cryptocurrency.
Client can get cryptocurrency min deposit\withdrawal limits and external withdrawal fees as to each supported blockchain.
Client gets more flexibility in choosing desired blockchain with faster confirmations and\or lower commissions instead of using default blockchain.
How the processing information should be used in Get Deposit Address, Funds Withdrawal and Withdrawal Status requests?
Please pay attention, as Get Processing Info method is now available for Clients, the new field "blockchain" also becomes mandatory for indication in Get Deposit Address and Funds Withdrawal requests.
Also this field is now mandatory for Withdrawal Status requests with specified "crypto" instrument.
Instead permanent usage of default blockchain from now on Clients can indicate specific blockchain to generate crypto deposit addresses on and initiate external crypto withdrawal via specified blockchain.
ATTENTION!!! All Clients need to switch to the usage of the "blockchain" field in Get Deposit Address (get_deposit_address), Funds Withdrawal (do_withdrawal_funds) and Withdrawal Status (get_withdrawal_status) requests as soon as possible.
Example:
Here we present an example of how Clients can benefit from new Get Processing Info request and further use its' response with list of supported blockchains for specific cryptocurrency.
1. Get Processing Info Request
Client sends a "get_processing_info" request with following parameters to receive processing info for "USDC" cryptocurrency)
{
"currencies": ["USDC"]
}
2. Get Processing Info Response
CEX.IO Prime Liquidity responds with the list blockchains to deposit\withdraw "USDC" cryptocurrency and their detailed information.
{
"ok": "ok",
"data": {
"USDC": {
"name": "USD Coin",
"blockchains": {
"ethereum": {
"type": "ERC20",
"deposit": "enabled",
"minDeposit": "5",
"withdrawal": "enabled",
"minWithdrawal": "50",
"withdrawalFee": "40"
},
"stellar": {
"type": "coin",
"deposit": "enabled",
"minDeposit": "5",
"withdrawal": "enabled",
"minWithdrawal": "50",
"withdrawalFee": "1"
},
"tron": {
"type": "TRC20",
"deposit": "enabled",
"minDeposit": "5",
"withdrawal": "enabled",
"minWithdrawal": "50",
"withdrawalFee": "1"
}
}
}
}
}
As we can see from the response, overall 3 blockchains ("ethereum", "tron", "stellar") are supported for the deposits and withdrawals for "USDC" cryptocurrency.
Client can compare the min amounts for the deposits\withdrawals, and of course compare withdrawal fees to choose the most preferable blockchain for further actions.
3. Get Deposit Address Request
For example, after comparing all available blockchains "tron" blockchain is chosen as the most preferable for further deposits.
Client sends a "get_deposit_address" request with following parameters to generate deposit address on "tron" blockchain to further deposit "USDC" cryptocurrency on Client's main account.
{
"accountId": "",
"currency": "USDC",
"blockchain": "tron"
}
*This is an example of requesting the "USDC" deposit address on "tron" blockchain, but in fact any of 3 available blockchains could be indicated to get USDC deposit address.
4. Get Deposit Address Response
CEX.IO Prime Liquidity responds with generated address for depositing of "USDC" cryptocurrency on Client's main account via "tron" blockchain.
{
"ok": "ok",
"data": {
"address": "TPGgbhVN3vPKNnkF1XkX8eLLfPSpusZ4Qp",
"accountId": "",
"currency": "USDC",
"blockchain": "tron"
}
}
5. Funds Withdrawal Request
After some period of time there appears a necessity to transfer "USDC" to a specific address on "tron" blockchain.
Client sends a "do_withdrawal_funds" request with following parameters to withdraw 100 "USDC" to specific address via "tron" blockchain.
{
"accountId": "",
"clientTxId": "1223372036854775807",
"currency": "USDC",
"amount": "100",
"instrument": "crypto",
"blockchain": "tron",
"parameters": {
"address": "APVhtyMN5ePLGqwT7BaE3nUUzOInhjL1Vr"
}
}
6. Funds Withdrawal Response
CEX.IO Prime Liquidity responds that the request has been successfully processed and informs that transaction with unique clientTxId "1223372036854775807" for withdrawal of "USDC" cryptocurrency via "tron" blockchain is currently in "pending" status.
{
"ok": "ok",
"data": {
"clientTxId": "1223372036854775807",
"currency": "USDC",
"status": "pending",
"instrument": "crypto",
"blockchain": "tron"
}
}
7. Withdrawal Status Request
Afterwards, Client queries what is an up to date status of specified crypto withdrawal via selected blockchain to be sure withdrawal has been already sent to blockchain.
Client sends a "get_withdrawal_status" request with indicating unique clientTxId, currency "USDC", instrument "crypto" (used for external crypto withdrawals), and "tron" blockchain.
{
"clientTxId": "1223372036854775807",
"currency": "USDC",
"instrument": "crypto",
"blockchain": "tron"
}
8. Withdrawal Status Response
CEX.IO Prime Liquidity responds that the withdrawal in question has been successfully processed and sent to blockchain. Details as to charged external withdrawal commissions, blockchain address of recipient etc. are also indicated in the response.
{
"ok": "ok",
"data": {
"currency": "USDC",
"instrument": "crypto",
"clientTxId": "1476272036854775807",
"requestedAmount": "100.000000",
"commissionAmount": "1.000000",
"status": "approved",
"cexWalletTx": {
"status": "approved",
"amount": "100.000000",
"commissionAmount": "0.00000000"
},
"externalTx": {
"status": "approved",
"amount": "100.000000",
"commissionAmount": "1.000000",
"address": "APVhtyMN5ePLGqwT7BaE3nUUzOInhjL1Vr",
"blockchainTxId": "ab900691c7f2e3a68473403d68b92a5fb9a0b1ef8bdce8e850a7f29e1848302b"
}
}
}
Note, all the blockchains we have seen in the example could be used in different ways. Thus, Client can choose to generate deposit address on "ethereum" blockchain to deposit "USDC" funds, but to withdraw "USDC" funds via any other preferred blockchain - for example using "stellar" blockchain.