商户订单实时信息查询
请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
method | String | 必选 | 128 | 接口名称 | alipay.trade.order.settle |
charset | String | 必选 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
version | String | 必选 | 3 | 版本号,默认1.0 | 1.0 |
biz_app_id | String | 可选 | 32 | 商户app_id | 2014072300007148 |
invoke_app_id | String | 可选 | 32 | 调用方app_id | 2014072300007148 |
utc_timestamp | String | 必选 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
请求参数
Header
Query
Body
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
merchant_order_no | String | 特殊可选 | 128 | 外部订单号:商户自己系统内的订单id,需与商户同步支付宝订单中心入参的商户订单id相同。单比查询必须传入该字段 | 7695428890423 |
merchant_order_nos | String | 特殊可选 | 2000 | 逗号分隔的外部订单号:商户自己系统内的订单id,需与商户同步支付宝订单中心入参的商户订单id相同。一般会控制在20个之内,如果需要支持批量查询能力该字段必传 | 7695428890423,7695428890424,7695428890425 |
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见文档 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
success | String | 必选 | 10 | 是否成功查询到数据,值为true/false | true |
result | String | 特殊可选 | 30000 | json格式的结果,返回约定的所有信息,当success为true时必填。如果是批量查询实现,返回格式为{"key1":json1,"key2":json2},如{"7695428890423":{"driver_board_duration":"360"},"7695428890424":{"driver_board_duration":"628"}} | {"merchant_order_status":"MERCHANT_ORDERD","driver_board_distance":"2600","driver_board_duration":"360"} |
error_code | String | 特殊可选 | 128 | 商户自定义的错误码,当success为false时必填,便于排查问题,可参考文档示例的错误码来定义 | BIZ_ERROR |
error_desc | String | 特殊可选 | 128 | 商户自定义错误码对应的描述,当success为false时必填,便于排查问题 | 当前订单不在进行中状态 |
响应示例
{
"response": {
"code": "10000",
"msg": "Success",
"success": "true",
"result": "{\"merchant_order_status\":\"MERCHANT_ORDERD\",\"driver_board_distance\":\"2600\",\"driver_board_duration\":\"360\"}",
"error_code": "BIZ_ERROR",
"error_desc": "当前订单不在进行中状态"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"response": {
"code": "40004",
"msg": "Business Failed",
"sub_code": "BIZ_ERROR",
"sub_msg": "业务异常"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
错误码
公共错误码
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
BIZ_ERROR | 业务异常 | 商户业务错误,联系ISV解决 |
INVALID_PARAMETER | 参数有误 | 参数不合法,自行排查或联系ISV解决 |
SYSTEM_ERROR | 系统繁忙 | 商户系统异常,联系ISV解决 |