接口说明
调用方:商户接入系统
接收方:银账通系统
功能:实时接收订单上传交易明细,接口返回成功表示订单已成功接收,订单处理成功将通过订单上传结果通知接口进行异步通知。
请求地址及接口名
生产环境:https://fzxt-yzt-openapi.wangcaio2o.com
测试环境:https://fzxt-yzt-openapi.imageco.cn
接口名(method):funds.bill.upload
公共请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
app_id | string(32) | 是 | 接入方appId | 20210911888888888888888888 |
method | string(32) | 是 | 接口名 | funds.bill.upload |
format | string(16) | 是 | 报文格式,仅支持JSON | json |
charset | string(16) | 是 | 字符编码 | UTF-8 |
sign_type | string(8) | 是 | 签名算法类型,仅支持RSA2 | RSA2 |
timestamp | string(16) | 是 | 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。服务端允许客户端请求最大时间误差为10分钟 | 2021-09-11 12:00:00 |
version | string(8) | 是 | 版本号 | 1.0 |
app_auth_token | string(128) | 否 | token | 01c9a4191bfd4609d26 |
sign | string(256) | 是 | 请求参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
biz_content | string | 是 | 业务请求参数,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 | {“file”:””,”type”:”1”} |
业务请求参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
trade_type | string(8) | 是 | 交易类型:1-支付,2-退款 | 1 |
goods_detail | string(6000) | 否 | 商品信息 | 详见goods_detail说明 |
node_id | string(8) | 是 | 机构号 | 100001 |
order_amount | integer | 是 | 订单金额,单位分 | 199 |
order_id | string(32) | 是 | 订单交易流水号 | 100010001 |
order_time | string(16) | 是 | 订单交易时间 | 20240301131800 |
org_order_id | string(32) | 否 | 原订单交易流水号 | 100010000 |
pay_merchant_id | string(32) | 否 | 第三方支付渠道商户号 | 1302329392 |
pay_type | string(8) | 否 | 支付渠道:502-支付宝,503-微信,512-银联云闪付 | 502 |
store_id | string(16) | 是 | 门店id | 20008221 |
trade_no | string(32) | 否 | 支付平台订单号 | 2019112011001004330000121536 |
user_id | string(8) | 否 | 操作员标识 | 01 |
fee_amount | integer | 否 | 交易手续费,单位分 | 1 |
split_rule_source | string(8) | 否 | 分账规则来源:1-接口,不传默认为空,表示控台 | 1 |
split_refund_seq | string(64) | 否 | 分账退回流水号 仅浙商通道退款订单上传时必填 | 1001XP2025010110000001_S01_R01 |
goods_detail 商品信息 (JSONArray)
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
goods_id | string(32) | 是 | 商品的编号 | apple-01 |
goods_name | string(256) | 是 | 商品名称 | ipad |
quantity | integer | 是 | 商品数量 | 1 |
price | integer | 是 | 商品单价,单位为分 | 200000 |
real_price | integer | 是 | 商品实际单价,单位为分 | 199999 |
goods_category | string(24) | 否 | 商品类目 | 34543238 |
body | string(1024) | 否 | 商品描述信息 | 特价手机 |
goods_fee_amount | integer | 否 | 商品金额手续费,单位为分 | 1 |
范例:
[
{
"goods_name": "ipad",
"quantity": 1,
"price": 200000,
"real_price": 199999,
"goods_id": "apple-01",
"goods_category": "34543238",
"body": "特价手机",
"goods_fee_amount": 1
},
{
"goods_name": "ipad2",
"quantity": 1,
"price": 200000,
"real_price": 199999,
"goods_id": "apple-02",
"goods_category": "34543239",
"body": "特价手机2",
"goods_fee_amount": 1
}
]
请求示例
{
"charset": "utf-8",
"biz_content": "{\"fee_amount\":1,\"goods_detail\":\"[{\\\"goods_id\\\":\\\"apple-01\\\",\\\"goods_name\\\":\\\"ipad\\\",\\\"quantity\\\":1,\\\"price\\\":200000,\\\"goods_id\\\":\\\"apple-01\\\",\\\"goods_category\\\":\\\"34543238\\\",\\\"real_price\\\":199999,\\\"body\\\":\\\"特价手机\\\",\\\"goods_fee_amount\\\":1},{\\\"goods_name\\\":\\\"ipad2\\\",\\\"quantity\\\":1,\\\"price\\\":200000,\\\"goods_id\\\":\\\"apple-02\\\",\\\"goods_category\\\":\\\"34543239\\\",\\\"real_price\\\":199999,\\\"body\\\":\\\"特价手机2\\\",\\\"goods_fee_amount\\\":1}]\",\"merchant_id\":\"1000000000826\",\"node_id\":\"100001\",\"order_amount\":199,\"order_id\":\"100010001\",\"order_time\":\"20240301131800\",\"org_order_id\":\"100010000\",\"pay_merchant_id\":\"1302329392\",\"pay_type\":\"502\",\"remark\":\"备注\",\"store_id\":\"20008221\",\"trade_no\":\"2019112011001004330000121536\",\"trade_type\":\"1\",\"user_id\":\"01\",\"split_rule_source\":\"1\"}",
"method": "bkfunds.order.upload",
"format": "json",
"sign": "bP6dfs2LgvpxhyeTS+VwfSp+26Pgi6VPLagYIGx5ENL5shQmXWBel56nxkDi22hoopKuqO3FbomxIuFMuMPDWuFzJCHLW2O9yTut+94Rx0f8ICikYVanMAhsaIIeMx0g9AdZzqP2IOou0xD7udmeXmCZqKw/h73+VzXM5aRtSPCeQI7zlKd2wyKmhvjdc9ujXZ5phNeZgdtjLm5tI2Xnq+XIh+6shnRS+4Q1LFo6ubgBsEBHpVo4dsJJSknj4q+9hc38nmpPUNLPIV154Z+WiZsAllXaHunrt5lsnixdrqr3VkkDwpfkH4JzZS0hIZi7CsfhePWgra1GfI/BbYRvwQ==",
"app_id": "202404221232028501746384896",
"sign_type": "RSA2",
"version": "1.0",
"timestamp": "2024-04-28 15:09:29"
}
公共响应参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
request_id | string(64) | 是 | 每次请求唯一id | 4e770f101c9a4191bfd4609d26c6e0bd |
code | string(8) | 是 | 返回码 | 40002 |
msg | string(1024) | 是 | 返回信息 | 非法的参数 |
sub_code | string(16) | 是 | 请求失败返回的子错误码 | isv.invalid-app-key |
sub_msg | string(1024) | 是 | 请求失败返回的子错误信息 | 无效的app_id参数 |
sign | string(512) | 是 | 响应参数的签名串 | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
业务响应参数
名称 | 类型 | 必须 | 描述 | 示例值 |
---|---|---|---|---|
code | string(8) | 否 | 响应码 | 10000 |
data | string(1024) | 否 | 交易数据 | 本接口返回空 |
msg | string(1024) | 否 | 错误描述 | success |
success | boolean | 否 | 是否成功 | true |
响应示例
{
"bkfunds_order_upload_response": {
"request_id": "4b8e7ca9cbcb448491df2f0120e49b9d",
"code": "10000",
"msg": "success",
"success": true,
"data": ""
},
"sign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
错误响应示例
{
"error_response": {
"request_id": "0d27836fcac345729176359388aeeb74",
"code": "40004",
"msg": "业务处理失败",
"sub_code": "isv.name-error",
"sub_msg": "姓名错误"
},
"sign": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}