企业付款API文档
2024-09-07 20:48:19
bone
签名方法
- 获取所有post 请求内容,不包括字节类型参数,如文件、字节流,剔除 sign 字段,剔除值为空的参数;
- 按照第一个字符的键值 ASCII 码递增排序(字母升序排序),如果遇到相同字符则按照第二个字符的键值 ASCII 码递增排序,以此类推;
- 将排序后的参数与其对应值,组合成 参数=参数值 的格式,并且把这些参数用
&
字符连接起来,此时生成的字符串为待签名字符串。
必填参数说明
M = 必填
O = 非必填
C= 条件必填
公共请求参数
所有请求都必须添加公共参数。
变量名 | 必填 | 限制 | 类型 | 说明 |
mchid | M | - | String | 商户号 |
appid | O | - | String | 应用APPID |
method | M | - | String | 接口名称 |
charset | M | - | String | 编码格式,请求使用的编码格式,如utf-8,gbk,gb2312等 |
sign_type | M | - | String | 签名方法,目前仅支持RSA2 |
timestamp | M | - | String | 请求时间,请传入当前请求时间的时间戳 |
version | M | - | String | 版本号,调用的接口版本,固定为:1.0 |
biz_content | M | - | String | 业务参数集合,json格式,最大长度不限,除公共参数外所有业务参数都必须放在这个参数中传递 |
sign | M | - | String | 商户请求参数的签名串 |
请求地址
请联系平台方获取,地址后缀请添加/
请求地址拼接method
如使用交易下单接口:
如请求地址为:https://www.baidu.com
拼接后为:https://www.baidu.com/payment.order/create
接入接口条件
1,需要开启【付款API】开关,才能使用付款API接口
2,目前只支持银行卡付款类型bank,后续开放更多类型支持
3,目前只开放部分渠道付款,具体请与商务沟通
1、企业付款统一下单接口
1.1接口说明
支持微信收款,支付宝收款,银行卡收款。异步通知地址为预留字段,后期将会增加付款成功后同步通知到商户服务器
1.2请求方式
POST
1.3接口名称
method = payment.order/create
1.4业务参数
公共请求参数内的biz_content业务参数集合,json格式
变量名 | 必填 | 限制 | 类型 | 说明 |
channel_id | M | - | Number | 通道ID |
channel_code | O | - | String | 通道代码 |
trans_type | M | - | String | 付款渠道,微信=wxpay,支付宝=alipay,银行卡=bank |
out_trans_no | M | - | String | 付款商户订单号,由商家自定义,15-64个字符,仅支持字母、数字、下划线且需保证全局不重复(我司系统内唯一) |
trans_amount | M | - | String | 付款金额,单位为元,精确到小数点后两位,取值范围:[0.01,100000000] 。 |
payee_name | M | - | String | 收款方姓名 |
payee_number | M | - | String | 收款方账号,支付宝请填入支付宝账号,微信请传入微信唯一识别码(openid,请参考后续接口说明),银行请传入银行卡号 |
extends | O | - | String | 付款备注 |
bank_name | C | - | String | 收款方开户银行名称,银行卡收款时必传 |
sub_branch | O | - | String | 收款方开户支行名称,银行卡收款时选填 |
province | O | - | String | 银行卡开户省份,银行卡收款时选填 |
city | O | - | String | 银行卡开户市区,银行卡收款时选填 |
1.5返回参数
变量名 | 必填 | 限制 | 类型 | 说明 |
code | M | 无 | string | 返回状态码1 - 成功,非1 - 失败 |
msg | C | 无 | string | 返回错误信息 |
data | M | 无 | string | 业务返回参数,请查看下方具体参数 |
data参数表
变量名 | 必填 | 限制 | 类型 | 说明 |
mchid | M | 无 | string | 商户号 |
out_trans_no | M | 无 | string | 商户订单号 |
trans_no | M | 无 | string | 平台订单号 |
trans_amount | M | 无 | string | 付款金额 |
float_amount | M | 无 | string | 实际付款金额 |
order_status | C | 无 | string | 付款状态,WAIT_PAY=等待处理,SUCCESS=转账成功,DEALING=处理中,REFUND=付款失败,CLOSED=超时关闭 |
trans_type | M | 无 | string | 付款渠道 |
2、付款结果查询
2.1请求方式
POST
2.2接口名称
method = payment.order/query
2.3业务参数
公共请求参数内的biz_content业务参数集合,json格式
变量名 | 必填 | 限制 | 类型 | 说明 |
out_trans_no | C | - | String | 商户订单号,与平台订单号二选一 |
trans_no | C | - | String | 平台订单号,与商户订单号二选一 |
2.4返回参数
变量名 | 必填 | 限制 | 类型 | 说明 |
code | M | 无 | string | 返回状态码1 - 成功,非1 - 失败 |
msg | C | 无 | string | 返回错误信息 |
data | M | 无 | string | 业务返回参数,请查看下方具体参数 |
data参数表
变量名 | 必填 | 限制 | 类型 | 说明 |
mchid | M | 无 | string | 商户号 |
out_trans_no | M | 无 | string | 商户订单号 |
trans_no | M | 无 | string | 平台订单号 |
trans_type | M | 无 | string | 付款通道 |
trans_amount | M | 无 | string | 付款提交金额 |
float_amount | M | 无 | string | 实际付款金额 |
payee_name | M | 无 | string | 收款人姓名 |
payee_number | M | 无 | string | 收款人账号 |
extends | M | 无 | string | 付款备注 |
order_status | M | 无 | string | 付款状态,WAIT_PAY=等待处理,SUCCESS=转账成功,DEALING=处理中,REFUND=付款失败,CLOSED=超时关闭 |
platform_fee | M | 无 | string | 付款手续费 |
fail_reason | C | 无 | string | 付款失败原因 |