快速上手

更新时间：2023.08.17

# 目标

掌握如何安装 SDK
了解请求微信支付需要哪些密钥和证书
了解如何使用 SDK 请求微信支付

请选择一种编辑语言，按照快速上手的指引操作。

# 环境要求

Java 1.8+

# 安装

使用包管理系统，例如 Maven、Gradle，快速添加微信支付官方 SDK。

如果你使用的 Gradle (opens new window)，请在 build.gradle 中加入：

1implementation 'com.github.wechatpay-apiv3:wechatpay-java:${VERSION}'

如果你使用的 Maven (opens new window)，请在 pom.xml 中加入：

1<dependency>
2  <groupId>com.github.wechatpay-apiv3</groupId>
3  <artifactId>wechatpay-java</artifactId>
4  <version>${VERSION}</version>
5</dependency>

你可以在 GitHub 找到 Java SDK (opens new window) 的源代码、使用说明和最新版本信息。

# 必需的证书和密钥

运行 SDK 必需以下的证书和密钥：

# 发起请求

以 Native 支付为例，向微信支付发起你的第一个请求：

1package com.wechat.pay.java.service;
2
3import com.wechat.pay.java.core.Config;
4import com.wechat.pay.java.core.RSAAutoCertificateConfig;
5import com.wechat.pay.java.service.payments.nativepay.NativePayService;
6import com.wechat.pay.java.service.payments.nativepay.model.Amount;
7import com.wechat.pay.java.service.payments.nativepay.model.PrepayRequest;
8import com.wechat.pay.java.service.payments.nativepay.model.PrepayResponse;
9
10/** Native 支付下单为例 */
11public class QuickStart {
12
13    /** 商户号 */
14    public static String merchantId = "190000****";
15    /** 商户API私钥路径 */
16    public static String privateKeyPath = "/Users/yourname/your/path/apiclient_key.pem";
17    /** 商户证书序列号 */
18    public static String merchantSerialNumber = "5157F09EFDC096DE15EBE81A47057A72********";
19    /** 商户APIV3密钥 */
20    public static String apiV3key = "...";
21
22    public static void main(String[] args) {
23        // 使用自动更新平台证书的RSA配置
24        // 建议将 config 作为单例或全局静态对象，避免重复的下载浪费系统资源
25        Config config =
26                new RSAAutoCertificateConfig.Builder()
27                        .merchantId(merchantId)
28                        .privateKeyFromPath(privateKeyPath)
29                        .merchantSerialNumber(merchantSerialNumber)
30                        .apiV3Key(apiV3key)
31                        .build();
32        // 构建service
33        NativePayService service = new NativePayService.Builder().config(config).build();
34        // request.setXxx(val)设置所需参数，具体参数可见Request定义
35        PrepayRequest request = new PrepayRequest();
36        Amount amount = new Amount();
37        amount.setTotal(100);
38        request.setAmount(amount);
39        request.setAppid("wxa9d9651ae******");
40        request.setMchid("190000****");
41        request.setDescription("测试商品标题");
42        request.setNotifyUrl("https://notify_url");
43        request.setOutTradeNo("out_trade_no_001");
44        // 调用下单方法，得到应答
45        PrepayResponse response = service.prepay(request);
46        // 使用微信扫描 code_url 对应的二维码，即可体验Native支付
47        System.out.println(response.getCodeUrl());
48    }
49}

# 环境要求

Guzzle 7.0，PHP >= 7.2.5。
Guzzle 6.5，PHP >= 7.1.2

我们推荐使用目前处于 Active Support (opens new window) 阶段的 PHP 8 和 Guzzle 7。

# 安装

使用 Composer (opens new window) 安装最新版本的 SDK：

1composer require wechatpay/wechatpay

你可以在 GitHub 找到 PHP SDK (opens new window) 的源代码、使用说明和最新版本信息。

# 必需的证书和密钥

运行 SDK 必需以下的证书和密钥：

由于 PHP-FPM (opens new window) 进程模型限制，PHP SDK 不支持自动获取和更新微信支付平台证书。你可以使用 SDK 自带的工具 (opens new window)下载微信支付平台证书。

1composer exec CertificateDownloader.php -- -k ${apiV3key} -m ${mchId} -f ${mchPrivateKeyFilePath} -s ${mchSerialNo} -o ${outputFilePath}

# 发起请求

以 Native 支付为例，向微信支付发起你的第一个请求。

1<?php
2
3require_once('vendor/autoload.php');
4
5use WeChatPay\Builder;
6use WeChatPay\Crypto\Rsa;
7use WeChatPay\Util\PemUtil;
8
9// 设置参数
10
11// 商户号
12$merchantId = '190000****';
13
14// 从本地文件中加载「商户API私钥」，「商户API私钥」会用来生成请求的签名
15$merchantPrivateKeyFilePath = 'file:///path/to/merchant/apiclient_key.pem';
16$merchantPrivateKeyInstance = Rsa::from($merchantPrivateKeyFilePath, Rsa::KEY_TYPE_PRIVATE);
17
18// 「商户API证书」的「证书序列号」
19$merchantCertificateSerial = '3775B6A45ACD588826D15E583A95F5DD********';
20
21// 从本地文件中加载「微信支付平台证书」(可使用证书下载工具得到），用来验证微信支付应答的签名
22$platformCertificateFilePath = 'file:///path/to/wechatpay/cert.pem';
23$platformPublicKeyInstance = Rsa::from($platformCertificateFilePath, Rsa::KEY_TYPE_PUBLIC);
24
25// 从「微信支付平台证书」中获取「证书序列号」
26$platformCertificateSerial = PemUtil::parseCertificateSerialNo($platformCertificateFilePath);
27
28// 构造一个 APIv3 客户端实例
29$instance = Builder::factory([
30    'mchid'      => $merchantId,
31    'serial'     => $merchantCertificateSerial,
32    'privateKey' => $merchantPrivateKeyInstance,
33    'certs'      => [
34        $platformCertificateSerial => $platformPublicKeyInstance,
35    ],
36]);
37
38// 以 Native 支付为例，发送请求
39$resp = $instance
40    ->chain('v3/pay/transactions/native')
41    ->post(['json' => [
42        'mchid'        => '1900006XXX',
43        'out_trade_no' => 'native12177525012014070332333',
44        'appid'        => 'wxdace645e0bc2cXXX',
45        'description'  => 'Image形象店-深圳腾大-QQ公仔',
46        'notify_url'   => 'https://weixin.qq.com/',
47        'amount'       => [
48            'total'    => 1,
49            'currency' => 'CNY'
50        ],
51    ]]);
52echo $resp->getBody(), PHP_EOL;

# 环境要求

Go 1.16+

# 安装

使用 Go Modules (opens new window) 安装最新版本 SDK：

1go get github.com/wechatpay-apiv3/wechatpay-go

你可以在 GitHub 找到 Go SDK (opens new window) 的源代码、使用说明和最新版本信息。

# 必需的证书和密钥

运行 SDK 必需以下的证书和密钥：

# 发起请求

以 Native 支付为例，向微信支付发起你的第一个请求。

1package main
2
3import (
4    "context"
5    "log"
6
7    "github.com/wechatpay-apiv3/wechatpay-go/core"
8    "github.com/wechatpay-apiv3/wechatpay-go/core/option"
9    "github.com/wechatpay-apiv3/wechatpay-go/services/payments/native"
10    "github.com/wechatpay-apiv3/wechatpay-go/utils"
11)
12
13func main() {
14    var (
15        mchID string = "190000****" // 商户号
16        mchCertificateSerialNumber string = "3775B6A45ACD588826D15E583A95F5DD********" // 商户证书序列号
17        mchAPIv3Key string = "2ab9****************************" // 商户APIv3密钥
18    )
19
20    // 使用 utils 提供的函数从本地文件中加载商户私钥，商户私钥会用来生成请求的签名
21    mchPrivateKey, err: = utils.LoadPrivateKeyWithPath("/path/to/merchant/apiclient_key.pem")
22    if err != nil {
23        log.Fatal("load merchant private key error")
24    }
25
26    ctx: = context.Background()
27    // 使用商户私钥等初始化 client，并使它具有自动定时获取微信支付平台证书的能力
28    opts: = [] core.ClientOption {
29        option.WithWechatPayAutoAuthCipher(mchID, mchCertificateSerialNumber, mchPrivateKey, mchAPIv3Key),
30    }
31    client, err: = core.NewClient(ctx, opts...)
32    if err != nil {
33        log.Fatalf("new wechat pay client err:%s", err)
34    }
35
36    // 以 Native 支付为例
37    svc := native.NativeApiService{Client: client}
38    // 发送请求
39    resp, result, err: = svc.Prepay(ctx,
40        native.PrepayRequest {
41            Appid: core.String("wxd678efh567hg6787"),
42            Mchid: core.String("1900009191"),
43            Description: core.String("Image形象店-深圳腾大-QQ公仔"),
44            OutTradeNo: core.String("1217752501201407033233368018"),
45            Attach: core.String("自定义数据说明"),
46            NotifyUrl: core.String("https://www.weixin.qq.com/wxpay/pay.php"),
47            Amount: & native.Amount {
48                Total: core.Int64(100),
49            },
50        },
51    )
52    // 使用微信扫描 resp.code_url 对应的二维码，即可体验Native支付
53    log.Printf("status=%d resp=%s", result.Response.StatusCode, resp)
54}

文档是否有帮助

更多支持

开发者社区微信开放平台微信公众平台腾讯客服

快速上手

# 目标

# 环境要求

# 安装

# 必需的证书和密钥

# 发起请求

# 环境要求

# 安装

# 必需的证书和密钥

# 发起请求

# 环境要求

# 安装

# 必需的证书和密钥

# 发起请求

关于我们

服务支持

友情链接

客服帮助