Withdrawal request order inquiry
<p><strong>Brief description</strong></p>
<ul>
<li> Withdrawal request order inquiry</li>
</ul>
<p><strong>Request URL</strong></p>
<ul>
<li><code>URL of the test environment request: https://preoapi.klicklpay.com/api/v3/QueryWithdrawalOrder</code></li>
<li><code>URL of the official environment request: https://oapi.klicklpay.com/api/v3/QueryWithdrawalOrder</code></li>
</ul>
<p><strong>Request method:</strong></p>
<ul>
<li><code>GET</code></li>
</ul>
<p><strong>Example of request</strong></p>
<pre><code>http://xxx.xxx.xxx/api/v3/QueryWithdrawalOrder?businessId=08d8f4d8-fcbb-4d69-84fe-6b9448063d0d&withdrawalUserId=&outWithdrawalNo=20210618143651027710&withdrawalNo=O20210618024bf34dce9749af9f51f40a4bc37fdb&coin=ERC20_USDT&txId=0x2ffd9f562180a3882c7e27097263e2800141ce0e907813e0e5bd8573e5143f1a&timeStamp=1624438173&mac=9eae4f3dfc19c5381cc1ca157f07d558</code></pre>
<p><strong>Request parameter description</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Required field</th>
<th>Type</th>
<th>Description</th>
<th>Example value</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">businessId</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Merchant ID in the merchant backend</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">outWithdrawalNo</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>Merchant platform order number. Customized by the merchant, within 64 characters, only letters, numbers and underscores are supported and must be guaranteed not to be repeated on the merchant side.</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">withdrawalNo</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>Platform order number, within 64 characters, outOrderNo and orderNo cannot be empty at the same time</td>
<td></td>
</tr>
<tr>
<td style="text-align: left;">withdrawalUserId</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>Unique identification for merchant platform users</td>
<td>123</td>
</tr>
<tr>
<td style="text-align: left;">coin</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>Coin</td>
<td>BTC</td>
</tr>
<tr>
<td style="text-align: left;">timeStamp</td>
<td style="text-align: left;">yes</td>
<td>long</td>
<td>Current UTC time stamp</td>
<td>1624438173</td>
</tr>
<tr>
<td style="text-align: left;">mac</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Signature</td>
<td></td>
</tr>
</tbody>
</table>
<p><strong>Request method:</strong></p>
<ul>
<li>POST</li>
</ul>
<p><strong>Example of request</strong></p>
<pre><code>http://xxx.xxx.xxx/api/v3/Withdrawal?businessId=08d8f4d8-fcbb-4d69-84fe-6b9448063d0d&outWithdrawalNo=201503200101010011&withdrawalUserId=userId1&coin=TRC20_USDT&amount=100&address=0xdce3084c02ebfab8e5b7cedcf89c91cd52027c06&timeStamp=1624438173&mac=9eae4f3dfc19c5381cc1ca157f07d558</code></pre>
<p><strong>Example of signature</strong>
(Sort the parameters in ascending order by name, then add the key for MD5 to get the mac value)</p>
<pre><code>mac=MD5(address=TE1ra3Zy5U1DuXU97njGZmdizefcTnoKd1&amount=100&businessId=01d91687-ab8a-1f56-8a35-be8bdde4ee1e&callBackUrl=https://api.com/callback&coin=TRC20_USDT&outWithdrawalNo=20210204074728134184613&timeStamp=1644114756&withdrawalUserId=1&secretKey=b33d9fa8-ba71-474e-96bc-4217e4b989d6)</code></pre>
<p><strong>Example of return content</strong></p>
<pre><code> {
"data": {
"fee": "0.01",
"stableCoinAcceptanceFee": "0.01",
"withdrawalNo": "T20210618024bf34dce9749af9f51f40a4bc37fdb",
"outWithdrawalNo": "20150320010101001"
},
"mac": "4fed5e1b7cdaeed34dc00fee3df1a9ee",
"isSuccess": true,
"code": 200,
"msg": null
}</code></pre>
<p><strong>Return parameter description</strong></p>
<table>
<thead>
<tr>
<th style="text-align: left;">Parameter name</th>
<th style="text-align: left;">Type</th>
<th>Maximum length</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">string</td>
<td></td>
<td>Return date</td>
</tr>
<tr>
<td style="text-align: left;">withdrawalNo</td>
<td style="text-align: left;">string</td>
<td>64</td>
<td>Payment platform withdrawal order number</td>
</tr>
<tr>
<td style="text-align: left;">outWithdrawalNo</td>
<td style="text-align: left;">string</td>
<td>64</td>
<td>Merchant platform withdrawal order number</td>
</tr>
<tr>
<td style="text-align: left;">withdrawalUserId</td>
<td style="text-align: left;">string</td>
<td>64</td>
<td>Unique identification for merchant platform users</td>
</tr>
<tr>
<td style="text-align: left;">amount</td>
<td style="text-align: left;">decimal</td>
<td>decimal(65,30)</td>
<td>Order amount</td>
</tr>
<tr>
<td style="text-align: left;">fee</td>
<td style="text-align: left;">decimal</td>
<td>decimal(65,30)</td>
<td>Withdrawal fee</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td></td>
<td>Status(0:Pending Merchant Review; 1:Pending Operation Review; 2:Pending Release; 3: Transfer in progress; 4:Rejected; 5:Completed)</td>
</tr>
<tr>
<td style="text-align: left;">address</td>
<td style="text-align: left;">string</td>
<td>256</td>
<td>Withdrawal address</td>
</tr>
<tr>
<td style="text-align: left;">coin</td>
<td style="text-align: left;">string</td>
<td>32</td>
<td>coin</td>
</tr>
<tr>
<td style="text-align: left;">txId</td>
<td style="text-align: left;">string</td>
<td>256</td>
<td>Transaction ID for chain</td>
</tr>
<tr>
<td style="text-align: left;">creationTime</td>
<td style="text-align: left;">long</td>
<td></td>
<td>Order creation time</td>
</tr>
<tr>
<td style="text-align: left;">mac</td>
<td style="text-align: left;">string</td>
<td></td>
<td>Signature, the value obtained by signing the data in data</td>
</tr>
<tr>
<td style="text-align: left;">isSuccess</td>
<td style="text-align: left;">bool</td>
<td></td>
<td>Status: true success, false failure</td>
</tr>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">int</td>
<td></td>
<td>Error code</td>
</tr>
<tr>
<td style="text-align: left;">msg</td>
<td style="text-align: left;">string</td>
<td></td>
<td>Error message, returns null on successdate</td>
</tr>
</tbody>
</table>
<p><strong>Note:</strong></p>
<ul>
<li>For more return error codes, please see the error code description on the home page</li>
</ul>