Payment Open API


支付查询

<p>[TOC]</p> <h4>简要描述</h4> <ul> <li>商户业务系统通过支付查询接口,查询支付收款订单,支付中心会返回订单最新的数据。</li> </ul> <h4>请求URL</h4> <ul> <li><code>https://live.dreamo9.com/api/payment/query</code></li> </ul> <h4>请求方式</h4> <ul> <li><code>POST</code></li> </ul> <h4>请求类型</h4> <ul> <li><code>application/json</code></li> </ul> <h4>参数</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">参数描述</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">示例值</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mchNo</td> <td style="text-align: left;">商户号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">M1234567890</td> <td>商户号</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">应用ID</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">60cc09bce4b0f1c0b83761c9</td> <td>应用ID</td> </tr> <tr> <td style="text-align: left;">payOrderId</td> <td style="text-align: left;">支付订单号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">P202205101000111111</td> <td>支付中心生成的订单号,与mchOrderNo二者传一即可</td> </tr> <tr> <td style="text-align: left;">mchOrderNo</td> <td style="text-align: left;">商户订单号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">202205101000000000</td> <td>商户生成的订单号,与payOrderId二者传一即可</td> </tr> <tr> <td style="text-align: left;">reqTime</td> <td style="text-align: left;">请求时间</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td style="text-align: left;">1652148000000</td> <td>请求接口时间,13位时间戳</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">签名</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">C380BEC2BFD727A4B6845133519F3AD6</td> <td>签名值,详见签名算法(大写 MD5 签名值)</td> </tr> </tbody> </table> <h4>返回参数说明</h4> <table> <thead> <tr> <th>参数描述</th> <th>参数名</th> <th>必填</th> <th>类型</th> <th>示例值</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>返回状态</td> <td>code</td> <td>是</td> <td>int</td> <td>0</td> <td>0: 成功 其他: 失败&lt;/br&gt;<code>详见错误码</code></td> </tr> <tr> <td>返回信息</td> <td>msg</td> <td>否</td> <td>String(128)</td> <td>签名失败</td> <td>具体错误原因&lt;/br&gt;例如:签名失败、参数格式校验错误</td> </tr> <tr> <td>签名信息</td> <td>sign</td> <td>否</td> <td>String(32)</td> <td>1F0A241B0349894B0C8D68BE0CB40EE1</td> <td>对data内数据签名,如data为空则不返回</td> </tr> <tr> <td>返回数据</td> <td>data</td> <td>否</td> <td>String(512)</td> <td>{}</td> <td>指定返回数据,json格式数据</td> </tr> </tbody> </table> <h5>data数据格式</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">参数描述</th> <th style="text-align: left;">必填</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">示例值</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">payOrderId</td> <td style="text-align: left;">支付订单号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">P12021022311124442600</td> <td>支付系统订单号</td> </tr> <tr> <td style="text-align: left;">mchNo</td> <td style="text-align: left;">商户号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">M1621873433953</td> <td>商户号</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">应用ID</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">60cc09bce4b0f1c0b83761c9</td> <td>应用ID</td> </tr> <tr> <td style="text-align: left;">mchOrderNo</td> <td style="text-align: left;">商户订单号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(32)</td> <td style="text-align: left;">202205101000000000</td> <td>商户传入的订单号</td> </tr> <tr> <td style="text-align: left;">amount</td> <td style="text-align: left;">支付金额</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td style="text-align: left;">10000</td> <td>单位: 分</td> </tr> <tr> <td style="text-align: left;">currency</td> <td style="text-align: left;">货币代码</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(3)</td> <td style="text-align: left;">INR</td> <td>三位货币代码:&lt;/br&gt;INR: 印度卢比&lt;/br&gt;BRL: 巴西雷亚儿&lt;/br&gt;PKR: 巴基斯坦卢比</td> </tr> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">订单状态</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td style="text-align: left;">2</td> <td>订单支付状态:&lt;/br&gt;<code>0:订单生成</code>&lt;br/&gt;<code>1:支付中</code>&lt;br/&gt;<code>2:支付成功</code>&lt;/br&gt;<code>3:支付失败</code>&lt;/br&gt;<code>4:已撤销</code>&lt;/br&gt;<code>5:已退款</code>&lt;/br&gt;<code>6:订单关闭</code>&lt;/br&gt;<code>7:部分支付</code>&lt;/br&gt;<code>8:超额支付</code></td> </tr> <tr> <td style="text-align: left;">payAmount</td> <td style="text-align: left;">实际支付金额</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td style="text-align: left;">9000</td> <td>只有BDT币种会返回该字段 <code>单位: 分</code></td> </tr> <tr> <td style="text-align: left;">clientIp</td> <td style="text-align: left;">客户端IP</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(16)</td> <td style="text-align: left;">61.73.10.150</td> <td>客户端 IPV4 地址</td> </tr> <tr> <td style="text-align: left;">customerName</td> <td style="text-align: left;">客户姓名</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(64)</td> <td style="text-align: left;">Nitin Gadge</td> <td>客户姓名</td> </tr> <tr> <td style="text-align: left;">customerEmail</td> <td style="text-align: left;">客户邮箱</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(64)</td> <td style="text-align: left;">Nitin198483@gmail.com</td> <td>客户邮箱</td> </tr> <tr> <td style="text-align: left;">customerPhone</td> <td style="text-align: left;">客户手机号</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String(64)</td> <td style="text-align: left;">8197220658</td> <td>客户手机号</td> </tr> <tr> <td style="text-align: left;">channelOrderNo</td> <td style="text-align: left;">渠道订单号</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td style="text-align: left;">C202205101000222222</td> <td>对应渠道的订单号</td> </tr> <tr> <td style="text-align: left;">errCode</td> <td style="text-align: left;">渠道错误码</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td style="text-align: left;">1002</td> <td>渠道下单返回的错误码</td> </tr> <tr> <td style="text-align: left;">errMsg</td> <td style="text-align: left;">渠道错误描述</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Business Failed 失败</td> <td>渠道下单返回的错误描述</td> </tr> <tr> <td style="text-align: left;">extParam</td> <td style="text-align: left;">商户扩展参数</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(512)</td> <td style="text-align: left;">1234567890</td> <td>回调时会原样返回</td> </tr> <tr> <td style="text-align: left;">outExtInfo</td> <td style="text-align: left;">扩展信息参数</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String(512)</td> <td style="text-align: left;">1234567890</td> <td>扩展信息参数</td> </tr> <tr> <td style="text-align: left;">createdAt</td> <td style="text-align: left;">创建时间</td> <td style="text-align: left;">是</td> <td style="text-align: left;">long</td> <td style="text-align: left;">1652148000000</td> <td>订单创建时间,13位时间戳</td> </tr> <tr> <td style="text-align: left;">successTime</td> <td style="text-align: left;">成功时间</td> <td style="text-align: left;">否</td> <td style="text-align: left;">long</td> <td style="text-align: left;">1652168000000</td> <td>订单支付成功时间,13位时间戳</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot; : 0, &amp;quot;msg&amp;quot; : &amp;quot;SUCCESS&amp;quot;, &amp;quot;sign&amp;quot; : &amp;quot;CCD9083A6DAD9A2DA9F668C3D4517A84&amp;quot;, &amp;quot;data&amp;quot; : {} }</code></pre> <h4>备注</h4>

页面列表

ITEM_HTML