KlicklPay 英文收单接口文档

KlicklPay 英文收单接口文档


Deposit application form inquiry

<p><strong>Brief description</strong></p> <ul> <li>Deposit application form inquiry</li> </ul> <p><strong>Request URL</strong></p> <ul> <li><code>URL of the test environment request: https://preoapi.klicklpay.com/api/v3/QueryRechargeOrder</code></li> <li><code>URL of the official environment request: https://oapi.klicklpay.com/api/v3/QueryRechargeOrder</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/QueryRechargeOrder?businessId=08d8f4d8-fcbb-4d69-84fe-6b9448063d0d&amp;paymentUserId=&amp;outOrderNo=20210618143651027710&amp;orderNo=O20210618024bf34dce9749af9f51f40a4bc37fdb&amp;coin=ERC20_USDT&amp;txId=0x2ffd9f562180a3882c7e27097263e2800141ce0e907813e0e5bd8573e5143f1a&amp;timeStamp=1624438173&amp;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>08d92518-c513-45b2-8509-4c1c8c5cb5f9</td> </tr> <tr> <td style="text-align: left;">outOrderNo</td> <td style="text-align: left;">no</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;">orderNo</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>O20210618024bf34dce9749af9f51f40a4bc37fdb</td> </tr> <tr> <td style="text-align: left;">paymentUserId</td> <td style="text-align: left;">no</td> <td>string</td> <td>Merchant user unique identity</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;">txId</td> <td style="text-align: left;">no</td> <td>string</td> <td>TXID</td> <td>0x2ffd9f562180a3882c7e27097263e2800141ce0e907813e0e5bd8573e5143f1a</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>Example of return content</strong></p> <pre><code>{     "data": {         "orderNo": "O2021070952d188833b624fb4878918b536716278",         "outOrderNo": "20210709184434613532",         "paymentUserId": "123456",         "amount": 0.3,         "actualPaymentAmount": 0.3,         "status": 4,         "address": "TQXjeNpPESXnFMipjRtnRJqYzU4ndFJzke",         "coin": "TRC20_USDT",         "txId": "fed29f23133e872b0ec76f4cfc2ec82619abb6f3515520fabd96daa34940eaf7",         "receivedTime": 1625798773750,         "exData": "EXData",         "creationTime": 1625798678949     },     "mac": "98ee4ba3eeac5684845bca296586fa3f",     "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 data.</td> </tr> <tr> <td style="text-align: left;">orderNo</td> <td style="text-align: left;">string</td> <td>64</td> <td>Platform order number</td> </tr> <tr> <td style="text-align: left;">outOrderNo</td> <td style="text-align: left;">string</td> <td>64</td> <td>Merchant order number</td> </tr> <tr> <td style="text-align: left;">paymentUserId</td> <td style="text-align: left;">string</td> <td>64</td> <td>Merchant user unique identity</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;">actualPaymentAmount</td> <td style="text-align: left;">decimal</td> <td>decimal(65,30)</td> <td>The actual amount paid by the user</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td></td> <td>Status (0: uncharged; 1: pending payment; 2: arrears payment; 3: overpayment; 4: completion; 5: manual completion; 6: close/withdrawal)</td> </tr> <tr> <td style="text-align: left;">address</td> <td style="text-align: left;">string</td> <td>256</td> <td>token address</td> </tr> <tr> <td style="text-align: left;">coin</td> <td style="text-align: left;">string</td> <td>32</td> <td>currency</td> </tr> <tr> <td style="text-align: left;">txId</td> <td style="text-align: left;">string</td> <td>256</td> <td>Chain transaction ID</td> </tr> <tr> <td style="text-align: left;">creationTime</td> <td style="text-align: left;">long</td> <td></td> <td>order time</td> </tr> <tr> <td style="text-align: left;">receivedTime</td> <td style="text-align: left;">long</td> <td></td> <td>Payment time</td> </tr> <tr> <td style="text-align: left;">exData</td> <td style="text-align: left;">string</td> <td>500</td> <td>Merchant extension data will be returned when notified asynchronously, within 500 characters, json format</td> </tr> <tr> <td style="text-align: left;">mac</td> <td style="text-align: left;">string</td> <td></td> <td>sign</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 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> </ul>

页面列表

ITEM_HTML