发起交易支付, 这个接口的响应值,会根据请求时渠道类型[channel],返回相应的data信息。 本文档列出的响应值data包含了所有可能的响应值。具体各个渠道的响应结果请参考测试工具。
演示请求地址 | http://demo.asbamboo.com/openpay-example/public/index.php/api |
---|---|
说明: 如果请求地址(url),浏览器不信任它,使用测试工具时,无法正常获取响应结果。所以,请先在浏览器受访问一下请求地址(url),确定请求地址(url)是受信任的。
字段 | 类型 | 取值范围 | 必须 | 默认值 | 说明 |
---|---|---|---|---|---|
api_name | string | api列表中支持的名称 | 必须 | trade.pay | api名称 |
format | string | json | json | 表示需要接口返回什么格式的数据,仅支持json | |
version | string | api列表中支持的版本 | api版本。如果没传,表示使用最新的版本 |
字段 | 类型 | 取值范围 | 必须 | 默认值 | 说明 |
---|---|---|---|---|---|
channel | string length(45) | ALIPAY_APP[支付宝APP支付] ALIPAY_PC[支付宝PC支付] ALIPAY_QRCD[支付宝扫码支付] WXPAY_APP[微信APP支付] WXPAY_H5[微信H5支付] WXPAY_QRCD[微信扫码支付] | 必须 | 支付渠道 | |
client_ip | string | 必须 | 客户ip | ||
notify_url | string length(200) | 聚合平台服务器主动通知接入应用指定的http url | |||
out_trade_no | string length(45) | 必须 | 交易编号(一笔支付对应一个out_trade_no) | ||
return_url | string length(200) | 聚合平台跳转到接入应用的指定url,返回参数通过get传递 | |||
third_part | json() | 可选 | [] | 第三方支付平台的参数,请自行查阅相关支付平台相关文档中的参数列表 | |
title | string length(45) | 必须 | 交易标题 | ||
total_fee | int | 必须 | 交易金额 单位为分 |
curl http://demo.asbamboo.com/openpay-example/public/index.php/api \
-d api_name=trade.pay \
-d channel=ALIPAY_APP \
-d client_ip=123.123.123.123 \
-d format=json \
-d notify_url=http%3A%2F%2Fapi.test.asbamboo.com%2Fnotify%2Ftrade%2Fpay \
-d out_trade_no=20220517061421975 \
-d return_url=http%3A%2F%2Fapi.test.asbamboo.com%2Freturn%2Ftrade%2Fpay \
-d third_part=%7B%22limit_pay%22%3A%22no_credit%22%7D \
-d title=%E6%94%AF%E4%BB%98%E6%B5%8B%E8%AF%95 \
-d total_fee=100 \
-d version=v1.0 \
字段名 | 类型 | 取值范围 | 说明 |
---|---|---|---|
code | string | 状态码。成功时返回'0'。 | |
data | data | 响应数据信息 见响应信息data具体字段 | |
message | string | 状态说明。成功时是"success", 错误时返回与code对应的错误信息 |
字段名 | 类型 | 取值范围 | 说明 |
---|---|---|---|
app_pay_json | string | APP支付时,创建交易订单,并获取APP支付请求参数, json格式的字符串,相关参数请参考第三分支付渠道相关文档。 | |
cancel_ymdhis | string date(YYYY-mm-dd HH:ii:ss) | 交易取消时间 | |
channel | string length(45) | ALIPAY_APP[支付宝APP支付] ALIPAY_PC[支付宝PC支付] ALIPAY_QRCD[支付宝扫码支付] WXPAY_APP[微信APP支付] WXPAY_H5[微信H5支付] WXPAY_QRCD[微信扫码支付] | 支付渠道 |
client_ip | string | 客户ip | |
in_trade_no | string length(32) | 交易编号 与支付请求的编号对应的聚合平台生成的交易编号 是一个全局唯一的编号 | |
out_trade_no | string length(45) | 交易编号只能是数字 | |
payed_ymdhis | string date(YYYY-mm-dd HH:ii:ss) | 交易支付成功[不可退款]时间 | |
payok_ymdhis | string date(YYYY-mm-dd HH:ii:ss) | 交易支付成功[可退款]时间 | |
qr_code | string length(200) | 二维码(买家扫商家适用),特定的支付渠道返回此参数 | |
title | string length(45) | 交易标题 | |
total_fee | int | 交易金额 单位为分 | |
trade_status | string length(45) | NOPAY[尚未支付] CANCLE[取消支付] PAYFAILED[支付失败] PAYING[正在支付] PAYOK[支付成功-可退款] PAYED[支付成功-不可退款] | 交易状态 |