商户接入服务

对外提供开发支付服务功能

公共分类

地址

基本信息

Path： /openpayapi/path

Method： GET

接口描述：

测试地址：
http://run.buybal.com/openpayapi
生产地址：上线前提供
测试参数
通用测试系统标识 1，商户id 95116323
金燕测试系统标识 1900012，商户id AA1905050000819，机构号id： 1600299999
注意：需要提供测试ip和生产ip配置ip白名单

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

签名

基本信息

Path： /openpayapi/sign

Method： GET

接口描述：

请求报文根据ASCII 排序并组装签名明文串

md5加盐算法计算签名
demo~~~~


请求原文：{merchantId=900001-95116503, outTradeNo=dm1561626196, refundCode=1, amount=1, sign=6b8abf117c662e7328d7db990a14a676}
md5盐值：111111
加密原串：amount=1&merchantId=900001-95116503&outTradeNo=dm1561626196&refundCode=1&key=111111
计算签名值：
6b8abf117c662e7328d7db990a14a676

请求参数

返回码

基本信息

Path： /openpayapi/code

Method： GET

接口描述：

resultCode	resultMsg
SUCCESS	成功
USERPAYING	处理中
FAILD	失败
REFUNDED	已退款
REFUNDING	退款中
PORTIONREFUNDED	部分退款

请求参数

错误码

基本信息

Path： /openpayapi/errorCode

Method： GET

接口描述：

returnCode	returnMsg
SUCCESS	成功
0001	请求失败
0002	商户信息不存在;
0003	机构信息错误;
0004	请求必传参数为空;
0005	验签失败;

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

交易接口

主扫支付

基本信息

Path： /openpayapi/openNativePay.do

Method： POST

接口描述：

请求报文：
POST http://run.buybal.com/openpayapi/openNativePay.do

POST data:
{
"deviceId":"",
"merchantId":"95116323",
"totalFee":"1",
"outOrderNo":"0000000001test1591070197421",
"sign":"buybal",
"channel":"ali_barcode_pay",
"clientId":"1",
"platCode":"90001",
"orgId":"1",
"mchntName":"商户名",
"subject":"订单主题",
"bodyDesc":"订单描述",
"notifyUrl":"www.baidu.com"
}~~~~
响应参数
{"returnCode":"SUCCESS","returnMsg":"成功","data":{"codeUrl":"http://test.buybal.com/buybal-api/v1.0/cashier/fakeNative/7D8B90697B29454B92D4A8CD5C4F7A84?sign=4408D1CA3B10A1E106A858C47B4B2DE7","orderNo":"7956071838254432256","bankOrderNo":"2020060200099990100200013124","outOrderNo":"0000000001test1591085559779"},"resultCode":"SUCCESS","sign":"5d0aacf9dca2de926775406f64e9c539","resultMsg":"成功"}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
deviceId	string	非必须	设备号长度不能超过24位
merchantId	string	必须	商户id
totalFee	string	必须	金额
outOrderNo	string	必须	外部订单号
sign	string	必须	签名
channel	string	必须	支付方式交易类型wx_barcode_pay 微信，ali_barcode_pay 支付宝，jd_barcode_pay 京东，qq_barcode_pay 腾讯、yl_barcode_pay 银联
orgId	string	非必须	机构id，金燕商户必填
mchntName	string	必须	商户名称
subject	string	非必须	订单标题，金燕商户必填
bodyDesc	string	非必须	订单备注
notifyUrl	string	必须	后台通知地址

返回数据

名称	类型	是否必须	备注
returnCode	string	非必须	系统返回码
returnMsg	string	非必须	系统返回信息
sign	string	非必须	签名
resultMsg	string	非必须	银行返回码
resultCode	string	非必须	银行返回码
data	object	非必须
├─ orderNo	string	非必须	交易订单号
├─ outOrderNo	string	非必须	外部订单号
├─ bankOrderNo	string	非必须	银行订单号
├─ bankCertificateNo	string	非必须	退款凭证号
├─ codeUrl	string	非必须	二维码信息

定额聚合支付

基本信息

Path： /openpayapi/openQrcodePay.do

Method： POST

接口描述：

请求报文：
POST http://run.buybal.com/openpayapi/openQrcodePay.do

POST data:
{
"timeExpire": "2020-09-01 10:21:12",
"clientId": "1",
"callBackUrl": "https://www.baidu.com/",
"merchantId": "95116323",
"totalFee": "1",
"subject": "下单测试",
"sign": "280d2255101b1a16126a554d391c8560",
"notifyUrl": "http://localhost:8089/notify",
"outOrderNo": "O2020090109211259593086",
"orgId": "1600299999",
"mchntName": "测试商户"
}
响应参数
{
"returnCode": "SUCCESS",
"returnMsg": "成功",
"data": {
"orderNo": "O2020090109211259593086",
"qrCode": "http://run.buybal.com/openpayapi/v1.0/cashier/showOrder/95116323/O2020090109211259593086?sign=98de3f60c0a989564b0997ccbfb3c11d",
"outOrderNo": "O2020090109211259593086"
},
"resultCode": "SUCCESS",
"sign": "c4c1c8eb1c2122a63ef955fa1f38f92f",
"resultMsg": "成功"
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
deviceId	string	非必须	设备号长度不能超过24位
merchantId	string	必须	商户id
totalFee	string	必须	金额单位:分
outOrderNo	string	必须	外部订单号
sign	string	必须	签名
orgId	string	非必须	机构id，金燕商户必填
mchntName	string	必须	商户名称
subject	string	非必须	订单标题，金燕商户必填
bodyDesc	string	非必须	订单备注
notifyUrl	string	必须	后台通知地址
callBackUrl	string	必须	前台通知地址
timeExpire	string	必须	订单失效时间 yyyy-MM-dd HH:mm:ss
shopId	string	非必须	门店Id

返回数据

名称	类型	是否必须	备注
returnCode	string	非必须	系统返回码
returnMsg	string	非必须	系统返回信息
sign	string	非必须	签名
resultMsg	string	非必须	银行返回码
resultCode	string	非必须	银行返回码
data	object	非必须
├─ orderNo	string	非必须	交易订单号
├─ outOrderNo	string	非必须	外部订单号
├─ qrCode	string	非必须	当前预下单请求生成的二维码码串，可以用二维码生成工具根据该码串值生成对应的二维码

异步交易通知

基本信息

Path： /openpayapi/notify

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
outOrderNo	string	必须	外部订单号
orderNo	string	必须	交易订单号
amount	string	必须	交易金额
timePaid	string	必须	支付时间
resultCode	string	必须	返回码
resultMsg	string	必须	返回信息
sign	string	必须	签名
deviceId	string	非必须	设备

返回数据

名称	类型	是否必须	默认值	备注	其他信息
returnCode	string	必须		返回码，success成功其他失败
returnMsg	string	必须		返回信息

微信小程序下单

基本信息

Path： /openpayapi/wxsmallPay.do

Method： POST

接口描述：

请求报文：
POST http://run.buybal.com/openpayapi/wxsmallPay.do

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
deviceId	string	非必须	设备号长度不能超过24位
merchantId	string	必须	商户id
totalFee	string	必须	金额
outOrderNo	string	必须	外部订单号
sign	string	必须	签名
channel	string	必须	支付方式交易类型wx_barcode_pay 微信
orgId	string	非必须	机构id，金燕商户必填
mchntName	string	必须	商户名称
subject	string	必须	订单标题
bodyDesc	string	非必须	订单备注
notifyUrl	string	必须	异步通知地址
callBackUrl	string	非必须	前台通知地址
wAppId	string	必须	小程序APPID
wOpenId	string	必须	小程序获取到用户的openId

返回数据

名称	类型	是否必须	备注
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
sign	string	必须	签名
resultMsg	string	非必须	银行返回信息
totalFee	string	非必须	金额
outOrderNo	string	非必须	外部订单号
bankOrderNo	string	非必须	银行订单号
resultCode	string	非必须	银行返回码
data	object	必须	小程序支付要素
├─ timeStamp	string	必须	时间戳
├─ nonceStr	string	必须	随机字符串
├─ package	string	必须	下单接口返回的 prepay_id 参数值，提交格式如：prepay_id=*
├─ signType	string	必须	签名类型，默认为MD5，支持HMAC-SHA256和MD5
├─ paySign	string	必须	签名,具体签名方案参见微信公众号支付帮助文档
├─ appId	string	必须	小程序ID

被扫支付

基本信息

Path： /openpayapi/openMicroPay.do

Method： POST

接口描述：

请求报文
POST http://192.168.1.201:8302/openpayapi/openMicroPay.do

POST data:
{
"authCode":"135151983121655214",
"deviceId":"",
"merchantId":"95116323",
"totalFee":"1",
"outOrderNo":"nxy_wx0000001wx1591070043160",
"sign":"buybal",
"channel":"wx_barcode_pay",
"mchntName":"商户名",
"clientId":"1",
"orgId":"1",
"subject":"订单主题",
"bodyDesc":"订单描述",
"notifyUrl":"www.baidu.com"
}
响应报文
{"returnCode":"SUCCESS","returnMsg":"成功","orderNo":"7956006757588074496","totalFee":"1","resultCode":"SUCCESS","bankOrderNo":"2020060200099990100300013099","channel":"wx_barcode_pay","sign":"a518e3f94e49d3d8ddb5f7922a230da9","outOrderNo":"nxy_wx0000001wx1591070043160","resultMsg":"成功"}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
authCode	string	必须	授权码
merchantId	string	必须	商户id
totalFee	string	必须	金额单位分
outOrderNo	string	必须	外部订单号
sign	string	必须	签名
channel	string	必须	支付方式交易类型wx_barcode_pay 微信，ali_barcode_pay 支付宝，jd_barcode_pay 京东，qq_barcode_pay 腾讯、yl_barcode_pay 银联
mchntName	string	必须	商户名称
orgId	string	非必须	机构号，金燕e付必填
subject	string	非必须	订单标题，金燕e付必填
bodyDesc	string	非必须	订单备注
notifyUrl	string	必须	后台通知地址

返回数据

名称	类型	是否必须	备注
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
sign	string	非必须	签名
resultMsg	string	非必须	银行返回信息
orderNo	string	非必须	交易订单号
totalFee	string	非必须	交易金额
outOrderNo	string	非必须	外部订单号
channel	string	非必须	支付方式
bankOrderNo	string	非必须	微信支付宝订单号
resultCode	string	非必须	银行返回码

订单查询

基本信息

Path： /openpayapi/openQuery.do

Method： POST

接口描述：

请求报文：
POST data:
{
"clientId":"1",
"merchantId":"95116323",
"outOrderNo":"nxy_wx0000001wx1591086024212",
"bankOrderNo":"2020060200099990100200013087",
"sign":"buybal"
}
响应报文：
{"returnCode":"SUCCESS","returnMsg":"成功","timePaid":"2020-06-02 16:20:19","totalFee":"1","resultCode":"SUCCESS","bankOrderNo":"2020060200099990100300013126","channel":"wx_barcode_pay","sign":"5a1e9a17768062a4e061e913cfca24f4","outOrderNo":"nxy_wx0000001wx1591086024212","resultMsg":"成功"}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
merchantId	string	必须	商户id
outOrderNo	string	非必须	外部订单号，银行订单号不存在必填
bankOrderNo	string	非必须	银行订单号，外部订单号不存在必填
sign	string	必须	签名

返回数据

名称	类型	是否必须	备注
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
sign	string	必须	签名
channel	string	非必须	支付方式交易类型wx_barcode_pay 微信，ali_barcode_pay 支付宝，jd_barcode_pay 京东，qq_barcode_pay 腾讯、yl_barcode_pay 银联
resultMsg	string	非必须	银行返回信息
totalFee	string	非必须	金额
outOrderNo	string	非必须	外部订单号
bankOrderNo	string	非必须	银行订单号
timePaid	string	非必须	支付成功时间
resultCode	string	非必须	银行返回码

退款

基本信息

Path： /openpayapi/openRefund.do

Method： POST

接口描述：

请求报文
POST data:
{
"clientId":"1",
"sign":"buybal",
"merchantId":"95116323",
"outOrderNo":"nxy_zfb0000001wx1591062011022",
"refundNo":"0000001wx1591062737191",
"refundCode":"1",
"amount":"1"
}

返回报文
{"returnCode":"SUCCESS","returnMsg":"成功","refundNo":"0000001wx1591062737191","resultCode":"SUCCESS","sign":"fc937d9c0d8c92b8615f1beff9adfc60","outOrderNo":"nxy_zfb0000001wx1591062011022","resultMsg":"成功"}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识
sign	string	必须	签名
merchantId	string	必须	商户id
outOrderNo	string	必须	原外部订单号
refundNo	string	必须	外部退款订单号 16-32位数字或字母
refundCode	string	必须	功能码 1退款
amount	string	非必须	退款金额

返回数据

名称	类型	是否必须	备注
resultMsg	string	非必须	银行返回信息
sign	string	必须	签名
resultCode	string	非必须	银行返回码
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
outOrderNo	string	非必须	原外部订单号
refundNo	string	非必须	外部退款订单号
bankRefundId	string	非必须	银行退款订单号

退款查询

基本信息

Path： /openpayapi/openRefundQuery.do

Method： POST

接口描述：

请求报文
POST data:
{
"sign":"buybal",
"clientId":"1",
"merchantId":"95116323",
"refundNo":"0000001wx1591062737191"
}
返回报文~~~~
{"returnCode":"SUCCESS","returnMsg":"成功","refundNo":"7955976116737343488","resultCode":"SUCCESS","sign":"fc369e171b627c0ee2c6743e3ce7902e","outOrderNo":"nxy_zfb0000001wx1591062011022","resultMsg":"成功","refundAmt":1}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
sign	string	必须	签名
clientId	string	必须	系统标识
merchantId	string	非必须	商户id
refundNo	string	非必须	退款订单号，银行退款订单号不存在必填

返回数据

名称	类型	是否必须	备注
resultMsg	string	非必须	银行返回信息
sign	string	必须	签名
resultCode	string	非必须	银行返回码
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
refundNo	string	非必须	退款订单号
outOrderNo	string	非必须	原外部订单号
refundAmt	number	非必须	退款金额
bankRefundId	string	非必须	银行退款订单号

预下单支付

基本信息

Path： /openpayapi/v1.0/cashier/JsPay

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是

Body

参数名称	参数类型	是否必须	备注
clientId	text	是	系统标识
merchantId	text	是	商户id
mchntName	text	是	商户名称
deviceId	text	否	设备号id 长度不能超过24位
totalFee	text	是	金额，单位分
outOrderNo	text	是	外部订单号
subject	text	否	订单主题，金燕商户必填
bodyDesc	text	否	订单描述
orgId	text	否	机构id，金燕商户必填
notifyUrl	text	是	后台通知地址
callBackUrl	text	是	前台通知地址
sign	text	是	签名

返回数据

名称	类型	是否必须	默认值	备注	其他信息

商户对账接口

查询商户对账信息

基本信息

Path： /openpayapi/mchnt/v1.0/checkDate

Method： POST

接口描述：

D+1
第二天04:00后获取前一天商户交易和退款信息
只包含交易成功和退款成功的记录
对账单接口只能下载一个月以内的账单。
文件形式
隔日退在发起退款时间对账单中

对账文件格式说明:
文件格式为csv
涉及金额的字段单位为“分”
交易类型 01-交易 02-退款
从第一行起，为数据记录，各参数以逗号分隔，字段顺序定义如下:

交易类型[01],订单号,订单日期,支付方式,机构号,外部订单号,商户号,订单金额,订单状态,支付时间,银行订单号
交易类型[02],退款订单号,外部退款单号,退款状态,退款金额,退款日期,订单号,订单日期,支付方式,机构号,外部订单号,商户号,订单金额,订单状态,支付时间,银行订单号

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注
clientId	string	必须	系统标识，11位，校验
merchantId	string	必须	商户id，校验
sign	string	必须	签名
checkDate	string	必须	对账日期（交易发生日期)YYYYMMDD

返回数据

名称	类型	是否必须	备注
returnCode	string	必须	系统返回码
returnMsg	string	必须	系统返回信息
resultMsg	string	必须	银行返回信息
resultCode	string	必须	银行返回码
downloadUrl	string	必须	账单下载地址 resultCode为SUCCESS时返回

YAPI 接口文档

商户接入服务

公共分类

地址

基本信息

请求参数

返回数据

签名

基本信息

请求参数

返回码

基本信息

请求参数

错误码

基本信息

请求参数

返回数据

交易接口

主扫支付

基本信息

请求参数

返回数据

定额聚合支付

基本信息

请求参数

返回数据

异步交易通知

基本信息

请求参数

返回数据

微信小程序下单

基本信息

请求参数

返回数据

被扫支付

基本信息

请求参数

返回数据

订单查询

基本信息

请求参数

返回数据

退款

基本信息

请求参数

返回数据

退款查询

基本信息

请求参数

返回数据

预下单支付

基本信息

请求参数

返回数据

商户对账接口

查询商户对账信息

基本信息

请求参数

返回数据