Deposit application
<p><strong>Brief description:</strong></p>
<ul>
<li>Deposit application</li>
</ul>
<p><strong>Request URL:</strong></p>
<ul>
<li><code>Test environment: https://preoapi.klicklpay.com/api/v3/Payment</code></li>
<li><code>Production environment: https://oapi.klicklpay.com/api/v3/Payment</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;">businessId</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Merchant ID in the merchant backend</td>
<td>08d92518-c513-45b2-8509-4c1c8c5cb5f9</td>
</tr>
<tr>
<td style="text-align: left;">outOrderNo</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Merchant-side 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;">paymentUserId</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Merchant side user ID, 64 characters or less. The VGPay platform will limit the number of unloaded orders based on the user ID, if the user ID is not passed, the entire merchant may only have x unloaded orders.</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>string</td>
<td>Payment amount,value range：[0.00001, ∞ ]</td>
<td>100</td>
</tr>
<tr>
<td style="text-align: left;">orderType</td>
<td style="text-align: left;">yes</td>
<td>string</td>
<td>Order Type(0、consumption 1、deposit)</td>
<td>BTC</td>
</tr>
<tr>
<td style="text-align: left;">productName</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>Product name</td>
</tr>
<tr>
<td style="text-align: left;">exData</td>
<td style="text-align: left;">no</td>
<td>string</td>
<td>merchant extension data, returned during asynchronous notification, within 500 characters, in json format</td>
<td>{"action":"test"}</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 callBackUrl fill in the callback address, no fill in the callback address set by the merchant callback, no need to url code the callBackUrl )</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 request</strong></p>
<pre><code>http://xxx.xxx.xxx/api/v3/Payment?businessId=08d8f4d8-fcbb-4d69-84fe-6b9448063d0d&outOrderNo=201503200101010011&paymentUserId=1&coin=TRC20_USDT&amount=100&orderType=1&productName=product&exData=&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）
Example of signature when the productName and exData are not passed to the deposit request:</p>
<pre><code>mac=MD5(amount=100&businessId=08d9526c-5070-41f1-8b5f-7379277bb16b&coin=TRC20_USDT&orderType=1&outOrderNo=202103200101010011&timeStamp=1624438173&secretKey=b33d9fa8-ba71-474e-96bc-4217e4b989d6</code></pre>
<p><strong>Example of a signature when a productName and exData are passed to the deposit request:</strong></p>
<pre><code>mac=MD5(mac=MD5(amount=100&businessId=08d9526c-5070-41f1-8b5f-7379277bb16b&coin=TRC20_USDT&exData=exData&orderType=1&outOrderNo=202103200101010011&productName=product&timeStamp=1624438173&secretKey=b33d9fa8-ba71-474e-96bc-4217e4b989d6)</code></pre>
<p><strong>Example of return content</strong></p>
<pre><code>{
"data": {
"address": "TYApCbSHFaGFdUpDfwmRezu2QnZdAosAwk",
"orderNo": "O20210618024bf34dce9749af9f51f40a4bc37fdb",
"outOrderNo": "20150320010101001",
"paymentUrl": "",
"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 data</td>
</tr>
<tr>
<td style="text-align: left;">address</td>
<td style="text-align: left;">string</td>
<td>deposite address</td>
</tr>
<tr>
<td style="text-align: left;">orderNo</td>
<td style="text-align: left;">string</td>
<td>Platform order number</td>
</tr>
<tr>
<td style="text-align: left;">outOrderNo</td>
<td style="text-align: left;">string</td>
<td>Merchant order number</td>
</tr>
<tr>
<td style="text-align: left;">paymentUrl</td>
<td style="text-align: left;">string</td>
<td>Payment Jump Page</td>
</tr>
<tr>
<td style="text-align: left;">mac</td>
<td style="text-align: left;">string</td>
<td>Signature</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 success</td>
</tr>
</tbody>
</table>
<p><strong>Notes</strong></p>
<ul>
<li> For more return error codes, please refer to the error code description on the homepage.</li>
<li><code>Do not deposit real coins in the test environment</code></li>
</ul>