Asbamboo Openpay API
版本: v1.0

取消交易trade.cancel

取消交易支付

请求地址

演示请求地址 http://demo.asbamboo.com/openpay-example/public/index.php/api

说明: 如果请求地址(url),浏览器不信任它,使用测试工具时,无法正常获取响应结果。所以,请先在浏览器受访问一下请求地址(url),确定请求地址(url)是受信任的。


公共请求参数

字段 类型 取值范围 必须 默认值 说明
api_name string api列表中支持的名称 必须 trade.cancel api名称
format string json json 表示需要接口返回什么格式的数据,仅支持json
version string api列表中支持的版本 api版本。如果没传,表示使用最新的版本

请求参数

字段 类型 取值范围 必须 默认值 说明
in_trade_no string length(32) 当out_trade_no为空时必填 交易编号(聚合系统内的) 如果out_trade_no同时存在, 优先使用in_trade_no
out_trade_no string length(45) 当in_trade_no为空时必填 交易编号(对接应用的) 如果in_trade_no同时存在, 优先使用in_trade_no
third_part json() 可选 [] 第三方支付平台的参数,请自行查阅相关支付平台相关文档中的参数列表

请求示例

curl http://demo.asbamboo.com/openpay-example/public/index.php/api \
-d api_name=trade.cancel \
-d format=json \
-d in_trade_no= \
-d out_trade_no=2018101310270023 \
-d third_part=%7B%22limit_pay%22%3A%22no_credit%22%7D \
-d version=v1.0 \

响应参数

字段名 类型 取值范围 说明
code string 状态码。成功时返回'0'。
data data 响应数据信息 见响应信息data具体字段
message string 状态说明。成功时是"success", 错误时返回与code对应的错误信息

响应信息data具体字段

字段名 类型 取值范围 说明
cancel_ymdhis date(YYYY-mm-dd HH:ii:ss) 交易取消时间
channel string(45) ALIPAY_APP[支付宝APP支付] ALIPAY_PC[支付宝PC支付] ALIPAY_QRCD[支付宝扫码支付] WXPAY_APP[微信APP支付] WXPAY_H5[微信H5支付] WXPAY_QRCD[微信扫码支付] 支付渠道
client_ip string(20) 客户ip
in_trade_no number(32) 交易编号 与支付请求的编号对应的聚合平台生成的交易编号 是一个全局唯一的编号
out_trade_no string(45) 交易编号只能是数字
title string(45) 交易标题
total_fee int(10) 交易金额 单位为分
trade_status string(45) NOPAY[尚未支付] CANCLE[取消支付] PAYFAILED[支付失败] PAYING[正在支付] PAYOK[支付成功-可退款] PAYED[支付成功-不可退款] 交易状态

响应示例