node tenpay
1.0.0
通知类中间件- 決済結果通知、返金結果通知前端支付支持- JSAPI、WeixinJSBridge、ミニ プログラム、APP、H5 をサポート支付模式支持- 支払いコード/公式アカウント/ミニプログラム/APP/H5/スキャンコード支払い支付工具支持- WeChat 紅封筒、法人支払い (小銭と銀行カードでの支払いをサポート)营销功能支持- WeChatバウチャー对帐账单支持- WeChat 明細書および WeChat 資金請求書をサポートします。服务商模式支持- すべての API を sub_appid、sub_mch_id で渡すことができます微信支付仿真测试系统- サンドボックス モードをサポートし、支払い受け入れプロセスを完了するために使用されます。 QQ グループ: 157964097。使用上の質問、開発、コードの貢献については、グループに参加してください。
ノードjs >= 8.3.0
金額などの機密性の高い問題のため、API とミドルウェアはデータ フィールドの型変換を実行しませんでした。
微信返回值XML做JSON转换之后的字段均为字符串类型, 请自行转换后再进行数据运算
'1' + 0 = '10'微信支付中传入的金额单位为分API とミドルウェアは両方とも、次のようなすべてのエラーを処理し、エラーを通じて均一に返します。
网络类错误- ネットワークの中断、接続タイムアウトなど。微信返回值检验错误- WeChat戻り値が不正です（リクエストの偽造など、可能性は非常に低いです）业务逻辑错误- 注文が重複している、払い戻し金額が支払い金額より大きいなど。其它错误- 渡されるパラメータが渡されないなど。 エラーが発生しない場合、通常は JSON 形式でデータを返します
downloadBillおよびdownloadFundflowによってダウンロードされた請求書の戻り値は文字列リテラルですnpm i tenpay
# 如已安装旧版, 重新安装最新版
npm i tenpay@latest const tenpay = require ( 'tenpay' ) ;
const config = {
appid : '公众号ID' ,
mchid : '微信商户号' ,
partnerKey : '微信支付安全密钥' ,
pfx : require ( 'fs' ) . readFileSync ( '证书文件路径' ) ,
notify_url : '支付回调网址' ,
spbill_create_ip : 'IP地址'
} ;
// 方式一
const api = new tenpay ( config ) ;
// 方式二
const api = tenpay . init ( config ) ;
// 调试模式(传入第二个参数为true, 可在控制台输出数据)
const api = new tenpay ( config , true ) ;
// 沙盒模式(用于微信支付验收)
const sandboxAPI = await tenpay . sandbox ( config ) ; appid - 公式アカウント ID (必須)mchid - WeChat 販売者番号 (必須)partnerKey - WeChat 支払いセキュリティ キー (必須、WeChat 販売者管理インターフェイスから取得)pfx - 証明書ファイル (オプション、WeChat マーチャント管理インターフェイスから取得)notify_url - 支払い結果通知コールバック アドレス (オプション)refund_url - 払い戻し結果通知コールバック アドレス (オプション)spbill_create_ip - IP アドレス (オプション)127.0.0.1pay<支付结果通知, 默认> refund<退款结果通知> nativePay<扫码支付模式一回调> app . use ( bodyParser . text ( { type : '*/xml' } ) ) ;
// 支付结果通知/退款结果通知
router . post ( '/xxx' , api . middlewareForExpress ( 'pay' ) , ( req , res ) => {
let info = req . weixin ;
// 业务逻辑...
// 回复消息(参数为空回复成功, 传值则为错误消息)
res . reply ( '错误消息' || '' ) ;
} ) ;
// 扫码支付模式一回调
router . post ( '/xxx' , api . middlewareForExpress ( 'nativePay' ) , ( req , res ) => {
let info = req . weixin ;
// 业务逻辑和统一下单获取prepay_id...
// 响应成功或失败(第二个可选参数为输出错误信息)
res . replyNative ( prepay_id , err_msg ) ;
} ) ; 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 ;
// 业务逻辑...
// 回复消息(参数为空回复成功, 传值则为错误消息)
ctx . reply ( '错误消息' || '' ) ;
// 扫码支付模式一模式
ctx . replyNative ( prepay_id ) ;
} ) ; appid mchidなど、初期化中に渡されたパラメータは、呼び出し時に再度渡す必要はありません。 let result = await api . getPayParams ( {
out_trade_no : '商户内部订单号' ,
body : '商品简单描述' ,
total_fee : '订单金额(分)' ,
openid : '付款用户的openid'
} ) ; trade_type - JSAPI // 该方法需先调用api.unifiedOrder统一下单, 获取prepay_id;
let result = await api . getPayParamsByPrepay ( {
prepay_id : '预支付会话标识'
} ) ; let result = await api . getAppParams ( {
out_trade_no : '商户内部订单号' ,
body : '商品简单描述' ,
total_fee : '订单金额(分)'
} ) ; trade_type -APP // 该方法需先调用api.unifiedOrder统一下单<注意传入trade_type: 'APP'>, 获取prepay_id;
let result = await api . getAppParamsByPrepay ( {
prepay_id : '预支付会话标识'
} ) ; let result = await api . getNativeUrl ( {
product_id : '商品ID'
} ) ; // 使用统一下单API可直接获取code_url, 需自行生成二维码图片
let { prepay_id , code_url } = await api . unifiedOrder ( {
out_trade_no : '商户内部订单号' ,
body : '商品简单描述' ,
total_fee : '订单金额(分)' ,
openid : '用户openid' ,
trade_type : 'NATIVE' ,
product_id : '商品id'
} ) ; let result = await api . micropay ( {
out_trade_no : '商户内部订单号' ,
body : '商品简单描述' ,
total_fee : '订单金额(分)' ,
auth_code : '授权码'
} ) ; let result = await api . unifiedOrder ( {
out_trade_no : '商户内部订单号' ,
body : '商品简单描述' ,
total_fee : '订单金额(分)' ,
openid : '用户openid'
} ) ; trade_type - JSAPInotify_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 : '订单金额(分)' ,
refund_fee : '退款金额(分)'
} ) ; op_user_id - デフォルトは販売者番号です (このフィールドはミニ プログラムの支払い文書に表示されます)notify_url - デフォルトは、初期化中に渡されるrefund_urlです。このパラメータを指定しないと、販売者のバックエンドで設定された返金通知アドレスが使用されます。 let result = await api . refundQuery ( {
// 以下参数 四选一
// transaction_id: '微信的订单号',
// out_trade_no: '商户内部订单号',
// out_refund_no: '商户内部退款单号',
refund_id : '微信退款单号'
} ) ; /**
* 新增一个format参数(默认: false), 用于自动转化帐单为json格式
* json.total_title: 统计数据的标题数组 - ["总交易单数","总交易额","总退款金额", ...],
* json.total_data: 统计数据的数组 - ["3", "88.00", "0.00", ...],
* json.list_title: 详细数据的标题数组 - ["交易时间","公众账号ID","商户号", ...],
* json.list_data: 详细数据的二维数据 - [["2017-12-26 19:20:39","wx12345", "12345", ...], ...]
*/
let result = await api . downloadBill ( {
bill_date : '账单日期'
} , true ) ; bill_type -ALLformat -false /**
* 新增一个format参数(默认: false), 用于自动转化帐单为json格式
* json.total_title: 统计数据的标题数组 - ["资金流水总笔数","收入笔数","收入金额", ...],
* json.total_data: 统计数据的数组 - ["20.0", "17.0", "0.35", ...],
* json.list_title: 详细数据的标题数组 - ["记账时间","微信支付业务单号","资金流水单号", ...],
* json.list_data: 详细数据的二维数据 - [["2018-02-01 04:21:23","12345", "12345", ...], ...]
*/
let result = await api . downloadFundflow ( {
bill_date : '账单日期'
} , true ) ; account_type - 基本format -false let result = await api . sendCoupon ( {
coupon_stock_id : '代金券批次id' ,
partner_trade_no : '商户单据号' ,
openid : '用户openid'
} ) ; let result = await api . queryCouponStock ( {
coupon_stock_id : '代金券批次id'
} ) ; let result = await api . queryCouponInfo ( {
coupon_id : '代金券id' ,
openid : '用户openid' ,
stock_id : '批次号'
} ) ; let result = await api . transfers ( {
partner_trade_no : '商户内部付款订单号' ,
openid : '用户openid' ,
re_user_name : '用户真实姓名' ,
amount : '付款金额(分)' ,
desc : '企业付款描述信息'
} ) ; check_name - FORCE_CHECKspbill_create_ip - デフォルトは初期化中に渡された値または127.0.0.1 let result = await api . transfersQuery ( {
partner_trade_no : '商户内部付款订单号'
} ) ; let result = await api . payBank ( {
partner_trade_no : '商户内部付款订单号' ,
bank_code : '收款方开户行' ,
enc_bank_no : '收款方银行卡号' ,
enc_true_name : '收款方用户名' ,
amount : '付款金额(分)' ,
desc : '企业付款到银行卡描述信息'
} ) ; let result = await api . queryBank ( {
partner_trade_no : '商户内部付款订单号'
} ) ; let result = await api . sendRedpack ( {
// mch_billno, mch_autono 二选一
// mch_billno: '商户内部付款订单号',
mch_autono : '10位当日唯一数字, 用于自动生成mch_billno' ,
send_name : '商户名称' ,
re_openid : '用户openid' ,
total_amount : '红包金额(分)' ,
wishing : '红包祝福语' ,
act_name : '活动名称' ,
remark : '备注信息'
} ) ; mch_billno - 販売者の内部注文番号 (渡された場合、mch_autono は無効になります)mch_autono - その日の一意の 10 桁の番号。販売者の内部注文番号ロジックを自動的に処理するために使用されます。total_num - 1client_ip - デフォルトは、初期化中の spbill_create_ip パラメータの値または127.0.0.1scene_id - 空、赤い封筒の金額が2元を超える場合に送信する必要があります (WeChat ドキュメントには 200 元と記載されていますが、実際の測定値は 2 元です) let result = await api . sendGroupRedpack ( {
// mch_billno, mch_autono 二选一
// mch_billno: '商户内部付款订单号',
mch_autono : '10位当日唯一数字, 用于自动生成mch_billno' ,
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_RANDscene_id - 空、赤い封筒の金額が2元を超える場合に渡す必要があります（文書に指定されていません） api . redpackQuery ( {
mch_billno : '商户内部付款订单号'
} ) ; bill_type -MCHT
