# Technical Documentation: go-pay/gopay > ℹ️ **Provenance:** Hybrid Fusion: `go-pay/gopay` (README + 10 In-Tree Chapters) · [CodeWiki Reference](https://codewiki.google/github.com/go-pay/gopay) · Recency: Active (< 180 days) ## 1. Project Overview & Quickstart (go-pay/gopay) # GoPay ### 微信、支付宝、抖音、QQ、通联支付、拉卡拉、PayPal、扫呗、Apple支付的 Golang 版本SDK [](https://github.com/iGoogle-ink) [](https://github.com/go-pay/gopay/fork) [](https://golang.google.cn) [](https://pkg.go.dev/github.com/go-pay/gopay) [](https://github.com/go-pay/gopay/actions/workflows/go.yml) [](https://github.com/go-pay/gopay/releases) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://goreportcard.com/report/github.com/go-pay/gopay) --- # 一、安装 ```bash go get github.com/go-pay/gopay ``` #### 查看 GoPay 版本 [版本更新记录](https://github.com/go-pay/gopay/blob/main/release_note.md) ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/xlog" ) func main() { xlog.Info("GoPay Version: ", gopay.Version) } ``` --- # 二、文档目录 > ### 点击查看不同支付方式的使用文档。方便的话，请留下您认可的小星星，十分感谢！ * #### [支付宝支付（V3版）](https://github.com/go-pay/gopay/blob/main/doc/alipay_v3.md) * #### [支付宝支付](https://github.com/go-pay/gopay/blob/main/doc/alipay.md) * #### [微信支付（V3版）](https://github.com/go-pay/gopay/blob/main/doc/wechat_v3.md) * 微信商家转账产品升级，目前已支持新版商家转账接口 * #### [微信支付（V2版，不推荐）](https://github.com/go-pay/gopay/blob/main/doc/wechat_v2.md) * #### [抖音支付](https://github.com/go-pay/gopay/blob/main/doc/douyin.md) * #### [招商银行聚合支付](https://github.com/go-pay/gopay/blob/main/doc/cmbpay.md) * #### [QQ支付](https://github.com/go-pay/gopay/blob/main/doc/qq.md) * #### [通联支付](https://github.com/go-pay/gopay/blob/main/doc/allinpay.md) * #### [拉卡拉支付](https://github.com/go-pay/gopay/blob/main/doc/lakala.md) * #### [Paypal支付](https://github.com/go-pay/gopay/blob/main/doc/paypal.md) * #### [Apple支付校验](https://github.com/go-pay/gopay/blob/main/doc/apple.md) * #### [扫呗支付](https://github.com/go-pay/gopay/blob/main/doc/saobei.md) --- # 三、其他说明 * **【v1.5.119 起 TLS 证书校验默认开启】** 此前 `pkg/xhttp.NewClient()` 默认 `tls.Config{InsecureSkipVerify: true}`，存在中间人攻击风险（CWE-295），自 v1.5.119 起改为使用 Go 标准库默认安全配置。 * **不影响生产环境**：所有支付平台官方域名证书均受信任。 * **沙箱 / 自签证书场景需手动恢复**：New Client 后调用 `SetHttpClient` 注入跳过校验的 xhttp.Client： ```go import ( "crypto/tls" "github.com/go-pay/gopay/pkg/xhttp" ) hc := xhttp.NewClient().SetHttpTLSConfig(&tls.Config{InsecureSkipVerify: true}) client.SetHttpClient(hc) // wechat / alipay / douyin / paypal / qq / allinpay / lakala / saobei 均支持 ``` * 如需自定义Log输出，New Client 后，调用 `client.SetLogger()` 方法设置自定义Logger，自定义Logger实现 `xlog.XLogger` interface即可。 * 各支付方式接入，请仔细查看 `xxx_test.go` 使用方式 * `gopay/wechat/v3/client_test.go` * `gopay/alipay/v3/client_test.go` * `gopay/alipay/client_test.go` * `gopay/examples/douyin/douyin.go`（示例代码） * `gopay/qq/client_test.go` * `gopay/allinpay/client_test.go` * `gopay/lakala/client_test.go` * `gopay/paypal/client_test.go` * `gopay/apple/verify_test.go` * 或 examples * 接入gopay示例项目(可参考接入使用方式)：[gopay-platform](https://github.com/go-pay/gopay-platform) * 有问题请加微信群 或 关注抖音账号，加入首页粉丝群拉微信群。在此，非常感谢提出宝贵意见和反馈问题的同志们！ * 开发过程中，请尽量使用正式环境，1分钱测试法！ * 有偿承接技术咨询、开发，如需要加微信联系。 --- ## 赞赏多少是您的心意，感谢支持！ 微信赞赏码：      支付宝赞助码： --- ## 问题沟通（非必要不用加微信） > 微信: **[85411418](.github/wechat_jerry.png)**（加个人微信备注清楚来意，谢谢）。 [//]: # (关注抖音：) [//]: # () [//]: # (    QQ群：) [//]: # () --- ## 鸣谢 > [GoLand](https://www.jetbrains.com/go/?from=gopay) A Go IDE with extended support for JavaScript, TypeScript, and Databases。 特别感谢 [JetBrains](https://www.jetbrains.com/?from=gopay) 为开源项目提供免费的 [GoLand](https://www.jetbrains.com/go/?from=gopay) 等 IDE 的授权 [](https://www.jetbrains.com/?from=gopay) > Copyright © 2025 JetBrains s.r.o. JetBrains and the JetBrains logo are trademarks of JetBrains s.r.o. ## 2. In-Tree Documentation Chapters (go-pay/gopay) ## File: README.md # GoPay ### 微信、支付宝、抖音、QQ、通联支付、拉卡拉、PayPal、扫呗、Apple支付的 Golang 版本SDK [](https://github.com/iGoogle-ink) [](https://github.com/go-pay/gopay/fork) [](https://golang.google.cn) [](https://pkg.go.dev/github.com/go-pay/gopay) [](https://github.com/go-pay/gopay/actions/workflows/go.yml) [](https://github.com/go-pay/gopay/releases) [](https://www.apache.org/licenses/LICENSE-2.0) [](https://goreportcard.com/report/github.com/go-pay/gopay) --- # 一、安装 ```bash go get github.com/go-pay/gopay ``` #### 查看 GoPay 版本 [版本更新记录](https://github.com/go-pay/gopay/blob/main/release_note.md) ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/xlog" ) func main() { xlog.Info("GoPay Version: ", gopay.Version) } ``` --- # 二、文档目录 > ### 点击查看不同支付方式的使用文档。方便的话，请留下您认可的小星星，十分感谢！ * #### [支付宝支付（V3版）](https://github.com/go-pay/gopay/blob/main/doc/alipay_v3.md) * #### [支付宝支付](https://github.com/go-pay/gopay/blob/main/doc/alipay.md) * #### [微信支付（V3版）](https://github.com/go-pay/gopay/blob/main/doc/wechat_v3.md) * 微信商家转账产品升级，目前已支持新版商家转账接口 * #### [微信支付（V2版，不推荐）](https://github.com/go-pay/gopay/blob/main/doc/wechat_v2.md) * #### [抖音支付](https://github.com/go-pay/gopay/blob/main/doc/douyin.md) * #### [招商银行聚合支付](https://github.com/go-pay/gopay/blob/main/doc/cmbpay.md) * #### [QQ支付](https://github.com/go-pay/gopay/blob/main/doc/qq.md) * #### [通联支付](https://github.com/go-pay/gopay/blob/main/doc/allinpay.md) * #### [拉卡拉支付](https://github.com/go-pay/gopay/blob/main/doc/lakala.md) * #### [Paypal支付](https://github.com/go-pay/gopay/blob/main/doc/paypal.md) * #### [Apple支付校验](https://github.com/go-pay/gopay/blob/main/doc/apple.md) * #### [扫呗支付](https://github.com/go-pay/gopay/blob/main/doc/saobei.md) --- # 三、其他说明 * **【v1.5.119 起 TLS 证书校验默认开启】** 此前 `pkg/xhttp.NewClient()` 默认 `tls.Config{InsecureSkipVerify: true}`，存在中间人攻击风险（CWE-295），自 v1.5.119 起改为使用 Go 标准库默认安全配置。 * **不影响生产环境**：所有支付平台官方域名证书均受信任。 * **沙箱 / 自签证书场景需手动恢复**：New Client 后调用 `SetHttpClient` 注入跳过校验的 xhttp.Client： ```go import ( "crypto/tls" "github.com/go-pay/gopay/pkg/xhttp" ) hc := xhttp.NewClient().SetHttpTLSConfig(&tls.Config{InsecureSkipVerify: true}) client.SetHttpClient(hc) // wechat / alipay / douyin / paypal / qq / allinpay / lakala / saobei 均支持 ``` * 如需自定义Log输出，New Client 后，调用 `client.SetLogger()` 方法设置自定义Logger，自定义Logger实现 `xlog.XLogger` interface即可。 * 各支付方式接入，请仔细查看 `xxx_test.go` 使用方式 * `gopay/wechat/v3/client_test.go` * `gopay/alipay/v3/client_test.go` * `gopay/alipay/client_test.go` * `gopay/examples/douyin/douyin.go`（示例代码） * `gopay/qq/client_test.go` * `gopay/allinpay/client_test.go` * `gopay/lakala/client_test.go` * `gopay/paypal/client_test.go` * `gopay/apple/verify_test.go` * 或 examples * 接入gopay示例项目(可参考接入使用方式)：[gopay-platform](https://github.com/go-pay/gopay-platform) * 有问题请加微信群 或 关注抖音账号，加入首页粉丝群拉微信群。在此，非常感谢提出宝贵意见和反馈问题的同志们！ * 开发过程中，请尽量使用正式环境，1分钱测试法！ * 有偿承接技术咨询、开发，如需要加微信联系。 --- ## 赞赏多少是您的心意，感谢支持！ 微信赞赏码：      支付宝赞助码： --- ## 问题沟通（非必要不用加微信） > 微信: **[85411418](.github/wechat_jerry.png)**（加个人微信备注清楚来意，谢谢）。 [//]: # (关注抖音：) [//]: # () [//]: # (    QQ群：) [//]: # () --- ## 鸣谢 > [GoLand](https://www.jetbrains.com/go/?from=gopay) A Go IDE with extended support for JavaScript, TypeScript, and Databases。 特别感谢 [JetBrains](https://www.jetbrains.com/?from=gopay) 为开源项目提供免费的 [GoLand](https://www.jetbrains.com/go/?from=gopay) 等 IDE 的授权 [](https://www.jetbrains.com/?from=gopay) > Copyright © 2025 JetBrains s.r.o. JetBrains and the JetBrains logo are trademarks of JetBrains s.r.o. --- ## File: doc/alipay.md ## 支付宝 > #### [开发文档（V3版）](https://opendocs.alipay.com/open-v3) 支付宝v3版本已支持，接口持续完善中。 > #### 因支付宝接口太多，如没实现的接口，还请开发者自行调用 `client.PostAliPayAPISelfV2()`方法实现！请参考 `client_test.go` 内的 `TestClient_PostAliPayAPISelfV2()` 方法 > #### 希望有时间的伙伴儿Fork完后，补充并提交Pull Request，一起完善支付宝各个类别下的接口到相应的go文件中 - 已实现API列表附录：[API 列表附录](https://github.com/go-pay/gopay/blob/main/doc/alipay.md#%E9%99%84%E5%BD%95) - 支付宝官方文档：[官方文档](https://openhome.alipay.com/docCenter/docCenter.htm) - 技术接入指南：[技术接入指南](https://opendocs.alipay.com/common/02mse2) - 技术支持&案例FAQ：[技术支持&案例FAQ](https://opendocs.alipay.com/support/01rarm) - 支付宝RSA秘钥生成文档：[生成RSA密钥](https://opendocs.alipay.com/common/02kipl) （推荐使用 RSA2） - 沙箱环境(新) 使用说明：[新版沙箱文档](https://opendocs.alipay.com/common/02kkv7) --- ### 1、初始化支付宝客户端并做配置 > 具体API使用介绍，请参考 `gopay/alipay/client_test.go` ```go import ( "github.com/go-pay/gopay/alipay" "github.com/go-pay/xlog" ) // 初始化支付宝客户端 // appid：应用ID // privateKey：应用私钥，支持PKCS1和PKCS8 // isProd：是否是正式环境，沙箱环境请选择新版沙箱应用。 client, err := alipay.NewClient("2016091200494382", privateKey, false) if err != nil { xlog.Error(err) return } // 自定义配置http请求接收返回结果body大小，默认 10MB client.SetBodySize() // 没有特殊需求，可忽略此配置 // 设置自定义RequestId生成方法，非必须 client.SetRequestIdFunc() // 打开Debug开关，输出日志，默认关闭 client.DebugSwitch = gopay.DebugOn // 设置支付宝请求 公共参数 // 注意：具体设置哪些参数，根据不同的方法而不同，此处列举出所有设置参数 client.SetLocation(alipay.LocationShanghai). // 设置时区，不设置或出错均为默认服务器时间 SetCharset(alipay.UTF8). // 设置字符编码，不设置默认 utf-8 SetSignType(alipay.RSA2). // 设置签名类型，不设置默认 RSA2 SetReturnUrl("https://www.fmm.ink"). // 设置返回URL SetNotifyUrl("https://www.fmm.ink"). // 设置异步通知URL SetAppAuthToken() // 设置第三方应用授权 // 设置biz_content加密KEY，设置此参数默认开启加密（目前不可用，设置后会报错） //client.SetAESKey("1234567890123456") // 自动同步验签（只支持证书模式） // 传入 alipayPublicCert.crt 内容 client.AutoVerifySign([]byte("alipayPublicCert.crt bytes")) // 公钥证书模式，需要传入证书，以下两种方式二选一 // 证书路径 err := client.SetCertSnByPath("appPublicCert.crt", "alipayRootCert.crt", "alipayPublicCert.crt") // 证书内容 err := client.SetCertSnByContent("appPublicCert.crt bytes", "alipayRootCert bytes", "alipayPublicCert.crt bytes") ``` ### 2、API 方法调用及入参 > 具体参数请根据不同接口查看：[支付宝支付API接口文档](https://opendocs.alipay.com/open/065yhr) > 业务错误处理：当 `err != nil` 时，可通过 `alipay.IsBizError()` 捕获业务错误状态码和说明。 > 不在乎 `BizError` 的可忽略统一判错处理 > ★入参 BodyMap中，支持如下公共参数在当次请求中自定义设置：`version`、`return_url`、`notify_url`、`app_auth_token` - 统一收单交易支付接口 - 示例 ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/gopay/alipay" ) // 初始化 BodyMap bm := make(gopay.BodyMap) bm.Set("subject", "条码支付"). Set("scene", "bar_code"). Set("auth_code", "286248566432274952"). Set("out_trade_no", "GZ201909081743431443"). Set("total_amount", "0.01"). Set("timeout_express", "2m"). Set(alipay.AppAuthToken, "i_am_app_auth_token") // 如果需要，可以设置自定义应用授权 aliRsp, err := client.TradePay(bm) if err != nil { xlog.Errorf("client.TradePay(%+v),err:%+v", bm, err) return } ``` ### 3、同步返回参数验签Sign、异步通知参数解析和验签Sign、异步通知返回 > 异步通知请求参数需要先解析，解析出来的结构体或BodyMap再验签（此处需要注意，`http.Request.Body` 只能解析一次，如果需要解析前调试，请处理好Body复用问题） [Gin Web框架（推荐）](https://github.com/gin-gonic/gin) [Echo Web框架](https://github.com/labstack/echo) > 注意：APP支付、手机网站支付、电脑网站支付 不支持同步返回验签 > 支付宝支付后的同步/异步通知验签文档：[支付结果通知](https://opendocs.alipay.com/common/02mse7) - 同步返回验签，手动验签（如已开启自动验签，则无需手动验签操作） ```go import ( "github.com/go-pay/gopay/alipay" ) aliRsp, err := client.TradePay(bm) if err != nil { xlog.Error("err:", err) return } // 公钥模式验签 // 注意：APP支付，手机网站支付，电脑网站支付 不支持同步返回验签 // aliPayPublicKey：支付宝平台获取的支付宝公钥 // signData：待验签参数，aliRsp.SignData // sign：待验签sign，aliRsp.Sign ok, err := alipay.VerifySyncSign(aliPayPublicKey, aliRsp.SignData, aliRsp.Sign) // 公钥证书模式验签 // aliPayPublicKeyCert：支付宝公钥证书存放路径 alipayPublicCert.crt 或文件内容[]byte // signData：待验签参数，aliRsp.SignData // sign：待验签sign，aliRsp.Sign ok, err := alipay.VerifySyncSignWithCert(aliPayPublicKeyCert, aliRsp.SignData, aliRsp.Sign) ``` - 异步通知验签 ```go import ( "github.com/go-pay/gopay/alipay" ) // 解析异步通知的参数 // req：*http.Request notifyReq, err = alipay.ParseNotifyToBodyMap(c.Request) // c.Request 是 gin 框架的写法 if err != nil { xlog.Error(err) return } 或 // value：url.Values notifyReq, err = alipay.ParseNotifyByURLValues() if err != nil { xlog.Error(err) return } // 支付宝异步通知验签（公钥模式） ok, err = alipay.VerifySign(aliPayPublicKey, notifyReq) // 支付宝异步通知验签（公钥证书模式） ok, err = alipay.VerifySignWithCert("alipayPublicCert.crt content", notifyReq) // 如果需要，可将 BodyMap 内数据，Unmarshal 到指定结构体指针 ptr err = notifyReq.Unmarshal(ptr) // ====异步通知，返回支付宝平台的信息==== // 文档：https://opendocs.alipay.com/open/203/105286 // 程序执行完后必须打印输出“success”（不包含引号）。如果商户反馈给支付宝的字符不是success这7个字符，支付宝服务器会不断重发通知，直到超过24小时22分钟。一般情况下，25小时以内完成8次通知（通知的间隔频率一般是：4m,10m,10m,1h,2h,6h,15h） // 此写法是 gin 框架返回支付宝的写法 c.String(http.StatusOK, "%s", "success") // 此写法是 echo 框架返回支付宝的写法 return c.String(http.StatusOK, "success") ``` ### 4、支付宝 公共API（仅部分说明） > 支付宝换取授权访问令牌文档：[换取授权访问令牌](https://opendocs.alipay.com/apis/api_9/alipay.system.oauth.token) > 支付宝小程序 获取用户手机号文档：[获取用户手机号](https://opendocs.alipay.com/mini/api/getphonenumber) > 支付宝加解密文档：[AES加解密文档](https://opendocs.alipay.com/open/common/104567) ```go import ( "github.com/go-pay/gopay/alipay" "github.com/go-pay/xlog" ) // 换取授权访问令牌（默认使用utf-8，RSA2） // appId：应用ID // privateKey：应用私钥，支持PKCS1和PKCS8 // grantType：值为 authorization_code 时，代表用code换取；值为 refresh_token 时，代表用refresh_token换取，传空默认code换取 // codeOrToken：支付宝授权码或refresh_token rsp, err := alipay.SystemOauthToken(appId, privateKey, grantType, codeOrToken) if err != nil { xlog.Error(err) return } // 解密支付宝开放数据带到指定结构体 // 以小程序获取手机号为例 phone := new(alipay.UserPhone) // 解密支付宝开放数据 // encryptedData:包括敏感数据在内的完整用户信息的加密数据 // secretKey:AES密钥，支付宝管理平台配置 // beanPtr:需要解析到的结构体指针 err := alipay.DecryptOpenDataToStruct(encryptedData, secretKey, phone) xlog.Infof("%+v", phone) ``` --- ## 附录： ### 支付宝支付 API * 支付宝接口自行实现方法：`client.PostAliPayAPISelfV2()` * 生成请求参数：`client.RequestParam()` * 支付产品 * 当面付 * 付款码支付接口(商家扫用户付款码)：`client.TradePay()` * 统一收单线下交易预创建接口(用户扫商品收款码)：`client.TradePrecreate()` * App支付 * APP支付接口2.0(APP支付)：`client.TradeAppPay()` * 手机网站支付 * 手机网站支付接口2.0(手机网站支付)：`client.TradeWapPay()` * 电脑网站支付 * 统一收单下单并支付页面接口(电脑网站支付)：`client.TradePagePay()` * 刷脸付 * 刷脸支付初始化接口：`client.ZolozAuthenticationSmilepayInitialize()` * 查询刷脸结果信息接口：`client.ZolozAuthenticationCustomerFtokenQuery()` * 预授权支付 * 线上资金授权冻结接口：`client:FundAuthOrderAppFreeze()` * 资金授权操作查询接口：`client.FundAuthOperationDetailQuery()` * 资金授权撤销接口：`client.FundAuthOperationCancel()` * 资金授权解冻接口：`client.FundAuthOrderUnfreeze()` * 资金授权发码接口：`client.FundAuthOrderVoucherCreate()` * 资金授权冻结接口：`client.FundAuthOrderFreeze()` * 交易 * 统一收单交易创建接口：`client.TradeCreate()` * 统一收单交易订单支付接口：`client.TradeOrderPay()` * 统一收单线下交易查询: `client.TradeQuery()` * 统一收单交易退款接口: `client.TradeRefund()` * 统一收单交易退款查询: `client.TradeFastPayRefundQuery()` * 统一收单交易关闭接口: `client.TradeClose()` * 统一收单交易撤销接口: `client.TradeCancel()` * 支付宝订单信息同步接口: `client.TradeOrderInfoSync()` * 账单 * 查询对账单下载地址：`client.DataBillDownloadUrlQuery()` * 商家分账 * 分账关系维护 * 分账关系绑定接口：`client.TradeRelationBind()` * 分账关系解绑接口：`client.TradeRelationUnbind()` * 分账关系查询接口：`client.TradeRelationBatchQuery()` * 分账请求 * 统一收单交易结算接口：`client.TradeOrderSettle()` * 统一收单确认结算接口：`client.TradeSettleConfirm()` * 分账查询 * 分账比例查询：`client.TradeRoyaltyRateQuery()` * 分账剩余金额查询：`client.TradeOrderOnSettleQuery()` * 交易分账查询接口：`client.TradeOrderSettleQuery()` * 商家扣款 * 支付宝个人协议页面签约接口: `client.UserAgreementPageSign()` * 支付宝个人协议页面签约接口 - PC转二维码唤起签约页: `client.UserAgreementPageSignInQRCode()` * 支付宝个人代扣协议查询接口: `client.UserAgreementQuery()` * 支付宝个人代扣协议解约接口: `client.UserAgreementPageUnSign()` * 周期性扣款协议执行计划修改接口: `client.UserAgreementExecutionplanModify()` * 私域产品 * 支付有礼 * 推广计划 * 公域产品 * 经营推广 * 推广计划 * 推广计划状态变更消息接口：`client.MarketingActivityDeliveryChanged()` * 创建推广计划接口：`client.MarketingActivityDeliveryCreate()` * 查询推广计划接口：`client.MarketingActivityDeliveryQuery()` * 停止推广计划接口：`client.MarketingActivityDeliveryStop()` * 营销图片资源上传接口：`client.MarketingMaterialImageUpload()` * 营销产品 * 支付券 * 创建支付券接口：`client.MarketingActivityVoucherCreate()` * 激活支付券接口：`client.MarketingActivityVoucherPublish()` * 查询支付券详情接口：`client.MarketingActivityVoucherQuery()` * 修改支付券基本信息接口：`client.MarketingActivityVoucherModify()` * 追加支付券预算接口：`client.MarketingActivityVoucherAppend()` * 停止支付券接口：`client.MarketingActivityVoucherStop()` * 私域营销 * 条件查询活动列表接口：`client.MarketingActivityBatchQuery()` * 活动领取咨询接口：`client.MarketingActivityConsult()` * 查询活动详情接口：`client.MarketingActivityQuery()` * 查询活动可用商户接口：`client.MarketingActivityQueryMerchantBatchQuery()` * 查询活动可用小程序接口：`client.MarketingActivityQueryAppBatchQuery()` * 查询活动可用门店接口：`client.MarketingActivityQueryShopBatchQuery()` * 查询活动适用商品接口：`client.MarketingActivityQueryGoodsBatchQuery()` * 条件查询用户券接口：`client.MarketingActivityQueryUserBatchQueryVoucher()` * 查询用户券详情接口：`client.MarketingActivityQueryUserQueryVoucher()` * 订单优惠前置咨询接口：`client.MarketingCampaignOrderVoucherConsult()` * 蚂蚁门店管理 * 蚂蚁店铺创建接口: `client.AntMerchantShopCreate()` * 修改蚂蚁店铺接口: `client.AntMerchantShopModify()` * 商户申请单查询接口: `client.AntMerchantOrderQuery()` * 店铺分页查询接口：`client.AntMerchantShopPageQuery()` * 店铺查询接口：`client.AntMerchantShopQuery()` * 蚂蚁店铺关闭接口：`client.AntMerchantShopClose()` * 图片上传接口：`client.AntMerchantExpandIndirectImageUpload()` * 商户mcc信息查询接口：`client.AntMerchantExpandMccQuery()` * 店铺增加收单账号接口：`client.AntMerchantExpandShopReceiptAccountSave()` * 商家券 2.0 * 活动创建 * 创建商家券活动接口：`client.MarketingActivityOrderVoucherCreate()` * 同步商家券券码接口：`client.MarketingActivityOrderVoucherCodeDeposit()` * 活动修改 * 修改商家券活动基本信息接口：`client.MarketingActivityOrderVoucherModify()` * 活动停止 * 停止商家券活动接口：`client.MarketingActivityOrderVoucherStop()` * 预算追加 * 修改商家券活动发券数量上限接口：`client.MarketingActivityOrderVoucherAppend()` * 活动发放 * 活动领取咨询接口：`client.MarketingActivityConsult()` * 优惠券核销 * 同步券核销状态接口：`client.MarketingActivityOrderVoucherUse()` * 取消券核销状态接口：`client.MarketingActivityOrderVoucherRefund()` * 活动查询 * 查询商家券活动接口：`client.MarketingActivityOrderVoucherQuery()` * 查询活动详情接口：`client.MarketingActivityQuery()` * 统计商家券券码数量接口：`client.MarketingActivityOrderVoucherCodeCount()` * 条件查询活动列表接口：`client.MarketingActivityBatchQuery()` * 条件查询用户券接口：`client.MarketingActivityQueryUserBatchQueryVoucher()` * 查询用户券详情接口：`client.MarketingActivityQueryUserQueryVoucher()` * 查询活动可用小程序接口：`client.MarketingActivityQueryAppBatchQuery()` * 查询活动可用门店接口：`client.MarketingActivityQueryShopBatchQuery()` * 查询活动适用商品接口：`client.MarketingActivityQueryGoodsBatchQuery()` * 商家会员卡 * 会员卡模板创建接口：`client.MarketingCardTemplateCreate()` * 会员卡模板修改接口：`client.MarketingCardTemplateModify()` * 会员卡模板查询接口：`client.MarketingCardTemplateQuery()` * 会员卡更新接口：`client.MarketingCardUpdate()` * 会员卡查询接口：`client.MarketingCardQuery()` * 会员卡删卡接口：`client.MarketingCardDelete()` * 会员卡消息通知接口：`client.MarketingCardMessageNotify()` * 会员卡开卡表单模板配置接口：`client.MarketingCardFormTemplateSet()` * 上传门店照片和视频接口：`client.OfflineMaterialImageUpload()` * 营销活动送红包 * 创建现金活动接口：`client.MarketingCampaignCashCreate()` * 触发现金红包活动接口：`client.MarketingCampaignCashTrigger()` * 更改现金活动状态接口：`client.MarketingCampaignCashStatusModify()` * 现金活动列表查询接口：`client.MarketingCampaignCashListQuery()` * 现金活动详情查询接口：`client.MarketingCampaignCashDetailQuery()` * 红包 * 资金转账页面支付接口: `client.FundTransPagePay()` * 现金红包无线支付接口: `client.FundTransAppPay()` * 单笔转账接口：`client.FundTransUniTransfer()` * 转账业务单据查询接口：`client.FundTransCommonQuery()` * 资金退回接口: `client.FundTransRefund()` * 棋盘密云 * 接口上传人群 * 上传创建人群接口：`client.MerchantQipanCrowdCreate()` * 人群中追加用户接口：`client.MerchantQipanCrowdUserAdd()` * 人群中删除用户接口：`client.MerchantQipanCrowdUserDelete()` * 标签圈选创建人群 * 棋盘人群圈选标签基本信息查询接口：`client.MarketingQipanTagBaseBatchQuery()` * 棋盘标签圈选值查询接口：`client.MarketingQipanTagQuery()` * 棋盘人群创建接口：`client.MarketingQipanCrowdOperationCreate()` * 查询圈选标签列表接口：`client.MarketingQipanCrowdTagQuery()` * 标签圈选创建人群接口：`client.MarketingQipanCrowdWithTagCreate()` * 标签圈选预估人群规模接口：`client.MarketingQipanCrowdWithTagQuery()` * 管理人群 * 查询人群列表接口：`client.MarketingQipanCrowdBatchQuery()` * 查询人群详情接口：`client.MarketingQipanCrowdQuery()` * 修改人群接口：`client.MarketingQipanCrowdModify()` * 数据洞察 * 看板分析接口：`client.MarketingQipanBoardQuery()` * 画像分析接口：`client.MarketingQipanInsightQuery()` * 行为分析接口：`client.MarketingQipanBehaviorQuery()` * 趋势分析接口：`client.MarketingQipanTrendQuery()` * 常住省市查询接口：`client.MarketingQipanInsightCityQuery()` * 资金产品 * 转账到支付宝账户 * 支付宝资金账户资产查询接口：`client.FundAccountQuery()` * 申请电子回单(incubating)接口：`client.DataBillEreceiptApply()` * 查询电子回单状态(incubating)接口：`client.DataBillEreceiptQuery()` * 查询转账订单接口: `client.FundTransOrderQuery()` * 批次下单接口: `client.FundBatchCreate()` * 批量转账关单接口: `client.FundBatchClose()` * 批量转账明细查询接口: `client.FundBatchDetailQuery()` * 资金收款账号绑定关系查询: `client.FundTransPayeeBindQuery()` * 会员产品 * 人脸验证 * 人脸核身 * APP人脸核身初始化接口：`client.FaceVerificationInitialize()` * APP人脸核身结果查询接口：`client.FaceVerificationQuery()` * H5人脸核身初始化接口：`client.FaceCertifyInitialize()` * H5人脸核身开始认证接口：`client.FaceCertifyVerify()` * H5人脸核身查询记录接口：`client.FaceCertifyQuery()` * 纯服务端人脸核身接口：`client.FaceSourceCertify()` * 活体检测 * 人脸检测初始化接口：`client.FaceCheckInitialize()` * 人脸检测结果数据查询接口：`client.FaceCheckQuery()` * OCR文字识别 * 服务端OCR接口：`client.OcrServerDetect()` * App端OCR初始化接口：`client.OcrMobileInitialize()` * 文字识别OCR接口：`client.OcrCommonDetect()` * 获取会员信息 * 支付宝会员授权信息查询接口：`client.UserInfoShare()` * 换取授权访问令牌接口：`client.SystemOauthToken()` * 用户授权关系查询接口：`client.UserAuthRelationshipQuery()` * 查询解除授权明细接口：`client.UserDelOAuthDetailQuery()` * 支付宝身份验证 * 身份认证记录查询: `client.UserCertifyOpenQuery()` * 身份认证初始化服务接口: `client.UserCertifyOpenInit()` * 身份认证开始认证: `client.UserCertifyOpenCertify()` * APP支付宝登录 * 用户登录授权接口：`client.UserInfoAuth()` * 信用产品 * 芝麻GO * 芝麻GO签约预创单接口：`client.ZhimaCreditPeZmgoPreorderCreate()` * 芝麻GO页面签约接口：`client.ZhimaCreditPeZmgoSignApply()` * 商家芝麻GO累计数据回传接口：`client.ZhimaMerchantZmgoCumulateSync()` * 商家芝麻GO累计数据查询接口：`client.ZhimaMerchantZmgoCumulateQuery()` * 芝麻GO结算申请接口：`client.ZhimaCreditPeZmgoSettleApply()` * 芝麻GO结算退款接口：`client.ZhimaCreditPeZmgoSettleRefund()` * 芝麻Go协议查询接口：`client.ZhimaCreditPeZmgoAgreementQuery()` * 芝麻GO协议解约接口：`client.ZhimaCreditPeZmgoAgreementUnsign()` * 商户创建芝麻GO模板接口：`client.ZhimaMerchantZmgoTemplateCreate()` * 芝麻GO模板查询接口：`client.ZhimaMerchantZmgoTemplateQuery()` * 芝麻GO用户数据回传: `client.ZhimaCreditPeZmgoCumulationSync()` * 芝麻GO签约关单: `client.ZhimaCreditPeZmgoBizoptClose()` * 芝麻GO解冻接口: `client.ZhimaCreditPeZmgoSettleUnfreeze()` * 芝麻GO支付下单链路签约申请: `client.ZhimaCreditPeZmgoPaysignApply()` * 芝麻GO支付下单链路签约确认: `client.ZhimaCreditPeZmgoPaysignConfirm()` * 芝麻先享 * 服务开通 * 信用服务开通/授权接口：`client.ZhimaCreditPayAfterUseAgreementSign()` * 查询服务开通/授权信息接口：`client.ZhimaCreditPayAfterUseAgreementQuery()` * 信用下单 * 芝麻先享信用服务下单（免用户确认场景）接口：`client.ZhimaCreditPayAfterUseCreditBizOrder()` * 芝麻先享信用服务下单（用户确认场景）接口：支付宝 SDK 实现 * 信用服务订单查询接口：`client.ZhimaCreditPayAfterUseCreditBizOrderQuery()` * 结束信用服务订单接口：`client.ZhimaCreditPayAfterUseCreditBizOrderFinish()` * 扣款 * 统一收单交易订单支付接口：`client.TradeOrderPay()` * 芝麻免押 * 创建免押订单接口：`client:FundAuthOrderAppFreeze()` * 完结免押订单接口：`client.FundAuthOrderUnfreeze()` * 查询免押订单接口：`client.FundAuthOperationDetailQuery()` * 取消免押订单接口：`client.FundAuthOperationCancel()` * 芝麻身份信息验证 * 信用服务开通/授权接口：`client.ZhimaCreditPayAfterUseAgreementSign()` * 职得身份认证查询接口：`client.ZhimaCustomerJobworthAuthQuery()` * 职得工作证信息匹配度查询: `client.ZhimaCustomerJobworthAdapterQuery()` * 职得工作证外部渠道应用数据回流: `client.ZhimaCustomerJobworthSceneUse()` * 身份验真预咨询服务接口：`client.ZhimaCustomerJobworthAuthPreConsult()` * 安全产品 * 交易安全防护 * 商户数据同步：`client.SecurityCustomerRiskSend()` * RiskGO * 消费者投诉 * 处理消费者投诉接口：`client.SecurityRiskComplaintProcessFinish()` * 投诉处理附件图片上传接口：`client.SecurityRiskComplaintFileUpload()` * 查询消费者投诉详情接口：`client.SecurityRiskComplaintInfoQuery()` * 查询消费者投诉列表接口：`client.SecurityRiskComplaintInfoBatchquery()` * 营销风险识别 * 营销风险识别发奖接口：`client.SecurityRiskMarketingAwardingQuery()` * 营销风险识别抢购接口：`client.SecurityRiskMarketingPurchaseQuery()` * 行业风险识别 * 行业风险识别黄牛接口：`client.SecurityRiskIndustryScalperQuery()` * 行业风险识别刷单接口：`client.SecurityRiskIndustryFarmingQuery()` * 行业风险识别先享后付违约接口：`client.SecurityRiskIndustryNsfQuery()` * 内容风险识别 * 内容风险同步识别接口：`client.SecurityRiskContentSyncDetect()` * 广告产品 * 支付宝广告投放 * 转化数据回传接口：`client.DataServiceAdConversionUpload()` * 广告投放数据通用查询接口：`client.DataServiceAdReportdataQuery()` * 自建推广页列表批量查询接口：`client.DataServiceAdPromotepageBatchquery()` * 自建推广页留资数据查询接口：`client.DataServiceAdPromotepageDownload()` * 任务广告完成状态查询接口：`client.DataServiceXlightTaskQuery()` * 其他通用产品 * 商家费率申请 * 特殊费率申请接口：`client.OpenFeeAdjustApply()` * 第三方应用产品 * 第三方应用授权 * 换取应用授权令牌：`client.OpenAuthTokenApp()` * 查询某个应用授权AppAuthToken的授权信息：`client.OpenAuthTokenAppQuery()` * ISV向商户发起应用授权邀约：`client.OpenAuthTokenAppInviteCreate()` * 三方开发基础 * 查询应用可申请的接口出参敏感字段列表：`client.OpenAppApiQuery()` * 申请获取接口用户敏感信息字段：`client.OpenAppApiFieldApply()` * 查询接口字段使用场景：`client.OpenAppApiSceneQuery()` * 用户信息申请记录查询：`client.OpenAppApiFieldQuery()` * 应用信息修改接口：`client.OpenAppInfoModify()` * 应用信息查询接口：`client.OpenAppInfoQuery()` * 邀测站点 * 营销咨询 * 商户前置内容咨询接口： `client.PayAppMarketingConsult()` * 订阅 * 商品创建接口：`client.TradeProductCreate()` * 商品修改接口：`client.TradeProductModify()` * 商品查询接口：`client.TradeProductQuery()` * 价格创建接口：`client.TradePriceCreate()` * 价格查询接口：`client.TradePriceQuery()` * 客户创建接口：`client.TradeCustomerCreate()` * 订阅创建接口：`client.TradeSubscriptionCreate()` * 订阅修改接口：`client.TradeSubscriptionModify()` * 订阅查询接口：`client.TradeSubscriptionQuery()` * 支付宝电子发票 * 正向开票 * 支付开票开票申请创建接口：`client.IndustryInvoiceApplyCreate()` * 支付开票开票申请查询接口：`client.IndustryInvoiceApplyQuery()` * 支付开票开票申请重试接口：`client.IndustryInvoiceApplyRetry()` * 企业信息 * 企业信息查询接口：`client.IndustryInvoiceCompanyQuery()` * 可能失效的接口 * 应用支付宝公钥证书下载：`client.PublicCertDownload()` * 小程序生成推广二维码接口：`client.OpenAppQrcodeCreate()` * 花芝轻会员结算申请: `client.PcreditHuabeiAuthSettleApply()` * NFC用户卡信息同步: `client.CommerceTransportNfccardSend()` * 广告投放数据查询: `client.DataDataserviceAdDataQuery()` * 航司电话订票待申请接口: `client.CommerceAirCallcenterTradeApply()` * 网商银行全渠道收单业务订单创建: `client.PaymentTradeOrderCreate()` * 聚合支付订单咨询服务: `client.KoubeiTradeOrderAggregateConsult()` * 口碑订单预下单: `client.KoubeiTradeOrderPrecreate()` * 口碑商品交易购买接口: `client.KoubeiTradeItemorderBuy()` * 口碑订单预咨询: `client.KoubeiTradeOrderConsult()` * 口碑商品交易退货接口: `client.KoubeiTradeItemorderRefund()` * 口碑商品交易查询接口: `client.KoubeiTradeItemorderQuery()` * 码商发码成功回调接口: `client.KoubeiTradeTicketTicketcodeSend()` * 口碑凭证延期接口: `client.KoubeiTradeTicketTicketcodeDelay()` * 口碑凭证码查询: `client.KoubeiTradeTicketTicketcodeQuery()` * 口碑凭证码撤销核销: `client.KoubeiTradeTicketTicketcodeCancel()` * 蚂蚁店铺创建咨询: `client.AntMerchantShopConsult()` * 申请权益发放: `client.CommerceBenefitApply()` * 权益核销: `client.CommerceBenefitVerify()` * 还款账单查询: `client.TradeRepaybillQuery()` * 芝麻企业信用信用评估初始化: `client.ZhimaCreditEpSceneRatingInitialize()` * 信用服务履约同步: `client.ZhimaCreditEpSceneFulfillmentSync()` * 加入信用服务: `clinet.ZhimaCreditEpSceneAgreementUse()` * 取消信用服务: `client.ZhimaCreditEpSceneAgreementCancel()` * 信用服务履约同步(批量): `client.ZhimaCreditEpSceneFulfillmentlistSync()` * 小程序生成推广二维码接口：`client.OpenAppQrcodeCreate()` * 协议由普通通用代扣协议产品转移到周期扣协议产品: `client.UserAgreementTransfer()` * 通用当面付二阶段接口: `client.UserTwostageCommonUse()` * 芝麻企业征信基于身份的协议授权: `client.UserAuthZhimaorgIdentityApply()` * 查询是否在支付宝公益捐赠的接口: `client.UserCharityRecordexistQuery()` * 集分宝发放接口: `client.UserAlipaypointSend()` * isv 会员CRM数据回流: `client.MemberDataIsvCreate()` * 询家人信息档案(选人授权)组件已选的家人档案信息: `client.UserFamilyArchiveQuery()` * 初始化家人信息档案(选人授权)组件: `client.UserFamilyArchiveInitialize()` * 实名证件信息比对验证预咨询: `client.UserCertdocCertverifyPreconsult()` * 实名证件信息比对验证咨询: `client.UserCertdocCertverifyConsult()` * 初始化家庭芝麻GO共享组件: `client.UserFamilyShareZmgoInitialize()` * 数字分行银行码明细数据查询: `client.UserDtbankQrcodedataQuery()` * 查询集分宝预算库详情: `client.UserAlipaypointBudgetlibQuery()` ### 支付宝公共 API * `alipay.IsBizError()` => 判断并捕获业务错误 BizError * `alipay.GetCertSN()` => 获取证书SN号（app_cert_sn、alipay_cert_sn） * `alipay.GetRootCertSN()` => 获取证书SN号（alipay_root_cert_sn） * `alipay.GetRsaSign()` => 获取支付宝参数签名（参数sign值） * `alipay.SystemOauthToken()` => 换取授权访问令牌（得到access_token，user_id等信息） * `alipay.FormatPrivateKey()` => 格式化应用私钥 * `alipay.FormatPublicKey()` => 格式化支付宝公钥 * `alipay.FormatURLParam()` => 格式化支付宝请求URL参数 * `alipay.ParseNotifyToBodyMap()` => 解析支付宝支付异步通知的参数到BodyMap * `alipay.ParseNotifyByURLValues()` => 通过 url.Values 解析支付宝支付异步通知的参数到BodyMap * `alipay.VerifySign()` => 支付宝异步通知参数验签 * `alipay.VerifySignWithCert()` => 支付宝异步通知参数验签（证书方式） * `alipay.VerifySyncSign()` => 支付宝同步返回参数验签 * `alipay.DecryptOpenDataToStruct()` => 解密支付宝开放数据到 结构体 * `alipay.DecryptOpenDataToBodyMap()` => 解密支付宝开放数据到 BodyMap * `alipay.MonitorHeartbeatSyn()` => 验签接口 --- ## File: doc/alipay_v3.md ## 支付宝 > #### 支付宝v3版本已支持，接口持续完善中。 > #### 因支付宝接口太多，如没实现的接口，还请开发者自行调用 `client.DoAliPayAPISelfV3()`方法实现！请参考 `client_test.go` 内的 `TestDoAliPayAPISelfV3()` 方法 > #### 希望有时间的伙伴儿Fork完后，补充并提交Pull Request，一起完善支付宝各个类别下的接口到相应的go文件中 - 已实现API列表附录：[API 列表附录](https://github.com/go-pay/gopay/blob/main/doc/alipay_v3.md#%E9%99%84%E5%BD%95) - 开发文档（V3版）：[开发文档（V3版）](https://opendocs.alipay.com/open-v3) - 接口规则：[接口规则](https://opendocs.alipay.com/open-v3/053sd1) - 支付宝RSA秘钥生成文档：[生成RSA密钥](https://opendocs.alipay.com/common/02kipl) （推荐使用 RSA2） - 沙箱环境(新) 使用说明：[新版沙箱文档](https://opendocs.alipay.com/common/02kkv7) --- ### 1、初始化支付宝客户端并做配置 > 具体API使用介绍，请参考 `gopay/alipay/v3/client_test.go` > ```go import ( "github.com/go-pay/gopay/alipay/v3" "github.com/go-pay/xlog" ) // 初始化支付宝客V3户端 // appid：应用ID // privateKey：应用私钥，支持PKCS1和PKCS8 // isProd：是否是正式环境，沙箱环境请选择新版沙箱应用。 client, err := alipay.NewClientV3("2016091200494382", privateKey, false) if err != nil { xlog.Error(err) return } // 设置自定义配置（如需要） //client. // SetAppAuthToken("app_auth_token"). // 设置授权token // SetBodySize(). // 自定义配置http请求接收返回结果body大小，默认 10MB，没有特殊需求，可忽略此配置 // SetRequestIdFunc(). // 设置自定义RequestId生成方法 // SetAESKey("KvKUTqSVZX2fUgmxnFyMaQ==") // 设置biz_content加密KEY，设置此参数默认开启加密（目前不可用） // 打开Debug开关，输出日志，默认关闭 client.DebugSwitch = gopay.DebugOn // 传入证书内容 err := client.SetCert("appPublicCert.crt bytes", "alipayRootCert bytes", "alipayPublicCert.crt bytes") ``` ### 2、API 方法调用及入参 > 具体参数请根据不同接口查看：[支付宝V3版API接口文档](https://opendocs.alipay.com/open-v3) > ★入参 BodyMap中，支持如下公共参数在当次请求中自定义设置：`alipay-app-auth-token` - 统一收单线下交易预创建 - 示例 ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/gopay/pkg/js" "github.com/go-pay/util" "github.com/go-pay/xlog" "github.com/go-pay/gopay/alipay/v3" ) // 请求参数 bm := make(gopay.BodyMap) bm.Set("subject", "预创建创建订单"). Set("out_trade_no", util.RandomString(32)). Set("total_amount", "0.01") Set(alipay.HeaderAppAuthToken, "i_am_app_auth_token") // 如果需要，可以设置自定义应用授权 // 创建订单 aliRsp, err := client.TradePrecreate(ctx, bm) if err != nil { xlog.Errorf("client.TradePrecreate(), err:%v", err) return } xlog.Warnf("aliRsp:%s", js.Marshal(aliRsp)) if aliRsp.StatusCode != Success { xlog.Errorf("aliRsp.StatusCode:%d", aliRsp.StatusCode) return } xlog.Warnf("aliRsp.QrCode:", aliRsp.QrCode) xlog.Warnf("aliRsp.OutTradeNo:", aliRsp.OutTradeNo) ``` - 自定义接口调用 - 示例 ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/gopay/pkg/js" "github.com/go-pay/util" "github.com/go-pay/xlog" ) // 请求参数 bm := make(gopay.BodyMap) bm.Set("subject", "预创建创建订单"). Set("out_trade_no", util.RandomString(32)). Set("total_amount", "0.01") rsp := new(struct { OutTradeNo string `json:"out_trade_no"` QrCode string `json:"qr_code"` }) // 创建订单 res, err := client.DoAliPayAPISelfV3(ctx, alipay.MethodPost, "/v3/alipay/trade/precreate", bm, rsp) if err != nil { xlog.Errorf("client.TradePrecreate(), err:%v", err) return } xlog.Warnf("aliRsp:%s", js.Marshal(rsp)) if res.StatusCode != Success { xlog.Errorf("aliRsp.StatusCode:%d", res.StatusCode) return } ``` ### 3、异步通知参数解析和验签Sign、异步通知返回（复用非V3版方式） > 异步通知请求参数需要先解析，解析出来的结构体或BodyMap再验签（此处需要注意，`http.Request.Body` 只能解析一次，如果需要解析前调试，请处理好Body复用问题） [Gin Web框架（推荐）](https://github.com/gin-gonic/gin) [Echo Web框架](https://github.com/labstack/echo) > 支付宝支付后的异步通知验签文档：[支付结果通知](https://opendocs.alipay.com/common/02mse7) - 异步通知验签（复用非V3版方式） ```go import ( "github.com/go-pay/gopay/alipay" ) // 解析异步通知的参数 // req：*http.Request notifyReq, err = alipay.ParseNotifyToBodyMap(c.Request) // c.Request 是 gin 框架的写法 if err != nil { xlog.Error(err) return } 或 // value：url.Values notifyReq, err = alipay.ParseNotifyByURLValues() if err != nil { xlog.Error(err) return } // 支付宝异步通知验签（公钥模式） ok, err = alipay.VerifySign(aliPayPublicKey, notifyReq) // 支付宝异步通知验签（公钥证书模式） ok, err = alipay.VerifySignWithCert([]byte("alipayPublicCert.crt content"), notifyReq) // 如果需要，可将 BodyMap 内数据，Unmarshal 到指定结构体指针 ptr err = notifyReq.Unmarshal(ptr) // ====异步通知，返回支付宝平台的信息==== // 文档：https://opendocs.alipay.com/open/203/105286 // 程序执行完后必须打印输出“success”（不包含引号）。如果商户反馈给支付宝的字符不是success这7个字符，支付宝服务器会不断重发通知，直到超过24小时22分钟。一般情况下，25小时以内完成8次通知（通知的间隔频率一般是：4m,10m,10m,1h,2h,6h,15h） // 此写法是 gin 框架返回支付宝的写法 c.String(http.StatusOK, "%s", "success") // 此写法是 echo 框架返回支付宝的写法 return c.String(http.StatusOK, "success") ``` --- ## 附录： ### 支付宝支付 API * 支付宝接口自行实现方法：`client.DoAliPayAPISelfV3()` * 支付 * 统一收单交易支付接口：`client.TradePay()` * 统一收单交易查询：`client.TradeQuery()` * 统一收单交易退款接口：`client.TradeRefund()` * 统一收单交易退款查询：`client.TradeFastPayRefundQuery()` * 统一收单交易撤销接口：`client.TradeCancel()` * 统一收单交易关闭接口：`client.TradeClose()` * 查询对账单下载地址：`client.DataBillDownloadUrlQuery()` * 统一收单线下交易预创建：`client.TradePrecreate()` * 支付宝APP支付（v2版本）：`client.TradeAppPay()` * 统一收单下单并支付页面接口（v2版本）：`client.TradePagePay()` * 手机网站支付接口（v2版本）：`client.TradeWapPay()` * 统一收单交易创建接口：`client.TradeCreate()` * 支付宝订单信息同步接口：`client.TradeOrderInfoSync()` * 资金授权操作查询接口：`client.FundAuthOperationDetailQuery()` * 资金授权冻结接口：`client.FundAuthOrderFreeze()` * 资金授权解冻接口：`client.FundAuthOrderUnfreeze()` * 资金授权发码接口：`client.FundAuthOrderVoucherCreate()` * 刷脸支付初始化接口：`client.ZolozAuthenticationSmilepayInitialize()` * 查询刷脸结果信息接口：`client.ZolozAuthenticationCustomerFtokenQuery()` * 商家扣款 * 支付宝个人代扣协议查询接口：`client.UserAgreementQuery()` * 支付宝个人代扣协议解约接口：`client.UserAgreementPageUnSign()` * 商家分账 * 分账关系绑定接口：`client.TradeRelationBind()` * 分账关系解绑：`client.TradeRelationUnbind()` * 分账关系查询：`client.TradeRelationBatchQuery()` * 分账比例查询：`client.TradeRoyaltyRateQuery()` * 统一收单交易结算接口：`client.TradeOrderSettle()` * 分账剩余金额查询：`client.TradeOrderOnSettleQuery()` * 商家转账 * 支付宝资金账户资产查询接口：`client.FundAccountQuery()` * 转账额度查询接口：`client.FundQuotaQuery()` * 单笔转账接口：`client.FundTransUniTransfer()` * 申请电子回单(incubating)：`client.DataBillEreceiptApply()` * 查询电子回单状态(incubating)：`client.DataBillEreceiptQuery()` * 转账业务单据查询接口：`client.FundTransCommonQuery()` * 多步转账创建并支付：`client.FundTransMultistepTransfer()` * 多步转账查询接口：`client.FundTransMultistepQuery()` * 会员 * 换取授权访问令牌：`client.SystemOauthToken()` * 身份认证记录查询：`client.UserCertifyOpenQuery()` * 身份认证初始化服务：`client.UserCertifyOpenInitialize()` * 支付宝会员授权信息查询接口：`client.UserInfoShare()` * 用户授权关系查询：`client.UserAuthRelationshipQuery()` * 查询解除授权明细：`client.UserDelOauthDetailQuery()` * 人脸认证 * 人脸核身初始化：`client.FaceVerificationInitialize()` * 人脸核身结果查询：`client.FaceVerificationQuery()` * 跳转支付宝人脸核身初始化：`client.FaceCertifyInitialize()` * 跳转支付宝人脸核身开始认证：`client.FaceCertifyVerify()` * 跳转支付宝人脸核身查询记录：`client.FaceCertifyQuery()` * 纯服务端人脸核身：`client.FaceSourceCertify()` * 活体检测初始化：`client.FaceCheckInitialize()` * 活体检测结果查询：`client.FaceCheckQuery()` * 身份证二要素核验：`client.IDCardTwoMetaCheck()` * 银行卡核验：`client.BankCardCheck()` * 手机号三要素核验简版：`client.MobileThreeMetaSimpleCheck()` * 手机号三要素核验详版：`client.MobileThreeMetaDetailCheck()` * 服务端OCR：`client.OcrServerDetect()` * App端OCR初始化：`client.OcrMobileInitialize()` * 推广计划 * 创建推广计划：`client.MarketingActivityDeliveryCreate()` * 查询推广计划：`client.MarketingActivityDeliveryQuery()` * 停止推广计划：`client.MarketingActivityDeliveryStop()` * 营销 * 创建现金活动：`client.MarketingCampaignCashCreate()` * 触发现金红包：`client.MarketingCampaignCashTrigger()` * 更改现金活动状态：`client.MarketingCampaignCashStatusModify()` * 现金活动列表查询：`client.MarketingCampaignCashListQuery()` * 现金活动详情查询：`client.MarketingCampaignCashDetailQuery()` * 订单优惠前置咨询：`client.MarketingCampaignOrderVoucherConsult()` * 创建商家券活动：`client.MarketingActivityOrderVoucherCreate()` * 同步商家券券码：`client.MarketingActivityOrderVoucherCodeDeposit()` * 修改商家活动券基本信息：`client.MarketingActivityOrderVoucherModify()` * 停止商家活动券：`client.MarketingActivityOrderVoucherStop()` * 修改商家活动券发券数量上限：`client.MarketingActivityOrderVoucherAppend()` * 同步券核销状态：`client.MarketingActivityOrderVoucherUse()` * 取消券核销状态：`client.MarketingActivityOrderVoucherRefund()` * 活动领取咨询接口：`client.MarketingActivityConsult()` * 查询商家券活动：`client.MarketingActivityOrderVoucherQuery()` * 查询活动详情：`client.MarketingActivityQuery()` * 统计商家券券码数量：`client.MarketingActivityOrderVoucherCodeCount()` * 条件查询活动列表：`client.MarketingActivityBatchQuery()` * 条件查询用户券：`client.MarketingActivityQueryUserBatchQueryVoucher()` * 查询用户券详情：`client.MarketingActivityQueryUserQueryVoucher()` * 查询活动可用小程序：`client.MarketingActivityQueryAppBatchQuery()` * 查询活动可用门店：`client.MarketingActivityQueryShopBatchQuery()` * 查询活动适用商品：`client.MarketingActivityQueryGoodsBatchQuery()` * 蚂蚁店铺创建：`client.AntMerchantShopCreate()` * 店铺查询接口：`client.AntMerchantShopQuery()` * 修改蚂蚁店铺：`client.AntMerchantShopModify()` * 蚂蚁店铺关闭：`client.AntMerchantShopClose()` * 商户申请单查询：`client.AntMerchantOrderQuery()` * 店铺分页查询接口：`client.AntMerchantShopPageQuery()` * 图片上传：`client.AntMerchantExpandIndirectImageUpload()` * 商户mcc信息查询：`client.AntMerchantExpandMccQuery()` * 店铺增加收单账号：`client.AntMerchantExpandShopReceiptAccountSave()` * 会员卡模板创建：`client.MarketingCardTemplateCreate()` * 会员卡模板查询接口：`client.MarketingCardTemplateQuery()` * 会员卡模板修改：`client.MarketingCardTemplateModify()` * 会员卡开卡表单模板配置：`client.MarketingCardFormTemplateSet()` * 会员卡查询：`client.MarketingCardQuery()` * 会员卡更新：`client.MarketingCardUpdate()` * 会员卡删卡：`client.MarketingCardDelete()` * 会员卡消息通知：`client.MarketingCardMessageNotify()` * 上传门店照片和视频接口：`client.OfflineMaterialImageUpload()` * 资金退回接口：`client.FundTransRefund()` * 棋盘密云 * 上传创建人群：`client.MerchantQipanCrowdCreate()` * 人群中追加用户：`client.MerchantQipanCrowdUserAdd()` * 人群中删除用户：`client.MerchantQipanCrowdUserDelete()` * 棋盘人群圈选标签基本信息查询：`client.MarketingQipanTagBaseBatchQuery()` * 棋盘标签圈选值查询：`client.MarketingQipanTagQuery()` * 查询人群列表：`client.MarketingQipanCrowdBatchQuery()` * 查询人群详情：`client.MarketingQipanCrowdQuery()` * 修改人群：`client.MarketingQipanCrowdModify()` * 人群池创建：`client.MerchantQipanCrowdPoolCreate()` * 人群扩展接口：`client.MerchantQipanCrowdSpread()` * 上传创建灰黑产人群：`client.MerchantQipanGreyBlackCrowdCreate()` * 灰黑产人群中追加用户：`client.MerchantQipanGreyBlackCrowdUserAdd()` * 灰黑产人群中删除用户：`client.MerchantQipanGreyBlackCrowdUserDelete()` * 图片素材 * 营销图片资源上传接口：`client.MarketingMaterialImageUpload()` * 信用 * 芝麻GO签约预创单：`client.ZmGoPreorderCreate()` * 商家芝麻GO累计数据回传接口：`client.ZmGoCumulateSync()` * 商家芝麻GO累计数据查询接口：`client.ZmGoCumulateQuery()` * 芝麻GO结算申请：`client.ZmGoSettleApply()` * 芝麻GO结算退款：`client.ZmGoSettleRefund()` * 芝麻Go协议查询接口：`client.ZmGoAgreementQuery()` * 芝麻GO协议解约：`client.ZmGoAgreementQueryUnsign()` * 商户创建芝麻GO模板接口：`client.ZmGoTemplateCreate()` * 商家芝麻GO模板查询：`client.ZmGoTemplateQuery()` * 广告 * 转化数据回传：`client.AdConversionUpload()` * 广告投放数据通用查询：`client.AdReportdataQuery()` * 自建推广页列表批量查询：`client.AdPromotepageBatchquery()` * 自建推广页留资数据查询：`client.AdPromotepageDownload()` * 任务广告完成状态查询接口：`client.XlightTaskQuery()` * 消费明细查询接口：`client.AdConsumehistoryQuery()` * 商品落地页信息创建或更新：`client.ProductLandinginfoCreateOrModify()` * 商品落地页信息查询：`client.ProductLandinginfoQuery()` * 广告代理商投放数据查询：`client.AdAgentreportdataQuery()` * 小程序开发 * 小程序退回开发：`client.OpenMiniVersionAuditedCancel()` * 小程序灰度上架：`client.OpenMiniVersionGrayOnline()` * 小程序结束灰度：`client.OpenMiniVersionGrayCancel()` * 小程序上架：`client.OpenMiniVersionOnline()` * 小程序下架：`client.OpenMiniVersionOffline()` * 小程序回滚：`client.OpenMiniVersionRollback()` * 小程序删除版本：`client.OpenMiniVersionDelete()` * 小程序提交审核：`client.OpenMiniVersionAuditApply()` * 小程序基于模板上传版本：`client.OpenMiniVersionUpload()` * 查询使用模板的小程序列表：`client.OpenMiniTemplateUsageQuery()` * 小程序查询版本构建状态：`client.OpenMiniVersionBuildQuery()` * 小程序版本详情查询：`client.OpenMiniVersionDetailQuery()` * 小程序版本列表查询：`client.OpenMiniVersionListQuery()` * 小程序生成体验版：`client.OpenMiniExperienceCreate()` * 小程序体验版状态查询接口：`client.OpenMiniExperienceQuery()` * 小程序取消体验版：`client.OpenMiniExperienceCancel()` * 小程序产品-订单中心 * 商品文件上传接口：`client.MerchantItemFileUpload()` ### 支付宝公共 API --- ## File: doc/allinpay.md ## 通联支付 - 通联支付：[官方文档中心](https://aipboss.allinpay.com/know/devhelp/index.php) > 具体API使用介绍，请参考`gopay/allinpay/client_test.go`,`gopay/allinpay/pay_test.go` 等xxx_test.go ### 通联支付 API * 统一支付接口(暂无账号为测试可用性)：`client.Pay()` * 统一扫码接口: `client.ScanPay()` * 撤销订单：`client.Cancel()` * 交易退款：`client.Refund()` * 交易结果查询：`client.Query()` * 关闭订单：`client.Close()` * 申请退款：`client.Refund()` --- ## File: doc/apple.md ## Apple - App Store Server API：[官方文档](https://developer.apple.com/documentation/appstoreserverapi) ### 初始化Apple客户端 > 具体介绍，请参考 `gopay/apple/client_test.go` ```go import ( "github.com/go-pay/xlog" "github.com/go-pay/gopay/apple" ) // 初始化通联客户端 // iss：issuer ID // bid：bundle ID // kid：private key ID // privateKey：私钥文件读取后的字符串内容 // isProd：是否是正式环境 client, err = NewClient(iss, bid, kid, "privateKey", false) if err != nil { xlog.Error(err) return } ``` ### Apple Pay 支付校验收据 * [苹果校验收据文档](https://developer.apple.com/documentation/appstorereceipts/verifyreceipt) > url 请选择 apple.UrlSandbox 或 apple.UrlProd * `apple.VerifyReceipt()` => 苹果支付校验收据API --- #### 校验示例 ```go import ( "github.com/go-pay/gopay/apple" "github.com/go-pay/xlog" ) pwd := "" receipt := "" rsp, err := apple.VerifyReceipt(UrlSandbox, pwd, receipt) if err != nil { xlog.Error(err) return } /** response body: {"receipt":{"original_purchase_date_pst":"2021-08-14 05:28:17 America/Los_Angeles", "purchase_date_ms":"1628944097586", "unique_identifier":"13f339a765b706f8775f729723e9b889b0cbb64e", "original_transaction_id":"1000000859439868", "bvrs":"10", "transaction_id":"1000000859439868", "quantity":"1", "in_app_ownership_type":"PURCHASED", "unique_vendor_identifier":"6DFDEA8B-38CE-4710-A1E1-BAEB8B66FEBD", "item_id":"1581250870", "version_external_identifier":"0", "bid":"com.huochai.main", "is_in_intro_offer_period":"false", "product_id":"10002", "purchase_date":"2021-08-14 12:28:17 Etc/GMT", "is_trial_period":"false", "purchase_date_pst":"2021-08-14 05:28:17 America/Los_Angeles", "original_purchase_date":"2021-08-14 12:28:17 Etc/GMT", "original_purchase_date_ms":"1628944097586"}, "status":0} */ if rsp.Receipt != nil { xlog.Infof("receipt:%+v", rsp.Receipt) } ``` * [苹果服务端通知V2版本](https://developer.apple.com/documentation/appstoreservernotifications) > 苹果支付服务服务端通知数据解析 > 对应App下 `[App 信息] --> [App Store 服务器通知] --> [版本 2]` 配置对应的服务器地址,支付状态发生变化时Apple 将通过POST请求推送消息至配置的地址 #### 示例 - 请参考 `notification_v2_test.go` ``` /* Detailed source-code truncated for AI context efficiency. */ ``` ### App Store Server API Client Function * `client.GetTransactionInfo()` => Get Transaction Info * `client.GetTransactionHistory()` => Get Transaction History * `client.GetAllSubscriptionStatuses()` => GetAllSubscriptionStatuses * `client.SendConsumptionInformation()` => Send Consumption Information * `client.GetNotificationHistory()` => Get Notification History * `client.LookUpOrderId()` => Look Up Order ID * `client.GetRefundHistory()` => Get Refund History ### Apple Function * `apple.VerifyReceipt()` => 验证支付凭证 * `apple.ExtractClaims()` => 解析signedPayload * `apple.DecodeSignedPayload()` => 解析notification signedPayload --- ## File: doc/lakala.md ## 拉卡拉网关支付 - 拉卡拉网关支付：[官方文档中心](https://payjp.lakala.com/docs/cn) ### 回调通知解析 ``` notifyReq, err := lakala.ParseNotify() if err != nil { xlog.Error(err) return } ``` ### 拉卡拉 API * QRCode * 创建QRCode支付单：`client.CreateQRCodeOrder()` * 创建Native QRCode支付单：`client.CreateNativeQRCodeOrder()` * QRCode支付跳转页：`client.QRCodePay()` * JSAPI * 创建JSAPI订单：`client.CreateJSAPIOrder()` * 创建Native JSAPI订单(offline)：`client.CreateNativeJSApiOrder()` * 微信JSAPI支付跳转页：`client.JSAPIWechatPay()` * 支付宝JSAPI支付跳转页：`client.JSAPIAlipayPay()` * Alipay+ JSAPI支付跳转页：`client.JSAPIAlipayPlusPay()` * MobileH5 * 创建H5支付单：`client.CreateH5PayOrder()` * H5支付跳转页：`client.H5Pay()` * H5支付跳转页(Alipay+)：`client.H5AlipayPlusPay()` * Miniprogram Payment * 创建小程序订单：`client.CreateMiniProgramOrder()` * Channel Web Gateway * 创建渠道Web网关订单：`client.CreateWebGatewayOrder()` * SDKPayment * 创建SDK订单(Online)：`client.CreateSDKPaymentOrder()` * CommonApi * 获取当前汇率：`client.GetExchangeRate()` * 获取加密密钥：`client.GetEncrypt()` * 关闭订单：`client.CloseOrder()` * 查询订单状态：`client.OrderStatus()` * 申请退款：`client.ApplyRefund()` * 查询退款状态：`client.RefundQuery()` * 查看订单：`client.OrderList()` * 查看账单流水：`client.TransactionList()` * 查看清算详情：`client.Settlements()` * 查询可用钱包：`client.ConsultPayment()` * 获取优惠券信息：`client.GetCoupon()` * Custom * 创建报关单（非拆单）：`client.CreateReportSingle()` * 创建报关单（拆单）：`client.CreateReportSeparate()` * 报关状态查询：`client.ReportStatus()` * 报关子单状态查询：`client.ReportSubStatus()` * 修改报关信息（非拆单）：`client.ModifyReportSingle()` * 修改报关信息（拆单）：`client.ModifyReportSeparate()` * 重推报关（非拆单）：`client.ResendReportSingle()` * 报关单子单重推：`client.ResendReportSeparate()` --- ## File: doc/paypal.md ## PayPal > 具体API使用介绍，请参考`gopay/paypal/client_test.go`,`gopay/paypal/order_test.go`,`gopay/paypal/payment_test.go` 等xxx_test.go - 已实现API列表附录：[API List](https://github.com/go-pay/gopay/blob/main/doc/paypal.md#%E9%99%84%E5%BD%95) - PayPal官方文档：[Official Document](https://developer.paypal.com/api/rest) --- ### 1、初始化PayPal客户端并做配置（Init PayPal Client） ```go import ( "github.com/go-pay/gopay/paypal" "github.com/go-pay/xlog" ) // 初始化PayPal支付客户端 client, err := paypal.NewClient(Clientid, Secret, false) if err != nil { xlog.Error(err) return } // 自定义配置http请求接收返回结果body大小，默认 10MB client.SetBodySize() // 没有特殊需求，可忽略此配置 // 打开Debug开关，输出日志，默认关闭 client.DebugSwitch = gopay.DebugOn ``` ### 2、API 方法调用及入参（Call API） > Orders：[Orders API](https://developer.paypal.com/api/orders/v2/) > Payments：[Payments API](https://developer.paypal.com/api/payments/v2/) > Subscriptions：[Subscriptions API](https://developer.paypal.com/docs/api/subscriptions/v1/) - Create Orders example ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/gopay/paypal" "github.com/go-pay/util" "github.com/go-pay/xlog" ) // Create Orders example var pus []*paypal.PurchaseUnit var item = &paypal.PurchaseUnit{ ReferenceId: util.GetRandomString(16), Amount: &paypal.Amount{ CurrencyCode: "USD", Value: "8", }, } pus = append(pus, item) bm := make(gopay.BodyMap) bm.Set("intent", "CAPTURE"). Set("purchase_units", pus). SetBodyMap("payment_source", func(b gopay.BodyMap) { b.SetBodyMap("paypal", func(bb gopay.BodyMap) { bb.SetBodyMap("experience_context", func(bbb gopay.BodyMap) { bbb.Set("brand_name", "gopay"). Set("locale", "en-US"). Set("shipping_preference", "NO_SHIPPING"). Set("user_action", "PAY_NOW"). Set("return_url", "http://xxx/return"). Set("cancel_url", "http://xxx/cancel") }) }) }) ppRsp, err := client.CreateOrder(ctx, bm) if err != nil { xlog.Error(err) return } if ppRsp.Code != 200 { // do something return } ``` - Capture payment for order ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/xlog" ) // Capture payment for order //bm := make(gopay.BodyMap) //bm.SetBodyMap("payment_source", func(b gopay.BodyMap) { // b.SetBodyMap("token", func(b gopay.BodyMap) { // b.Set("id", "The PayPal-generated ID for the token"). // Set("type", "BILLING_AGREEMENT") // }) //}) ppRsp, err := client.OrderCapture(ctx, "4X223967G91314611", nil) if err != nil { xlog.Error(err) return } if ppRsp.Code != paypal.Success { // do something return } ``` --- ## 附录： ### PayPal API * AccessToken * 获取AccessToken（Get AccessToken）：`client.GetAccessToken()` * Invoices * 生成发票号码（Generate invoice number）：`client.InvoiceNumberGenerate()` * 发票列表（List invoices）：`client.InvoiceList()` * 创建虚拟发票（Create draft invoice）：`client.InvoiceCreate()` * 删除发票（Delete invoice）：`client.InvoiceDelete()` * 更新发票（Fully update invoice）：`client.InvoiceUpdate()` * 获取发票详情（Show invoice details）：`client.InvoiceDetail()` * 生成发票二维码（Generate QR code）：`client.InvoiceGenerateQRCode()` * 发票付款记录（Record payment for invoice）：`client.InvoicePaymentRecord()` * 发票付款删除（Delete external payment）：`client.InvoicePaymentDelete()` * 发票退款记录（Record refund for invoice）：`client.InvoiceRefundRecord()` * 发票退款删除（Delete external refund）：`client.InvoiceRefundDelete()` * 发送发票提醒（Send invoice reminder）：`client.InvoiceSendRemind()` * 发送发票（Send invoice）：`client.InvoiceSend()` * 发票搜索（Search for invoices）：`client.InvoiceSearch()` * 发票模板列表（List templates）：`client.InvoiceTemplateList()` * 创建发票模板（Create template）：`client.InvoiceTemplateCreate()` * 发票模板详情（Show template details）：`client.InvoiceTemplateDetail()` * 删除发票模板（Delete template）：`client.InvoiceTemplateDelete()` * 更新发票模板（Fully update template）：`client.InvoiceTemplateUpdate()` * Orders * 创建订单（Create order）：`client.CreateOrder()` * 订单详情（Show order details）：`client.OrderDetail()` * 更新订单（Update order）：`client.UpdateOrder()` * 订单支付授权（Authorize payment for order）：`client.OrderAuthorize()` * 订单支付捕获（Capture payment for order）：`client.OrderCapture()` * 订单支付确认（Confirm the Order）：`client.OrderConfirm()` * 支持内联订阅计划（循环扣款 / 保存支付方式 / 分期）：`Item.BillingPlan`（类型 `OrderBillingPlan` / `OrderBillingCycle`） * Payments * 支付授权详情（Show details for authorized payment）：`client.PaymentAuthorizeDetail()` * 重新授权支付授权（Reauthorize authorized payment）：`client.PaymentReauthorize()` * 作废支付授权（Void authorized payment）：`client.PaymentAuthorizeVoid()` * 支付授权捕获（Capture authorized payment）：`client.PaymentAuthorizeCapture()` * 支付捕获详情（Show captured payment details）：`client.PaymentCaptureDetail()` * 支付捕获退款（Refund captured payment）：`client.PaymentCaptureRefund()` * 支付退款详情（Show refund details）：`client.PaymentRefundDetail()` * 可用支付方式查询（Find eligible payment methods）：`client.FindEligiblePaymentMethods()` * Payment Method Tokens * 为给定的支付来源创建支付令牌（Create payment token for a given payment source）：`client.CreatePaymentToken()` * 列出所有支付令牌（List all payment tokens）：`client.ListAllPaymentTokens()` * 检索付款令牌（Retrieve a payment token）：`client.RetrievePaymentToken()` * 删除付款令牌（Delete payment token）：`client.DeletePaymentToken()` * 创建设置令牌（Create a setup token）：`client.CreateSetupToken()` * 检索设置令牌（Retrieve a setup token）：`client.RetrieveSetupToken()` * Payouts * 创建批量支出（Create batch payout）：`client.CreateBatchPayout()` * 批量支出详情（Show payout batch details）：`client.ShowPayoutBatchDetails()` * 批量支出项目详情（Show Payout Item Details）：`client.ShowPayoutItemDetails()` * 取消批量支付中收款人无PayPal账号的项目（Cancel Unclaimed Payout Item）：`client.CancelUnclaimedPayoutItem()` * Subscriptions * 创建计划（Create plan）：`client.CreateBillingPlan()` * 计划列表（List plans）：`client.PlanList()` * 计划详情（Show plan details）：`client.PlanDetails()` * 更新计划（UpdateBillingPlan）：`client.PlanUpdate()` * 激活计划（Activate plan）：`client.PlanActivate()` * 停用计划（Deactivate plan）：`client.PlanDeactivate()` * 更新计划价格（Update pricing）：`client.PlanUpdatePrice()` * 创建订阅（Create subscription）：`client.SubscriptionCreate()` * 订阅详情（Show subscription details）：`client.SubscriptionDetails()` * 更新订阅（Update subscription）：`client.SubscriptionUpdate()` * 修改计划或订阅数量（Revise plan or quantity of subscription）：`client.SubscriptionRevise()` * 暂停订阅（Suspend subscription）：`client.SubscriptionSuspend()` * 取消订阅（Cancel subscription）：`client.SubscriptionCancel()` * 激活订阅（Activate subscription）：`client.SubscriptionActivate()` * 订阅时获取授权付款（Capture authorized payment on subscription）：`client.SubscriptionCapture()` * 订阅的交易列表（List transactions for subscription）：`client.SubscriptionTransactionList()` * Catalog Products * 创建产品（Create product）：`client.ProductCreate()` * 产品列表（List products）：`client.ProductList()` * 产品详情（Show product details）：`client.ProductDetails()` * 更新产品（Update product）：`client.ProductUpdate()` * Tracking（物流） * 添加物流单号（Add tracking information for an order）：`client.AddTrackingNumber()` * 更新或取消物流（Update or cancel tracking information）：`client.UpdateTracker()` --- ## File: doc/qq.md ## QQ > QQ支付 使用方法请参考 `GoPay微信v2文档` 的文档 > GoPay微信v2文档：[GoPay微信v2文档](https://github.com/go-pay/gopay/blob/main/doc/wechat_v2.md) ### QQ支付 API * 提交付款码支付：`client.MicroPay()` * 撤销订单：`client.Reverse()` * 统一下单：`client.UnifiedOrder()` * 订单查询：`client.OrderQuery()` * 关闭订单：`client.CloseOrder()` * 申请退款：`client.Refund()` * 退款查询：`client.RefundQuery()` * 交易账单：`client.StatementDown()` * 资金账单：`client.AccRoll()` * 创建现金红包（未测试可用性）：`client.SendCashRed()` * 对账单下载（未测试可用性）：`client.DownloadRedListFile()` * 查询红包详情（未测试可用性）：`client.QueryRedInfo()` * 自定义方法请求微信API接口：`client.PostQQAPISelf()` ### QQ公共 API * `qq.ParseNotifyToBodyMap()` => 解析QQ支付异步通知的结果到BodyMap * `qq.ParseNotify()` => 解析QQ支付异步通知的参数 * `qq.VerifySign()` => QQ同步返回参数验签或异步通知参数验签 * `qq.GetAccessToken()` => 获取 AccessToken 信息 * `qq.GetOpenId()` => 获取 Openid 信息 * `qq.GetUserInfo()` => 获取用户信息 --- --- ## File: doc/saobei.md ## 扫呗支付 API - 扫呗支付：[官方文档中心](https://help.lcsw.cn/xrmpic/q6imdiojes7iq5y1/qg52lx) > 具体API使用介绍，请参考`gopay/saobei/client_test.go` ### 支付2.0接口 > 请参考`gopay/saobei/pay_test.go`, * 小程序支付接口(暂无账号为测试可用性)：`client.MiniPay()` * 付款码支付 `client.BarcodePay()` * 支付查询 `client.Query()` * 退款申请 `client.Refund()` * 退款订单查询 `client.QueryRefund()` ### 资金接口 > 请参考`gopay/saobei/merchant_test.go`, ### CBK企业钱包分账 > 请参考`gopay/saobei/account_test.go`, --- ## File: doc/wechat_v2.md ## 微信v2 > #### 推荐使用v3接口，官方在v3接口实现未覆盖或gopay未开发的接口，还继续用v2接口。 - 已实现API列表附录：[API 列表附录](https://github.com/go-pay/gopay/blob/main/doc/wechat_v2.md#%E9%99%84%E5%BD%95) --- ### 1、初始化微信v2客户端并做配置 微信v2官方文档：[微信v2官方文档](https://pay.weixin.qq.com/wiki/doc/api/index.html) > 注意：微信支付下单等操作可用沙箱环境测试是否成功，但真正支付时，请使用正式环境 `isProd = true`，不然会报错。 > 微信证书二选一：只传 `apiclient_cert.pem` 和 `apiclient_key.pem` 或者只传 `apiclient_cert.p12` ```go import ( "github.com/go-pay/gopay/wechat" ) // 初始化微信客户端 // appId：应用ID // mchId：商户ID // apiKey：API秘钥值 // isProd：是否是正式环境 client := wechat.NewClient("wxdaa2ab9ef87b5497", mchId, apiKey, false) // 打开Debug开关，输出请求日志，默认关闭 client.DebugSwitch = gopay.DebugOn // 自定义配置http请求接收返回结果body大小，默认 10MB client.SetBodySize() // 没有特殊需求，可忽略此配置 // 设置国家：不设置默认 中国国内 // wechat.China：中国国内 // wechat.China2：中国国内备用 // wechat.SoutheastAsia：东南亚 // wechat.Other：其他国家 client.SetCountry(wechat.China) // 添加微信pem证书 client.AddCertPemFilePath() client.AddCertPemFileContent() 或 // 添加微信pkcs12证书 client.AddCertPkcs12FilePath() client.AddCertPkcs12FileContent() ``` ### 2、API 方法调用及入参 - #### 微信请求参数 > 微信V2接口通用参数（mch_id、appid、sign）无需传入，client 请求时会默认处理 具体参数请根据不同接口查看：[微信支付接口文档](https://pay.weixin.qq.com/wiki/doc/api/index.html) ```go import ( "github.com/go-pay/util" "github.com/go-pay/gopay/wechat" ) // 初始化 BodyMap bm := make(gopay.BodyMap) bm.Set("nonce_str", util.RandomString(32)). Set("body", "H5支付"). Set("out_trade_no", number). Set("total_fee", 1). Set("spbill_create_ip", "127.0.0.1"). Set("notify_url", "https://www.fmm.ink"). Set("trade_type", TradeType_H5). Set("device_info", "WEB"). Set("sign_type", SignType_MD5). SetBodyMap("scene_info", func(bm gopay.BodyMap) { bm.SetBodyMap("h5_info", func(bm gopay.BodyMap) { bm.Set("type", "Wap") bm.Set("wap_url", "https://www.fmm.ink") bm.Set("wap_name", "H5测试支付") }) }) /*.Set("openid", "o0Df70H2Q0fY8JXh1aFPIRyOBgu8")*/ ``` - #### client 方法调用 ```go wxRsp, err := client.UnifiedOrder(bm) wxRsp, err := client.Micropay(bm) wxRsp, err := client.QueryOrder(bm) wxRsp, err := client.CloseOrder(bm) wxRsp, err := client.Reverse(bm) wxRsp, err := client.Refund(bm) wxRsp, err := client.QueryRefund(bm) wxRsp, err := client.DownloadBill(bm) wxRsp, err := client.DownloadFundFlow(bm) wxRsp, err := client.BatchQueryComment(bm) wxRsp, err := client.Transfer(bm) ... ``` ### 3、微信统一下单后，获取微信小程序支付、APP支付、微信内H5支付所需要的 paySign > 微信小程序支付官方文档：[微信小程序支付API](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/payment/wx.requestPayment.html) > APP支付官方文档：[APP端调起支付的参数列表文档](https://pay.weixin.qq.com/wiki/doc/api/app/app.php?chapter=9_12) > 微信内H5支付官方文档：[微信内H5支付文档](https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/pay/OfficialPayMent/chapter5_5.shtml) ```go import ( "github.com/go-pay/gopay/wechat" ) // ====微信小程序 paySign==== timeStamp := strconv.FormatInt(time.Now().Unix(), 10) packages := "prepay_id=" + wxRsp.PrepayId // 此处的 wxRsp.PrepayId ,统一下单成功后得到 // 获取微信小程序支付的 paySign // appId：AppID // nonceStr：随机字符串 // packages：统一下单成功后拼接得到的值 // signType：签名方式，务必与统一下单时用的签名方式一致 // timeStamp：时间 // apiKey：API秘钥值 paySign := wechat.GetMiniPaySign(AppID, wxRsp.NonceStr, packages, wechat.SignType_MD5, timeStamp, apiKey) // ====APP支付 paySign==== timeStamp := strconv.FormatInt(time.Now().Unix(), 10) // 获取APP支付的 paySign // 注意：package 参数因为是固定值，无需开发者再传入 // appId：AppID // partnerid：partnerid // nonceStr：随机字符串 // prepayId：统一下单成功后得到的值 // signType：签名方式，务必与统一下单时用的签名方式一致 // timeStamp：时间 // apiKey：API秘钥值 paySign := wechat.GetAppPaySign(appid, partnerid, wxRsp.NonceStr, wxRsp.PrepayId, wechat.SignType_MD5, timeStamp, apiKey) // ====微信内H5支付 paySign==== timeStamp := strconv.FormatInt(time.Now().Unix(), 10) packages := "prepay_id=" + wxRsp.PrepayId // 此处的 wxRsp.PrepayId ,统一下单成功后得到 // 获取微信内H5支付 paySign // appId：AppID // nonceStr：随机字符串 // packages：统一下单成功后拼接得到的值 // signType：签名方式，务必与统一下单时用的签名方式一致 // timeStamp：时间 // apiKey：API秘钥值 paySign := wechat.GetH5PaySign(AppID, wxRsp.NonceStr, packages, wechat.SignType_MD5, timeStamp, apiKey) ``` ### 4、同步返回参数验签Sign、异步通知参数解析和验签Sign、异步通知返回 > 异步通知请求参数需要先解析，解析出来的结构体或BodyMap再验签（此处需要注意，`http.Request.Body` 只能解析一次，如果需要解析前调试，请处理好Body复用问题） [Gin Web框架（推荐）](https://github.com/gin-gonic/gin) [Echo Web框架](https://github.com/labstack/echo) ```go import ( "github.com/go-pay/gopay" "github.com/go-pay/gopay/wechat" ) // ====同步返回参数验签Sign==== wxRsp, err := client.UnifiedOrder(bm) // 微信同步返回参数验签或异步通知参数验签 // apiKey：API秘钥值 // signType：签名类型（调用API方法时填写的类型） // bean：微信同步返回的结构体 wxRsp 或 异步通知解析的结构体 notifyReq // 返回参数 ok：是否验签通过 // 返回参数 err：错误信息 ok, err := wechat.VerifySign(apiKey, wechat.SignType_MD5, wxRsp) // ====支付异步通知参数解析和验签Sign==== // 解析支付异步通知的参数 // req：*http.Request // ctx.Request 是 gin 框架的获取 *http.Request // ctx.Request() 是 echo 框架的获取 *http.Request // 返回参数 notifyReq：通知的参数 // 返回参数 err：错误信息 notifyReq, err := wechat.ParseNotifyToBodyMap(ctx.Request) // 验签操作 ok, err := wechat.VerifySign(apiKey, wechat.SignType_MD5, notifyReq) // ====退款异步通知参数解析，退款通知无sign，不用验签==== // // 解析退款异步通知的参数，解析出来的 req_info 是加密数据，需解密 // req：*http.Request // ctx.Request 是 gin 框架的获取 *http.Request // ctx.Request() 是 echo 框架的获取 *http.Request // 返回参数 notifyReq：通知的参数 // 返回参数 err：错误信息 notifyReq, err := wechat.ParseNotifyToBodyMap(c.Request) 或 notifyReq, err := wechat.ParseRefundNotify(c.Request) // ==解密退款异步通知的加密参数 req_info == refundNotify, err := wechat.DecryptRefundNotifyReqInfo(notifyReq.ReqInfo, apiKey) // ==异步通知，返回给微信平台的信息== rsp := new(wechat.NotifyResponse) // 回复微信的数据 rsp.ReturnCode = gopay.SUCCESS rsp.ReturnMsg = gopay.OK // 此写法是 gin 框架返回微信的写法 c.String(http.StatusOK, "%s", rsp.ToXmlString()) // 此写法是 echo 框架返回微信的写法 return c.String(http.StatusOK, rsp.ToXmlString()) ``` ### 5、公共API（仅部分说明） --- ## 附录： ### 微信支付v2 API * 统一下单：`client.UnifiedOrder()` * JSAPI - JSAPI支付（或小程序支付） * NATIVE - Native支付 * APP - app支付 * MWEB - H5支付 * 提交付款码支付：`client.Micropay()` * 查询订单：`client.QueryOrder()` * 关闭订单：`client.CloseOrder()` * 撤销订单：`client.Reverse()` * 申请退款：`client.Refund()` * 查询退款：`client.QueryRefund()` * 下载对账单：`client.DownloadBill()` * 下载资金账单（正式）：`client.DownloadFundFlow()` * 交易保障：`client.Report()` * 拉取订单评价数据（正式）：`client.BatchQueryComment()` * 企业付款（正式）：`client.Transfer()` * 查询企业付款（正式）：`client.GetTransferInfo()` * 授权码查询OpenId（正式）：`client.AuthCodeToOpenId()` * 公众号纯签约（正式）：`client.EntrustPublic()` * APP纯签约-预签约接口-获取预签约ID（正式）：`client.EntrustAppPre()` * H5纯签约（正式）：`client.EntrustH5()` * 支付中签约（正式）：`client.EntrustPaying()` * 请求单次分账（正式）：`client.ProfitSharing()` * 请求多次分账（正式）：`client.MultiProfitSharing()` * 查询分账结果（正式）：`client.ProfitSharingQuery()` * 查询订单待分账金额 （正式）：`client.ProfitSharingOrderAmountQuery()` * 查询最大分账比例 （正式）：`client.ProfitSharingMerchantRatioQuery()` * 添加分账接收方（正式）：`client.ProfitSharingAddReceiver()` * 删除分账接收方（正式）：`client.ProfitSharingRemoveReceiver()` * 完结分账（正式）：`client.ProfitSharingFinish()` * 分账回退（正式）：`client.ProfitSharingReturn()` * 分账回退结果查询（正式）：`client.ProfitSharingReturnQuery()` * 企业付款到银行卡API（正式）：`client.PayBank()` * 查询企业付款到银行卡API（正式）：`client.QueryBank()` * 获取RSA加密公钥API（正式）：`client.GetRSAPublicKey()` * 发放现金红包：`client.SendCashRed()` * 发放现金裂变红包：`client.SendGroupCashRed()` * 发放小程序红包：`client.SendAppletRed()` * 查询红包记录：`client.QueryRedRecord()` * 订单附加信息提交（海关）：`client.CustomsDeclareOrder()` * 订单附加信息查询（海关）：`client.CustomsDeclareQuery()` * 订单附加信息重推（海关）：`client.CustomsReDeclareOrder()` * 自定义方法请求微信API接口：`client.PostWeChatAPISelf()` ### 微信公共v2 API * `wechat.GetParamSign()` => 获取微信支付所需参数里的Sign值（通过支付参数计算Sign值） * `wechat.GetSanBoxParamSign()` => 获取微信支付沙箱环境所需参数里的Sign值（通过支付参数计算Sign值） * `wechat.GetMiniPaySign()` => 获取微信小程序支付所需要的paySign * `wechat.GetH5PaySign()` => 获取微信内H5支付所需要的paySign * `wechat.GetAppPaySign()` => 获取APP支付所需要的paySign * `wechat.ParseNotifyToBodyMap()` => 解析微信支付异步通知的参数到BodyMap * `wechat.ParseNotify()` => 解析微信支付异步通知的参数 * `wechat.ParseRefundNotify()` => 解析微信退款异步通知的参数 * `wechat.VerifySign()` => 微信同步返回参数验签或异步通知参数验签 * `wechat.GetOpenIdByAuthCode()` => 授权码查询openid * `wechat.GetOauth2AccessToken()` => 微信第三方登录，code 换取 access_token * `wechat.RefreshOauth2AccessToken()` => 刷新微信第三方登录后，获取到的 access_token * `wechat.CheckOauth2AccessToken()` => 检验授权凭证（access_token）是否有效 * `wechat.DecryptRefundNotifyReqInfo()` => 解密微信退款异步通知的加密数据 --- METRICS --- - Files Extracted: 11 - Estimated Token Budget: ~15749 tokens - Recency Window: Active (< 180 days) - Canonical Reference: https://codewiki.google/github.com/go-pay/gopay