npm 包 wx-pay 使用教程

微信支付是一项非常方便和安全的在线支付服务,许多企业和个人都采用微信支付来处理在线交易。npm 包 wx-pay 是一个非常轻量级的 Node.js 库,它提供了方便和快速的微信支付集成解决方案。本文将介绍 npm 包 wx-pay 的使用方法,包括安装和配置、API 说明、以及使用指南和示例代码等。

安装和配置

使用 npm install 命令可以快速安装 wx-pay 包,如下所示:

- --- ------- ------

安装完成后,需要配置微信支付相关的参数,包括商户 ID、商户密钥、回调地址等。可以在初始化 WxPayClient 对象时进行相关参数配置,示例代码如下:

----- ----- - ------------------

----- ----------- - -
  ------ --------------
  ------ -------------------
  ------- --------------------
  ---------- ------------------
  ---- ---------------------------------------------------
--

----- ----------- - --- -------------------

其中,各个参数的意义如下:

  • appId:微信支付分配的公众账号 ID 或应用 ID;
  • mchId:微信支付分配的商户号;
  • mchKey:商户密钥,用于生成签名和验证签名;
  • notifyUrl:支付结果通知的 URL 地址,需为 HTTPS 协议;
  • pfx:API 证书,用于双向证书认证。

API 说明

wx-pay 包提供了一系列便捷的方法,用于完成各种支付相关业务,包括统一下单、交易查询、退款等。下面是一些常用的 API 方法:

统一下单 API

使用 unifiedOrder 方法可以发起微信支付订单,实现流程如下:

  1. 用户在客户端生成订单信息;
  2. 客户端向服务器发送请求,请求生成微信支付订单;
  3. 服务器通过 unifiedOrder 方法发起微信统一下单请求;
  4. 微信支付系统生成预支付交易单,并返回支付凭证和相关信息;
  5. 客户端调用微信支付系统的 JSAPI 调起支付。

示例代码如下:

----- ------ - ----- --------------------------
  ----- ------
  ------------- ------
  ---------- ----
  ----------------- --------------
  ----------- ------------------
  ------- ------
---

--------------------

其中,各个参数的意义如下:

  • body:商品描述;
  • out_trade_no:商户订单号;
  • total_fee:订单金额,单位为分;
  • spbill_create_ip:终端 IP 地址;
  • notify_url:支付结果通知的 URL 地址;
  • openid:用户标识。

检查订单是否支付 API

使用 orderQuery 方法可以查询订单支付状态,示例代码如下:

----- ------ - ----- ------------------------
  ------------- ------
---

--------------------

其中,out_trade_no 为商户订单号。

关闭订单 API

使用 closeOrder 方法可以关闭未支付订单,示例代码如下:

----- ------ - ----- ------------------------
  ------------ ------
---

--------------------

其中,out_trade_no 为商户订单号。

申请退款 API

使用 refund 方法可以发起退款请求,实现流程如下:

  1. 用户在客户端发起退款申请;
  2. 客户端向服务器发送请求,请求发起退款;
  3. 服务器通过 refund 方法发起微信退款请求;
  4. 微信支付系统根据商户号和退款单号完成退款操作,返回退款结果。

示例代码如下:

----- ------ - ----- --------------------
  ------------- ------
  -------------- ------
  ---------- ----
  ----------- ----
---

--------------------

其中,各个参数的意义如下:

  • out_trade_no:商户订单号;
  • out_refund_no:商户退款单号;
  • total_fee:订单金额;
  • refund_fee:退款金额。

使用指南和示例代码

使用 npm 包 wx-pay 集成微信支付,需要在客户端和服务器端分别完成一些操作。以下是具体步骤和示例代码:

1. 在客户端(浏览器端)发起支付请求

在客户端,需要使用微信 JSAPI 调起支付,具体方法如下:

--------------------------------------------- -
  ------ --------------
  ---------- -----------------
  --------- -----------------
  -------- ---------------
  --------- ------
  -------- ----------------
-- ------------- -
  -- ------------ -- ----------------------------- -
    -- ----
  - ---- -
    -- ----
  -
---

其中,各个参数的意义如下:

  • appId:微信公众账号 ID 或应用 ID;
  • timeStamp:时间戳,作为请求和支付时间的标识;
  • nonceStr:随机字符串,作为请求和支付的安全标识;
  • package:支付凭证,由统一下单 API 返回;
  • signType:签名算法,通常为 MD5;
  • paySign:签名,由微信支付系统根据支付参数和商户密钥生成。

2. 在服务器端完成微信支付流程

在服务器端,需要根据客户端传递的订单信息,调用 npm 包 wx-pay 提供的 API 实现下单、查询、退款等操作。以下是一个完整的示例代码:

----- --- - ---------------
----- ------ - ------------------------
----- ------ - -------------------
----- ----- - ------------------

----- ----------- - -
  ------ --------------
  ------ -------------------
  ------- --------------------
  ---------- ------------------
  ---- ---------------------------------------------------
--

----- ----------- - --- -------------------

---------------------- ----- -------- ----- -
  ----- --------- - ----- ---------------------

  --- -
    ----- ------ - ----- --------------------------
      ----- ---------------
      ------------- -----------------------
      ---------- --------------------
      ----------------- ---------------------------
      ----------- ---------------------
      ------- -----------------
    ---
    
    ----- ------- - -
      ------ -------------
      ---------- -------------------- - -----------------------------
      --------- ----------------
      -------- ------------ - -----------------
      --------- ------
    --

    --------------- - -----------------------------

    -------- - --------
  - ----- ----- -
    -------- - -
      ------ ----
    -
  -
---

------------------------------ ----- -------- ----- -
  ----- --------- - ----- ---------------------

  --- -
    ----- ------ - ----- ------------------------
      ------------- -----------------------
    ---

    -------- - -------
  - ----- ----- -
    -------- - -
      ------ ----
    -
  -
---

----- --- - --- ------

-------------------------
---------------------------------

-----------------

在上述示例中,代码首先初始化了 npm 包 wx-pay 的客户端对象 wxPayClient,在 /wx/pay 路由处理函数中,使用了 unifiedOrder 方法发起了微信统一下单请求,最终返回了客户端进行支付操作所需要的参数;在 /wx/query_order 路由处理函数中,使用了 orderQuery 方法查询订单支付状态。

总结

npm 包 wx-pay 是一个非常实用的微信支付集成解决方案,它提供了简单、快捷、稳定的 API 接口,可以大大减少开发者的工作量和开发成本。通过学习和应用本文介绍的使用方法和示例代码,你可以轻松地集成微信支付功能,实现你的在线支付业务。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600671158dd3466f61ffe64b


猜你喜欢

  • GraphQL:用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言,它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据,避免了传统...

    12 天前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events? Server-sent Events(简称 SSE)是一种基于 HTTP 的服务器推送技术,它可以让服务器向客户端发送事件流,客户端通过监听这个事件流来...

    12 天前
  • ECMAScript 2020(ES11)中的新特性:BigInt 转换

    在 ECMAScript 2020(ES11)中,新增了一种数据类型:BigInt。它是一种可以表示任意大整数的数据类型,可以用来解决 JavaScript 中整数运算的精度问题。

    12 天前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式,消除不同浏览器之间的差异,从而实现更加一致的样式效果的技术手段。在前端开发中,使用 CSS Reset 可以让我们更...

    12 天前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中,引入了 class 关键字,使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间,有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系,并提供一...

    12 天前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时,表单数据的处理是非常常见的需求。然而,由于 React 的单向数据流和组件化特性,传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具,可以帮助...

    12 天前
  • Redis 处理高并发的策略

    前言 随着互联网的发展,高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库,也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略,并且会提...

    12 天前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中,图片适配是一个比较棘手的问题。如果不加以处理,可能会导致图片在不同设备上显示不佳,影响用户体验。本文将介绍响应式设计中的图片适配问题,并提供解决方案。

    12 天前
  • 解析 TypeScript 中 encapsulation(封装)的实现方式

    解析 TypeScript 中 encapsulation(封装)的实现方式 在 TypeScript 中,封装(encapsulation)是一种重要的面向对象编程的特性。

    12 天前
  • PM2 崩溃处理:如何避免由于 PM2 进程奔溃导致应用崩溃?

    在前端开发中,我们经常使用 PM2 进行进程管理和部署。但是,当 PM2 进程崩溃时,应用也会跟着崩溃。如何避免这种情况的发生?本文将介绍 PM2 崩溃处理的方法和技巧,帮助您更好地管理和部署应用。

    12 天前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境,它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时,安全性是非常重要的。

    12 天前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准,其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法,分别是:扩展运算符、剩余运算符...

    12 天前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时,我们经常需要使用 Enzyme 来测试组件。然而,当我们测试涉及到动画的组件时,我们可能会遇到一些问题:动画无法渲染,导致测试失败。

    12 天前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展,单页应用(Single Page Application,SPA)已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面,提供了更快速、更流畅的用户体...

    12 天前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中,ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    12 天前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中,Promise.all 是一个非常常用的功能,它可以让我们在多个异步操作完成后再执行一些操作,这个功能在实际开发中非常实用。

    12 天前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中,经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具,它提供了一种方便的方式来操作 MongoDB ...

    12 天前
  • 在使用 lit-element 的时候,如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候,我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而,Shadow DOM 的封闭性也带来了一些挑战,其中之一就是变量传递问题。

    12 天前
  • Tailwind CSS 如何实现动态换肤?

    随着互联网的发展,越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验,还可以让用户在不同的环境下选择适合自己的主题,增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    12 天前
  • 如何在 Less 中使用字符串操作函数?

    在前端开发中,样式表是不可或缺的一部分。而 Less 是一种动态样式语言,它是 CSS 的一种扩展。在 Less 中,我们可以使用字符串操作函数来处理字符串,这些函数可以帮助我们更加方便地操作字符串,...

    12 天前

相关推荐

    暂无文章