KlicklPay 英文收单接口文档

KlicklPay 英文收单接口文档


Withdrawl application

<p><strong>Brief description</strong></p> <ul> <li>Withdrawal application</li> <li><strong>Note: This interface needs to be handled with great care and risk control</strong></li> </ul> <p><strong>Request URL</strong></p> <ul> <li><code>URL of the test environment request: https://preoapi.klicklpay.com/api/v3/Withdrawal</code></li> <li><code>URL of the official environment request: https://oapi.klicklpay.com/api/v3/Withdrawal</code></li> </ul> <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;">outWithdrawalNo</td> <td style="text-align: left;">yes</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>20150320010101001</td> </tr> <tr> <td style="text-align: left;">withdrawalUserId</td> <td style="text-align: left;">yes</td> <td>string</td> <td>Merchant-side order number. Customized by the merchant, within 64 characters</td> <td>123</td> </tr> <tr> <td style="text-align: left;">coin</td> <td style="text-align: left;">yes</td> <td>string</td> <td>Coin(BTC、ETH、ERC20_USDT、TRC20_USDT)</td> <td>BTC</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">yes</td> <td>decimal</td> <td>Withdrawal amount</td> <td>100</td> </tr> <tr> <td style="text-align: left;">address</td> <td style="text-align: left;">yes</td> <td>string</td> <td>Withdrawal addresst</td> <td></td> </tr> <tr> <td style="text-align: left;">callBackUrl</td> <td style="text-align: left;">no</td> <td>string</td> <td>Callback address (Note: priority callback callback this parameter callBackUrl, no fill, with the callback address set by the merchant callback)</td> <td></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>9eae4f3dfc19c5381cc1ca157f07d558</td> </tr> </tbody> </table> <p><strong>Request method:</strong></p> <ul> <li><code>POST</code></li> </ul> <p><strong>Example of request</strong></p> <pre><code>http://xxx.xxx.xxx/api/v3/Withdrawal?businessId=08d8f4d8-fcbb-4d69-84fe-6b9448063d0d&amp;outWithdrawalNo=201503200101010011&amp;withdrawalUserId=userId1&amp;coin=TRC20_USDT&amp;amount=100&amp;address=0xdce3084c02ebfab8e5b7cedcf89c91cd52027c06&amp;timeStamp=1624438173&amp;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&amp;amount=100&amp;businessId=01d91687-ab8a-1f56-8a35-be8bdde4ee1e&amp;callBackUrl=https://api.com/callback&amp;coin=TRC20_USDT&amp;outWithdrawalNo=20210204074728134184613&amp;timeStamp=1644114756&amp;withdrawalUserId=1&amp;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>Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">string</td> <td>Return date</td> </tr> <tr> <td style="text-align: left;">withdrawalNo</td> <td style="text-align: left;">string</td> <td>Payment platform withdrawing orderl number</td> </tr> <tr> <td style="text-align: left;">fee</td> <td style="text-align: left;">decimal(65,30)</td> <td>Withdrawal fee</td> </tr> <tr> <td style="text-align: left;">stableCoinAcceptanceFee</td> <td style="text-align: left;">decimal(65,30)</td> <td>Stabilized coin exchange fee</td> </tr> <tr> <td style="text-align: left;">outWithdrawalNo</td> <td style="text-align: left;">string</td> <td>Merchant platform withdrawal order number</td> </tr> <tr> <td style="text-align: left;">mac</td> <td style="text-align: left;">string</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>Status: true success, false failure</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>Error code</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</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>

页面列表

ITEM_HTML