用于交易创建后,用户在一定时间内未进行支付,可调用该接口直接将未付款的交易进行关闭。
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
app_id | String | 必选 | 32 | 小程序 id | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | trade.close |
format | String | 可选 | 40 | 仅支持 JSON | JSON |
charset | String | 必选 | 10 | 请求使用的编码格式,如 utf-8,gbk,gb2312 等 | utf-8 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持 RSA2 和 RSA,推荐使用 RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 必选 | 19 | 发送请求的时间,格式 | 2014-07-24 03:07:50 |
version | String | 必选 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
biz_content | String | 必选 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 | - |
业务请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
out_trade_no | String | 必选 | 64 | 商户订单号,由商家自定义,64个字符以内,仅支持字母、数字、下划线且需保证在商户端不重复 | 20150320010101001 |
trade_no | String | 必选 | 64 | 该交易在平台系统中的交易流水号。最短 16 位,最长 64 位。和 out_trade_no 不能同时为空,如果同时传了 out_trade_no 和 trade_no,则以 trade_no 为准 | 2013112611001004680073956707 |
常见请求示例
默认示例:
curl 'https://xxx/gateway.do?charset=UTF-8&method=trade.close&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'biz_content={
"trade_no":"2013112611001004680073956707",
"out_trade_no":"HZ0120131127001"
}'
本示例仅供参考。
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
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= |
业务响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
out_trade_no | String | 必选 | 64 | 商户订单号 | 20150423001001 |
trade_no | String | 必选 | 64 | Payme 交易号 | 2015042321001004720200028594 |
响应示例
{
"trade_create_response": {
"code": "10000",
"msg": "Success",
"out_trade_no": "20150423001001",
"trade_no": "2015042321001004720200028594"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}