查询
入口
{api_domain}/upay/v2/query
签名验证
请参考签名机制文档
请求参数说明
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
terminal_sn | 收钱吧终端ID | String(32) | Y | 收钱吧终端ID | "010382829292929" |
sn | 收钱吧系统订单号 | String(16) | N | 收钱吧系统唯一订单号 | "7894259244061958" |
client_sn | 商户自己的订单号 | String(32) | N | 商户自己订号 | "2324545839" |
refund_request_no | 退款序列号 | String(20) | N | 调用退款接口时,传入得值,可用于多次部分退款场景下,查询某次部分退款的结果 | "01" |
sn与client_sn不能同时为空,优先按照sn查找订单,如果没有,再按照client_sn查询
同步返回参数说明
参数 | 参数名称 | 类型 | 必填 | 描述 | 范例 |
---|---|---|---|---|---|
result_code | 结果码 | String | Y | 结果码表示接口调用的业务逻辑是否成功 | "SUCCESS" |
error_code | 错误码 | String | N | 参考附录:业务执行错误码列表 | "TRADE_TIMEOUT" |
error_message | 错误消息 | String | N | 参考附录:业务执行错误码列表 | "交易超时自动撤单" |
terminal_sn | 收钱吧终端ID | String(32) | Y | 收钱吧终端ID, | "01012010201201029" |
sn | 收钱吧唯一订单号 | String(16) | Y | 收钱吧系统内部唯一订单号 | "7894259244061958" |
client_sn | 商户订单号 | String(32) | Y | 商户系统订单号。 | "22345677767776" |
status | 流水状态 | String(32) | Y | 本次操作对应的流水的状态 | "SUCCESS" |
order_status | 订单状态 | String(32) | Y | 当前订单状态 | "REFUNDED" |
payway | 支付方式 | String(32) | Y | 订单支付方式 | "3" |
payway_name | 支付方式名称 | String(128) | Y | "微信" | |
payer_uid | 付款人id | String(64) | Y | 订单付款人的id | 如微信"oGFfksxxsiXIWSPsNy4Mu-YhBB-I" |
trade_no | 支付平台的订单凭证号 | String(64) | Y | 支付宝或微信的订单号 | "2006101016201512090096528672" |
total_amount | 交易总金额 | String(10) | Y | 原始交易实收金额 | "100" |
net_amount | 剩余金额 | String(10) | Y | 实收金额减退款金额 | "0" |
settlement_amount | 本次操作金额 | String(10) | N | 订单支付时等于本次支付金额,订单退款时等于本次操作退款金额 | "100" |
finish_time | 上次操作在收钱吧的完成时间 | String(13) | N | 时间戳,本次动作在收钱吧的完成时间,只有支付成功、退款成功、撤单成功才有值返回 | "1449646835244" |
channel_finish_time | 上次操作再支付平台完成的时间 | String(13) | N | 时间戳,本次动作在微信或支付宝的完成时间,只有支付成功、退款成功、撤单成功才有值返回 | "1449646835221" |
subject | 商品概述 | String(32) | Y | 交易时候的商品概述 | "wx" |
operator | 操作员 | String(64) | Y | 执行上次业务动作的操作员 | "Obama" |
provider_response | 优惠详情 | JSON | N | 格式为json,内容有两部分 goods_details为数组,内容为核销单品信息,voucher_details为数组,内容为核销券信息。 | 详见优惠详情介绍 |
payment_list | 活动优惠 | JSON[] | N | 订单内活动优惠信息概览 格式为数组,元素为json对象。 |
详见活动优惠 |
返回的状态码请参考附录
查询接口返回示例
查单成功
{
"biz_response": {
"result_code": "SUCCESS",
"data": {
"client_tsn": "726d47ded14818c906cd1a006d4e5050",
"store_id": "test",
"subject": "test",
"payway": "2",
"description": "[{\"id\":\"\",\"name\":\"未命名商品\",\"num\":\"1\",\"price\":\"3000\"}]\n",
"payment_list": [ {
"type": "BANKCARD_DEBIT",
"amount_total": "1"
},
{
"type": "DISCOUNT_CHANNEL_MCH",
"amount_total": "100"
}],
"client_sn": "test",
"operator": "test",
"sub_payway": "1",
"order_status": "PAID",
"total_amount": "300000",
"ctime": "1498446309605",
"sn": "7895259867120667",
"net_amount": "0",
"terminal_id": "a2369b8b-546f-42e1-baec-e1d54690bab8",
"status": "SUCCESS"
}
},
"result_code": "200"
}
查询接口接入过程常见问题
1.何时调用查询接口
1)调用预下单接口(precreate)预下单成功后,需要调用查询接口发起轮询。
2)调用支付接口(pay)支付后没有得到订单的最终状态,需要调用查询接口获取订单最终状态。
3)调用退款接口(refund)发起退款后没有得到退款最终状态,需要调用查询接口获取退款最终状态。
4)调用撤单接口(revoke/cancel)发起撤单或冲正之后没有得到撤单的最终状态,需要调用查询接口获取撤单的最终状态。
5)为了预防出现单边账,建议对接方手动加一个查询按钮,当支付完成后,如果消费者支付成功,但是终端显示支付失败或者状态不明确,这个时候可以给收银员一个手动查询订单状态的操作,如果查询得到的状态依旧不是成功,就需要联系收钱吧客服人工接入了。