支付宝

因支付宝接口太多，如没实现的接口，还请开发者自行调用 client.PostAliPayAPISelfV2()方法实现！请参考 client_test.go 内的 TestClient_PostAliPayAPISelfV2() 方法

希望有时间的伙伴儿Fork完后，补充并提交Pull Request，一起完善支付宝各个类别下的接口到相应的go文件中

1、初始化支付宝客户端并做配置

具体API使用介绍，请参考 gopay/alipay/client_test.go

  1. import (
  2.     "github.com/go-pay/gopay/alipay"
  3.     "github.com/go-pay/gopay/pkg/xlog"
  4. )
  6. // 初始化支付宝客户端
  7. //    appid：应用ID
  8. //    privateKey：应用私钥，支持PKCS1和PKCS8
  9. //    isProd：是否是正式环境
  10. client, err := alipay.NewClient("2016091200494382", privateKey, false)
  11. if err != nil {
  12.     xlog.Error(err)
  13.     return
  14. }
  15. // 打开Debug开关，输出日志，默认关闭
  16. client.DebugSwitch = gopay.DebugOn
  18. // 设置支付宝请求 公共参数
  19. //    注意：具体设置哪些参数，根据不同的方法而不同，此处列举出所有设置参数
  20. client.SetLocation(alipay.LocationShanghai).    // 设置时区，不设置或出错均为默认服务器时间
  21.     SetCharset(alipay.UTF8).                    // 设置字符编码，不设置默认 utf-8
  22.     SetSignType(alipay.RSA2).                   // 设置签名类型，不设置默认 RSA2
  23.     SetReturnUrl("https://www.fmm.ink").        // 设置返回URL
  24.     SetNotifyUrl("https://www.fmm.ink").        // 设置异步通知URL
  25.     SetAppAuthToken()                           // 设置第三方应用授权
  27. // 自动同步验签（只支持证书模式）
  28. // 传入 alipayCertPublicKey_RSA2.crt 内容
  29. client.AutoVerifySign([]byte("alipayCertPublicKey_RSA2 bytes"))
  31. // 公钥证书模式，需要传入证书，以下两种方式二选一
  32. // 证书路径
  33. err := client.SetCertSnByPath("appCertPublicKey.crt", "alipayRootCert.crt", "alipayCertPublicKey_RSA2.crt")
  34. // 证书内容
  35. err := client.SetCertSnByContent("appCertPublicKey bytes", "alipayRootCert bytes", "alipayCertPublicKey_RSA2 bytes")

2、API 方法调用及入参

具体参数请根据不同接口查看：支付宝支付API接口文档

业务错误处理：当 err != nil 时，可通过 alipay.IsBizError() 捕获业务错误状态码和说明。 不在乎 BizError 的可忽略统一判错处理

  • 统一收单交易支付接口 - 示例
  1. import (
  2.     "github.com/go-pay/gopay"
  3. )
  5. // 初始化 BodyMap
  6. bm := make(gopay.BodyMap)
  7. bm.Set("subject", "条码支付").
  8.     Set("scene", "bar_code").
  9.     Set("auth_code", "286248566432274952").
  10.     Set("out_trade_no", "GZ201909081743431443").
  11.     Set("total_amount", "0.01").
  12.     Set("timeout_express", "2m")
  14. aliRsp, err := client.TradePay(bm)
  15. if err != nil {
  16.     if bizErr, ok := alipay.IsBizError(err); ok {
  17.         xlog.Errorf("%+v", bizErr)
  18.         // do something
  19.         return
  20.     }
  21.     xlog.Errorf("client.TradePay(%+v),err:%+v", bm, err)
  22.     return
  23. }

3、同步返回参数验签Sign、异步通知参数解析和验签Sign、异步通知返回

异步通知请求参数需要先解析，解析出来的结构体或BodyMap再验签（此处需要注意，http.Request.Body 只能解析一次，如果需要解析前调试，请处理好Body复用问题）

Gin Web框架（推荐）

Echo Web框架

注意：APP支付、手机网站支付、电脑网站支付 不支持同步返回验签

支付宝支付后的同步/异步通知验签文档：支付结果通知

  • 同步返回验签，手动验签（如已开启自动验签，则无需手动验签操作）
  1. import (
  2.     "github.com/go-pay/gopay/alipay"
  3. )
  5. aliRsp, err := client.TradePay(bm)
  6. if err != nil {
  7.     xlog.Error("err:", err)
  8.     return
  9. }
  11. // 公钥模式验签
  12. //    注意：APP支付，手机网站支付，电脑网站支付 不支持同步返回验签
  13. //    aliPayPublicKey：支付宝平台获取的支付宝公钥
  14. //    signData：待验签参数，aliRsp.SignData
  15. //    sign：待验签sign，aliRsp.Sign
  16. ok, err := alipay.VerifySyncSign(aliPayPublicKey, aliRsp.SignData, aliRsp.Sign)
  18. // 公钥证书模式验签
  19. //    aliPayPublicKeyCert：支付宝公钥证书存放路径 alipayCertPublicKey_RSA2.crt 或文件内容[]byte
  20. //    signData：待验签参数，aliRsp.SignData
  21. //    sign：待验签sign，aliRsp.Sign
  22. ok, err := alipay.VerifySyncSignWithCert(aliPayPublicKeyCert, aliRsp.SignData, aliRsp.Sign)
  • 异步通知验签
  1. import (
  2.     "github.com/go-pay/gopay/alipay"
  3. )
  5. // 解析异步通知的参数
  6. //    req：*http.Request
  7. notifyReq, err = alipay.ParseNotifyToBodyMap(c.Request)     // c.Request 是 gin 框架的写法
  8. if err != nil {
  9.     xlog.Error(err)
  10.     return
  11. }
  12.  或
  13. //    value：url.Values
  14. notifyReq, err = alipay.ParseNotifyByURLValues()
  15. if err != nil {
  16.     xlog.Error(err)
  17.     return
  18. }
  20. // 支付宝异步通知验签（公钥模式）
  21. ok, err = alipay.VerifySign(aliPayPublicKey, notifyReq)
  23. // 支付宝异步通知验签（公钥证书模式）
  24. ok, err = alipay.VerifySignWithCert("alipayCertPublicKey_RSA2.crt content", notifyReq)
  26. // 如果需要，可将 BodyMap 内数据，Unmarshal 到指定结构体指针 ptr
  27. err = notifyReq.Unmarshal(ptr)
  29. // ====异步通知，返回支付宝平台的信息====
  30. //    文档：https://opendocs.alipay.com/open/203/105286
  31. //    程序执行完后必须打印输出“success”（不包含引号）。如果商户反馈给支付宝的字符不是success这7个字符，支付宝服务器会不断重发通知，直到超过24小时22分钟。一般情况下，25小时以内完成8次通知（通知的间隔频率一般是：4m,10m,10m,1h,2h,6h,15h）
  33. // 此写法是 gin 框架返回支付宝的写法
  34. c.String(http.StatusOK, "%s", "success")
  36. // 此写法是 echo 框架返回支付宝的写法
  37. return c.String(http.StatusOK, "success")

4、支付宝 公共API（仅部分说明）

支付宝换取授权访问令牌文档：换取授权访问令牌

支付宝小程序 获取用户手机号文档：获取用户手机号

支付宝加解密文档：AES加解密文档

  1. import (
  2.     "github.com/go-pay/gopay/alipay"
  3.     "github.com/go-pay/gopay/pkg/xlog"
  4. )
  6. // 换取授权访问令牌（默认使用utf-8，RSA2）
  7. //    appId：应用ID
  8. //    privateKey：应用私钥，支持PKCS1和PKCS8
  9. //    grantType：值为 authorization_code 时，代表用code换取；值为 refresh_token 时，代表用refresh_token换取，传空默认code换取
  10. //    codeOrToken：支付宝授权码或refresh_token
  11. rsp, err := alipay.SystemOauthToken(appId, privateKey, grantType, codeOrToken)
  12. if err != nil {
  13.     xlog.Error(err)
  14.     return
  15. }
  17. // 解密支付宝开放数据带到指定结构体
  18. //    以小程序获取手机号为例
  19. phone := new(alipay.UserPhone)
  20. // 解密支付宝开放数据
  21. //    encryptedData:包括敏感数据在内的完整用户信息的加密数据
  22. //    secretKey:AES密钥，支付宝管理平台配置
  23. //    beanPtr:需要解析到的结构体指针
  24. err := alipay.DecryptOpenDataToStruct(encryptedData, secretKey, phone)
  25. xlog.Infof("%+v", phone)

附录：

支付宝支付 API

  • 支付宝接口自行实现方法：client.PostAliPayAPISelfV2()
  • 网页&移动应用 - 支付API
    • 统一收单交易支付接口（商家扫用户付款码）：client.TradePay()
    • 统一收单线下交易预创建（用户扫商品收款码）：client.TradePrecreate()
    • APP支付接口2.0（APP支付）：client.TradeAppPay()
    • 手机网站支付接口2.0（手机网站支付）：client.TradeWapPay()
    • 统一收单下单并支付页面接口（电脑网站支付）：client.TradePagePay()
    • 统一收单交易创建接口（小程序支付）：client.TradeCreate()
    • 统一收单线下交易查询: client.TradeQuery()
    • 统一收单交易撤销接口: client.TradeCancel()
    • 统一收单交易关闭接口: client.TradeClose()
    • 统一收单交易退款接口: client.TradeRefund()
    • 统一收单退款页面接口: client.TradePageRefund()
    • 统一收单交易退款查询: client.TradeFastPayRefundQuery()
    • 统一收单交易结算接口: client.TradeOrderSettle()
    • 支付宝订单信息同步接口: client.TradeOrderInfoSync()
    • 花芝轻会员结算申请: 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.AntMerchantShopModify()
    • 蚂蚁店铺创建: client.AntMerchantShopCreate()
    • 蚂蚁店铺创建咨询: client.AntMerchantShopConsult()
    • 商户申请单查询: client.AntMerchantOrderQuery()
    • 店铺查询接口: client.AntMerchantShopQuery()
    • 蚂蚁店铺关闭: client.AntMerchantShopClose()
    • 申请权益发放: client.CommerceBenefitApply()
    • 权益核销: client.CommerceBenefitVerify()
    • 还款账单查询: client.TradeRepaybillQuery()
  • 网页&移动应用 - 资金API
    • 单笔转账接口：client.FundTransUniTransfer()
    • 查询转账订单接口: client.FundTransOrderQuery()
    • 支付宝资金账户资产查询接口：client.FundAccountQuery()
    • 转账业务单据查询接口：client.FundTransCommonQuery()
    • 资金退回接口: client.FundTransRefund()
    • 资金授权冻结接口: client.FundAuthOrderFreeze()
    • 资金授权发码接口: client.FundAuthOrderVoucherCreate()
    • 线上资金授权冻结接口: client:FundAuthOrderAppFreeze()
    • 资金授权解冻接口: client.FundAuthOrderUnfreeze()
    • 资金授权操作查询接口: client.FundAuthOperationDetailQuery()
    • 资金授权撤销接口: client.FundAuthOperationCancel()
    • 批次下单接口: client.FundBatchCreate()
    • 批量转账关单接口: client.FundBatchClose()
    • 批量转账明细查询接口: client.FundBatchDetailQuery()
    • 现金红包无线支付接口: client.FundTransAppPay()
    • 资金收款账号绑定关系查询: client.FundTransPayeeBindQuery()
    • 资金转账页面支付接口: client.FundTransPagePay()
  • 网页&移动应用 - 会员API
    • 支付宝会员授权信息查询接口（App支付宝登录）：client.UserInfoShare()
    • 身份认证初始化服务: client.UserCertifyOpenInit()
    • 身份认证开始认证（获取认证链接）: client.UserCertifyOpenCertify()
    • 身份认证记录查询: client.UserCertifyOpenQuery()
    • 支付宝个人协议页面签约接口: client.UserAgreementPageSign()
    • 支付宝个人代扣协议解约接口: client.UserAgreementPageUnSign()
    • 支付宝个人代扣协议查询接口: client.UserAgreementQuery()
    • 周期性扣款协议执行计划修改接口: client.UserAgreementExecutionplanModify()
    • 协议由普通通用代扣协议产品转移到周期扣协议产品: 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
    • 小程序生成推广二维码接口：client.OpenAppQrcodeCreate()
  • 网页&移动应用 - 工具类API
    • 用户登陆授权：client.UserInfoAuth()
    • 换取授权访问令牌：client.SystemOauthToken()
    • 换取应用授权令牌：client.OpenAuthTokenApp()
    • 应用支付宝公钥证书下载：client.PublicCertDownload()
  • 网页&移动应用 - 芝麻信用API
    • 芝麻企业信用信用评估初始化: client.ZhimaCreditEpSceneRatingInitialize()
    • 信用服务履约同步: client.ZhimaCreditEpSceneFulfillmentSync()
    • 加入信用服务: clinet.ZhimaCreditEpSceneAgreementUse()
    • 取消信用服务: client.ZhimaCreditEpSceneAgreementCancel()
    • 信用服务履约同步(批量): client.ZhimaCreditEpSceneFulfillmentlistSync()
    • 芝麻go用户数据回传: client.ZhimaCreditPeZmgoCumulationSync()
    • 商家芝麻GO累计数据回传接口: client.ZhimaMerchantZmgoCumulateSync()
    • 商家芝麻GO累计数据查询接口: client.ZhimaMerchantZmgoCumulateQuery()
    • 芝麻GO签约关单: client.ZhimaCreditPeZmgoBizoptClose()
    • 芝麻GO结算退款接口: client.ZhimaCreditPeZmgoSettleRefund()
    • 芝麻GO签约预创单: client.ZhimaCreditPeZmgoPreorderCreate()
    • 芝麻GO协议解约: client.ZhimaCreditPeZmgoAgreementUnsign()
    • 芝麻Go协议查询接口: client.ZhimaCreditPeZmgoAgreementQuery()
    • 芝麻Go解冻接口: client.ZhimaCreditPeZmgoSettleUnfreeze()
    • 芝麻GO支付下单链路签约申请: client.ZhimaCreditPeZmgoPaysignApply()
    • 芝麻GO支付下单链路签约确认: client.ZhimaCreditPeZmgoPaysignConfirm()
    • 职得工作证信息匹配度查询: client.ZhimaCustomerJobworthAdapterQuery()
    • 职得工作证外部渠道应用数据回流: client.ZhimaCustomerJobworthSceneUse()
  • 网页&移动应用 - 财务API
    • 支付宝商家账户当前余额查询：client.DataBillBalanceQuery()（失效）
    • 查询对账单下载地址：client.DataBillDownloadUrlQuery()
  • 网页&移动应用 - 海关相关API
    • 统一收单报关接口：client.TradeCustomsDeclare()
    • 报关接口：client.AcquireCustoms()
    • 报关查询接口：client.AcquireCustomsQuery()

支付宝公共 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() => 验签接口