Coupon | @sigodenjs/wechatpay

代金券

const pay = new Coupon({
  appId: "wxb80e5bddb2d804f3",
  key: "6Q9VX4N3WTBM9G9XBL7H1L9PB9ANHLY7",
  mchId: "1434712502",
  pfx: fs.readFileSync(path.resolve(__dirname, "cert.p12"))
});

see: https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_1

Hierarchy

Base
- Coupon

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Coupon(options: ConstructorOptions): Coupon

Inherited from Base.constructor
- Defined in pays/core/Base.ts:37
Parameters
- options: ConstructorOptions
Returns Coupon

Properties

appId

appId: string

公众账号ID

debug

debug: boolean = false

仿真模式开关

key

key: string

密钥

keyForDebug

keyForDebug: string

测试用验签密钥

mchId

mchId: string

商户号

pfx

pfx: Buffer

证书

Methods

Protected completeURL

completeURL(base: string): string

Inherited from Base.completeURL
- Defined in pays/core/Base.ts:107
拼接路径

Parameters
- base: string
Returns string

Protected createFetchOptions

createFetchOptions(url: string, usePfx?: boolean): Promise<FetchOptions>

Inherited from Base.createFetchOptions
- Defined in pays/core/Base.ts:89
生成 FetchOptions 数据

Parameters
- url: string
- Default value usePfx: boolean = false
Returns Promise<FetchOptions>

Protected getKey

getKey(): string

Inherited from Base.getKey
- Defined in pays/core/Base.ts:117
获取私钥

Returns string

- Defined in pays/Coupon.ts:36
发放代金券
```
pay.sendCoupon({
  coupon_stock_id: "1757",
  openid_count: 1,
  partner_trade_no: "1000009820141203515766",
  openid: "onqOjjrXT-776SpHnfexGm1_P7iE"
});
```
see

https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=12_3&index=4
Parameters
- options: SendCouponOptions
Returns Promise<SendCouponResponseSuccess & SuccessReturn | SendCouponResponseFail & FailReturn>

setDebug

setDebug(useDebug: boolean): Promise<void>

Inherited from Base.setDebug
- Defined in pays/core/Base.ts:51
仿真模式开关

see

https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=23_1

Parameters
- useDebug: boolean
Returns Promise<void>

verifySign

verifySign(data: object, signType?: SignType): boolean

Inherited from Base.verifySign
- Defined in pays/core/Base.ts:78
校验 sign

Parameters
- data: object
  - sign: string
- Default value signType: SignType = types.SignType.MD5
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ConstructorOptions

Returns Coupon

Properties

appId

debug

key

keyForDebug

mchId

pfx

Methods

Protected completeURL

Parameters

base: string

Returns string

Protected createFetchOptions

Parameters

url: string

Default value usePfx: boolean = false

Returns Promise<FetchOptions>

Protected getKey

Returns string

queryCouponStock

Parameters

options: QueryCouponStockOptions

Returns Promise<QueryCouponStockResponseSuccess & SuccessReturn | QueryCouponStockResponseFail & FailReturn>

queryCouponsInfo

Parameters

options: QueryCouponsInfoOptions

Returns Promise<QueryCouponsInfoResponseSuccess & SuccessReturn | QueryCouponsInfoResponseFail & FailReturn>

sendCoupon

Parameters

options: SendCouponOptions

Returns Promise<SendCouponResponseSuccess & SuccessReturn | SendCouponResponseFail & FailReturn>

setDebug

Parameters

useDebug: boolean

Returns Promise<void>

verifySign

Parameters

data: object

sign: string

Default value signType: SignType = types.SignType.MD5

Returns boolean