# wxpay

**Repository Path**: objcoding/wxpay

## Basic Information

- **Project Name**: wxpay
- **Description**: 微信支付 SDK for Golang
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 47
- **Forks**: 8
- **Created**: 2018-08-20
- **Last Updated**: 2023-07-08

## Categories & Tags

**Categories**: payment-dev

**Tags**: None

## README

# wxpay 

![Powered by zch](https://img.shields.io/badge/Powered%20by-zch-blue.svg?style=flat-square) ![Language](https://img.shields.io/badge/language-Go-orange.svg) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)

**GitHub地址：[wxpay](https://github.com/objcoding/wxpay)**

wxpay 提供了以下的方法：

| 方法名              | 说明          |
| ---------------- | ----------- |
| MicroPay         | 刷卡支付        |
| UnifiedOrder     | 统一下单        |
| OrderQuery       | 查询订单        |
| Reverse          | 撤销订单        |
| CloseOrder       | 关闭订单        |
| Refund           | 申请退款        |
| RefundQuery      | 查询退款        |
| DownloadBill     | 下载对账单       |
| Report           | 交易保障        |
| ShortUrl         | 转换短链接       |
| AuthCodeToOpenid | 授权码查询openid |

* 参数为`Params`类型，返回类型也是`Params`，`Params` 是一个 map[string]string 类型。
* 方法内部会将参数会转换成含有`appid`、`mch_id`、`nonce_str`、`sign_type`和`sign`的XML；
* 默认使用MD5进行签名；
* 通过HTTPS请求得到返回数据后会对其做必要的处理（例如验证签名，签名错误则抛出异常）。
* 对于DownloadBill，无论是否成功都返回Map，且都含有`return_code`和`return_msg`。若成功，其中`return_code`为`SUCCESS`，另外`data`对应对账单数据。


## 安装

```bash
$ go get github.com/objcoding/wxpay

```

## go modules
```cgo
// go.mod
require github.com/objcoding/wxpay v1.0.3

```


## 示例

```cgo
// 创建支付账户
account1 := wxpay.NewAccount("appid", "mchid", "apiKey", false)
account2 := wxpay.NewAccount("appid", "mchid", "apiKey", false)

// 新建微信支付客户端
client := wxpay.NewClient(account1)

// 设置证书
account.SetCertData("证书地址")

// 设置支付账户
client.setAccount(account2)

// 设置http请求超时时间
client.SetHttpConnectTimeoutMs(2000)

// 设置http读取信息流超时时间
client.SetHttpReadTimeoutMs(1000)

// 更改签名类型
client.SetSignType(HMACSHA256)

```

```cgo
// 统一下单
params := make(wxpay.Params)
params.SetString("body", "test").
		SetString("out_trade_no", "436577857").
		SetInt64("total_fee", 1).
		SetString("spbill_create_ip", "127.0.0.1").
		SetString("notify_url", "http://notify.objcoding.com/notify").
		SetString("trade_type", "APP")
p, _ := client.UnifiedOrder(params)

// 订单查询
params := make(wxpay.Params)
params.SetString("out_trade_no", "3568785")
p, _ := client.OrderQuery(params)

// 退款
params := make(wxpay.Params)
params.SetString("out_trade_no", "3568785").
		SetString("out_refund_no", "19374568").
		SetInt64("total_fee", 1).
		SetInt64("refund_fee", 1)
p, _ := client.Refund(params)

// 退款查询
params := make(wxpay.Params)
params.SetString("out_refund_no", "3568785")
p, _ := client.RefundQuery(params)

```


```cgo
// 签名
signStr := client.Sign(params)

// 校验签名
b := client.ValidSign(params)

```

```cgo
// xml解析
params := wxpay.XmlToMap(xmlStr)

// map封装xml请求参数
b := wxpay.MapToXml(params)

```

```cgo
// 支付或退款返回成功信息
return wxpay.Notifies{}.OK()

// 支付或退款返回失败信息
return wxpay.Notifies{}.NotOK("支付失败或退款失败了")

```


## License
MIT license