# 发起支付

按项目类型选择下方示例。uni-app x 的环境准备见接入指南。

使用 vk-uni-pay 组件的优势

  • 1、自动请求云函数
  • 2、自动识别 H5、小程序、APP,抹平不同平台的代码差异
  • 3、H5 扫码支付自动获取二维码地址 vkPay.codeUrl,支持自动轮询获取支付状态
  • 4、可实时监听支付状态 vkPay.status 0:待支付 1:支付中 2:已支付
  • 5、支付成功的判断是直接查你数据库的订单状态是否已支付,安全可靠。

# 示例代码

# uni-app

以下为 uni-app Vue2 选项式写法。

# template

<vk-uni-pay
  ref="vkPay"
  :query-payment-action="vkPay.queryPaymentAction"
  :status.sync="vkPay.status"
  :code-url.sync="vkPay.codeUrl"
  :page-show="vkPay.pageShow"
  :polling="vkPay.polling"
></vk-uni-pay>
1
2
3
4
5
6
7
8

# data

export default {
  data() {
    return {
      vkPay: {
        /**
         * 查询支付状态的云函数配置
         * 如果是非路由框架,则action为字符串,值为云函数名称
         * 如果是路由框架,则按下方配置填写
         */
        queryPaymentAction: {
          name: 'vk-pay', // 云函数名称
          action: 'pay/queryPayment', // 路由模式下云函数地址
          actionKey: 'action', // 路由模式下云函数地址的识别key
          dataKey: 'data', // 路由模式下云函数请求参数的识别key
        },
        // PC支付的付款二维码地址 渲染二维码需要自己写,可以参考示例中的二维码组件 vk-uni-qrcode
        codeUrl: '',
        // 当前支付状态 0:等待发起支付 1:支付中 2:已支付
        status: 0,
        // 当前页面是否显示
        pageShow: true,
        // 启用轮询检测订单支付状态(仅h5支付有效)
        polling: true,
      },
      // 表单请求数据
      form1: {
        provider: 'wxpay',
        total_fee: 1,
        out_trade_no: '',
        subject: '测试订单标题',
        body: '测试订单详情',
        type: 'recharge',
      },
    };
  },
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# methods

如需自行管理加载提示,可在 createPayment 的顶层参数中设置 loading: false 或 title: '',与 action、data 同级。loading 默认为 true;title 可自定义本次支付及后续查询的加载提示文字,省略时保留各阶段原有文案。详见加载提示说明。


methods: {
  createPayment(){
    const { form1 } = this;
    form1.out_trade_no = 'test_' + Date.now();
    this.$refs.vkPay.createPayment({
      loading: true, // 默认true,设为false可关闭本次支付的加载提示
      // 如果是非路由框架,则action为字符串,值为云函数名称
      // 如果是路由框架,则按下方配置填写
      action: {
        name: "vk-pay", // 云函数名称
        action: "pay/createPayment", // 路由模式下云函数地址
        actionKey: "action", // 路由模式下云函数地址的识别key(注意VK路由框架下,此值为$url)
        dataKey: "data" // 路由模式下云函数请求参数的识别key
      },
      // 请求数据
      data: {
        provider: form1.provider,
        total_fee: form1.total_fee,
        out_trade_no: form1.out_trade_no,
        subject: form1.subject,
        body: form1.body,
        type: form1.type
      },
      // 成功回调
      success: res => {
        this.toast("支付成功", "success");
        console.log("paySuccess", res);
      },
      // 失败回调
      fail: res => {
        if (res.failType === "create") {
          // 创建支付失败时提示
          this.alert(res.msg);
        } else if (res.failType === "request") {
          // 请求支付失败时提示
          this.toast("请求支付失败");
        } else if (res.failType === "result") {
          // 支付结果失败时提示
          this.toast("支付失败");
        }
      },
      // 取消回调
      cancel: res => {
        this.toast("用户取消支付");
      }
    });
  },
  // uni.showToast的简易封装
  toast(title, icon = "none", mask = false) {
  	uni.showToast({
  		title,
  		icon,
  		mask,
  		duration: 1500
  	});
  },
  // uni.showModal的简易封装
  alert(content, title = "提示") {
  	uni.showModal({
  		title,
  		content,
  		showCancel: false
  	});
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# Vue3 setup 内写法

由于 setup 内没有 this,故写法稍微变一下,代码如下:

import { ref } from 'vue';

const vkPay = ref(null); // 这里的 vkPay 变量名必须和组件写的ref的值一致

// this.$refs.vkPay.createPayment 改成 vkPay.value.createPayment
vkPay.value.createPayment({
  // 参数
});
1
2
3
4
5
6
7
8

# uni-app x 蒸汽模式

保存为 .uvue 页面并注册到 pages.json。下面示例包含 App 原生支付、小程序支付、PC 二维码和查单;公众号授权与手机 H5 返回流程请看统一支付组件的完整示例。

<template>
  <view class="pay-page">
    <button :disabled="busy" @click="createPayment()">支付 0.01 元</button>
    <button :disabled="busy || !outTradeNo" @click="queryPayment">我已支付,查询结果</button>
    <text>{{ message }}</text>
    <vk-uni-pay
      ref="payRef"
      v-model:status="vkPay.status"
      v-model:codeUrl="vkPay.codeUrl"
      v-model:qrcodeImage="vkPay.qrcodeImage"
      :query-payment-action="queryAction"
      :page-show="vkPay.pageShow"
      :polling="true"
    />
    <vk-uni-pay-qrcode-popup
      :status="vkPay.status"
      :code-url="vkPay.codeUrl"
      :qrcode-image="vkPay.qrcodeImage"
      :out-trade-no="outTradeNo"
      :total-fee="1"
      :provider="provider"
      @close="cancelPay"
      @query="queryPayment"
      @afresh="createPayment(true)"
    />
  </view>
</template>

<script setup lang="ts">
  const payRef = ref(null);
  const provider = ref('wxpay'); // 微信:wxpay;支付宝:alipay
  // #ifdef MP-ALIPAY
  provider.value = 'alipay';
  // #endif
  const outTradeNo = ref('');
  const message = ref('等待支付');
  const busy = ref(false);
  const vkPay = reactive({ status: 0, codeUrl: '', qrcodeImage: '', pageShow: true });
  const queryAction = { name: 'vk-pay', action: 'pay/queryPayment', actionKey: 'action', dataKey: 'data' };
  let alive = true;
  onShow(() => {
    vkPay.pageShow = true;
  });
  onHide(() => {
    vkPay.pageShow = false;
  });
  onUnload(() => {
    alive = false;
    vkPay.pageShow = false;
  });

  function showError(error) {
    if (alive) message.value = error.msg || error.errMsg || error.message || '请求失败';
  }
  async function createPayment(reuseOrder = false) {
    if (!alive || !payRef.value || busy.value) return;
    busy.value = true;
    // 示例本地生成订单号;实际业务由云端确定订单号和金额。
    if (!reuseOrder || !outTradeNo.value) outTradeNo.value = 'test_' + Date.now();
    try {
      if (reuseOrder) {
        vkPay.status = 0;
        await nextTick(); // 先结束上次轮询,再使用原订单重新支付
      }
      await payRef.value.createPayment({
        action: { name: 'vk-pay', action: 'pay/createPayment', actionKey: 'action', dataKey: 'data' },
        data: {
          provider: provider.value,
          total_fee: 1,
          out_trade_no: outTradeNo.value,
          subject: '测试订单',
          type: 'recharge',
        },
        create: (res) => {
          if (!alive) return;
          outTradeNo.value = res.out_trade_no || outTradeNo.value;
          message.value = '订单已创建,请完成支付';
        },
        success: () => {
          if (alive) message.value = '支付成功';
        },
        fail: showError,
        cancel: () => {
          if (alive) message.value = '用户取消支付';
        },
      });
    } catch (error) {
      showError(error);
    } finally {
      busy.value = false;
    }
  }
  async function queryPayment() {
    if (!alive || !payRef.value || busy.value || !outTradeNo.value) return;
    busy.value = true;
    try {
      await payRef.value.queryPayment({
        data: { out_trade_no: outTradeNo.value },
        needAlert: false,
        success: () => {
          if (!alive) return;
          vkPay.status = 2; // 手动查单成功后,更新页面状态并关闭二维码弹窗
          message.value = '支付成功';
        },
        fail: showError,
      });
    } catch (error) {
      showError(error);
    } finally {
      busy.value = false;
    }
  }
  function cancelPay() {
    if (vkPay.status === 2) return;
    vkPay.status = 0;
    vkPay.codeUrl = '';
    vkPay.qrcodeImage = '';
    message.value = '已关闭展示,可继续查询该订单';
  }
</script>

<style scoped>
  .pay-page {
    padding: 16px;
  }
</style>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

create 表示订单创建成功,await createPayment() 不代表付款完成;以 success 或云端查单结果为准。