Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
- 支付结果通知 - 支持Express和Koa(仅支持node 8.3.0以上版本)
- 微信支付API - 支持使用await/async和promise/then方式调用
因涉及金额等敏感问题, API和中间件并没有对数据字段做类型转换
微信返回值XML做JSON转换之后的字段均为字符串类型, 请自行转换后再进行数据运算
- 重点: '1' + 0 = '10'
- 重点: 微信支付中传入的金额单位为分, 请注意查阅官方文档
API和中间件均对所有错误进行了处理, 统一通过error返回, 包括:
- 网络类错误 - 网络中断, 连接超时等
- 微信返回值检验错误 - 微信返回值非法(伪造请求等, 可能性非常低)
- 业务逻辑错误 - 订单重复, 退款金额大于支付金额等
- 其它错误 - 应传参数未传入等
未出错时正常返回为JSON格式数据
- 特殊情况: downloadBill 下载对帐单, 返回值为字符串文本
npm i tenpay
# 如已安装旧版, 重新安装最新版
npm i tenpay@latestconst tenpay = require('tenpay');
const config = {
appid: '公众号ID',
mchid: '微信商户号',
partnerKey: '微信支付安全密钥',
pfx: require('fs').readFileSync('证书文件路径'),
notify_url: '支付回调网址',
spbill_create_ip: 'IP地址'
}
const api = new tenpay(config);- appid - 公众号ID(必填)
- mchid - 微信商户号(必填)
- partnerKey - 微信支付安全密钥(必填, 在微信商户管理界面获取)
- pfx - 证书文件(选填, 在微信商户管理界面获取)
- 当不需要调用依赖证书的API时可不填此参数
- 若业务流程中使用了依赖证书的API则需要在初始化时传入此参数
- notify_url - 支付结果通知回调地址(选填)
- 可以在初始化的时候传入设为默认值, 不传则需在调用相关API时传入
- 调用相关API时传入新值则使用新值
- spbill_create_ip - IP地址(选填)
- 可以在初始化的时候传入设为默认值, 不传则默认值为127.0.0.1
- 调用相关API时传入新值则使用新值
- 如业务流程中用到含证书请求的API, 则必须在初始时传入pfx参数
- 如回调地址不需要按业务变化, 建议在初始化时传入统一的回调地址
- 如IP地址不需要按业务变化, 建议在初始化时传入统一的IP地址
- middleware参数: pay<支付结果通知, 默认>, refund<退款结果通知>
- 需自行添加bodyParser接收post data
- reply()会自动封装SUCCESS消息, reply('some error_msg')会自动封装FAIL消息
app.use(bodyParser.text({type: '*/xml'}));
router.post('/xxx', api.middlewareForExpress('pay'), (req, res) => {
let info = req.weixin;
// 回复SUCCESS
res.reply();
// 回复错误
res.reply('错误信息');
})app.use(bodyParser({
enableTypes: ['json', 'form', 'text'],
extendTypes: {
text: ['text/xml', 'application/xml']
}
}));
router.post('/xxx', api.middleware('refund'), async ctx => {
let info = ctx.request.weixin;
// 回复SUCCESS
ctx.reply();
// 回复错误
ctx.reply('错误信息');
})- 某些API预设了某些必传字段的默认值, 调用时不传参数则使用默认值
- 初始化时已传入的参数无需调用时重复传入, 如appid mchid
- 签名(sign)会在调用API时自动处理, 无需手动传入
- 随机字符串(nonce_str)会在调用API时自动处理, 无需手动传入
let result = await api.getPayParams({
out_trade_no: '商户内部订单号',
body: '商品简单描述',
total_fee: 100,
openid: '付款用户的openid'
});- trade_type - JSAPI
let result = await api.micropay({
out_trade_no: '商户内部订单号',
body: '商品简单描述',
total_fee: 100,
auth_code: '1234567890123'
});let result = await api.unifiedOrder({
out_trade_no: '商户内部订单号',
body: '商品简单描述',
total_fee: 100,
openid: '用户openid'
});- trade_type - JSAPI
- notify_url - 默认为初始化时传入的值或空
- spbill_create_ip - 默认为初始化时传入的值或127.0.0.1
let result = await api.orderQuery({
// transaction_id, out_trade_no 二选一
// transaction_id: '微信的订单号',
out_trade_no: '商户内部订单号'
});let result = await api.reverse({
// transaction_id, out_trade_no 二选一
// transaction_id: '微信的订单号',
out_trade_no: '商户内部订单号'
});let result = await api.closeOrder({
out_trade_no: '商户内部订单号'
});let result = await api.refund({
// transaction_id, out_trade_no 二选一
// transaction_id: '微信的订单号',
out_trade_no: '商户内部订单号',
out_refund_no: '商户内部退款单号',
total_fee: 100,
refund_fee: 100
});- op_user_id - 默认为商户号(此字段在小程序支付文档中出现)
let result = await api.refundQuery({
// 以下参数 四选一
// transaction_id: '微信的订单号',
// out_trade_no: '商户内部订单号',
// out_refund_no: '商户内部退款单号',
refund_id: '微信退款单号'
});/**
* 新增一个format参数(true/false), 用于自动转化帐单格式, 返回如下形式json:
* {
* total_title: 统计数据的标题数组["总交易单数","总交易额","总退款金额", ...],
* total_data: 统计数据的数组["3", "88.00", "0.00", ...],
* list_title: 详细数据的标题数组["交易时间","公众账号ID","商户号", ...],
* list_data: 详细数据的二维数据[["2017-12-26 19:20:39","wx12345", "12345", ...], ...]
* }
*/
let result = await api.downloadBill({
bill_date: '账单的日期'
}, true);- bill_type - ALL
- format - false
let result = await api.transfers({
partner_trade_no: '商户内部付款订单号',
openid: '用户openid',
re_user_name: '用户真实姓名',
amount: 100,
desc: '企业付款描述信息'
});- check_name - OPTION_CHECK
- spbill_create_ip - 默认为初始化时传入的值或127.0.0.1
let result = await api.transfersQuery({
partner_trade_no: '商户内部付款订单号'
});let result = await api.sendRedpack({
// mch_billno, mch_autono 二选一
// mch_billno: '商户内部付款订单号',
mch_autono: '10位当日唯一数字',
send_name: '商户名称',
re_openid: '用户openid',
total_amount: <付款金额(分)>,
wishing: '红包祝福语',
act_name: '活动名称',
remark: '备注信息'
});- mch_billno - 商户内部订单号(传入则mch_autono失效)
- mch_autono - 当日10位唯一数字, 用于自动处理商户内部订单号逻辑
- total_num - 1
- client_ip - 默认为初始化时的spbill_create_ip参数值或127.0.0.1
- scene_id - 空, 当红包金额大于200元时必传
let result = await api.sendGroupRedpack({
// mch_billno, mch_autono 二选一
// mch_billno: '商户内部付款订单号',
mch_autono: '10位当日唯一数字',
send_name: '商户名称',
re_openid: '种子用户openid',
total_amount: <付款金额(分)>,
wishing: '红包祝福语',
act_name: '活动名称',
remark: '备注信息'
});- mch_billno - 商户内部订单号(传入则mch_autono失效)
- mch_autono - 当日10位唯一数字, 用于自动处理商户内部订单号逻辑
- total_num - 3, 分裂红包要求值为3~20之间
- amt_type - ALL_RAND
- scene_id - 空, 当红包金额大于200元时必传(文档中未说明)
api.redpackQuery({
mch_billno: '商户内部付款订单号'
});- bill_type - MCHT