Bank | @sigodenjs/wechatpay

企业付款

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

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

Hierarchy

Base
- Bank

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Bank(options: ConstructorOptions): Bank

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

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

getPublicKey

getPublicKey(options: GetPublicKeyOptions): Promise<GetPublicKeyResponseSuccess & SuccessReturn | GetPublicKeyResponseFail & FailReturn>

- Defined in pays/Bank.ts:128
获取RSA加密公钥
```
pay.getPublicKey({
 sign_type: SignType.MD5
});
```
Parameters
- options: GetPublicKeyOptions
Returns Promise<GetPublicKeyResponseSuccess & SuccessReturn | GetPublicKeyResponseFail & FailReturn>

getTransferInfo

getTransferInfo(options: GetTransferInfoOptions): Promise<GetTransferInfoResponseSuccess & SuccessReturn | GetTransferInfoResponseFail & FailReturn>

- Defined in pays/Bank.ts:62
查询企业付款到零钱
```
pay.getTransferInfo({
  partner_trade_no: "10000098201411111234567890"
});
```
see

https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=14_3
Parameters
- options: GetTransferInfoOptions
Returns Promise<GetTransferInfoResponseSuccess & SuccessReturn | GetTransferInfoResponseFail & FailReturn>

payBank

payBank(options: PayBankOptions): Promise<PayBankResponseSuccess & SuccessReturn | PayBankResponseFail & FailReturn>

企业付款到银行卡

pay.payBank({
  partner_trade_no: "1212121221227",
  enc_bank_no: utils.rsa(pemKey, "6225760017946512"),
  enc_true_name: utils.rsa(pemKey, "王小王"),
  bank_code: "1001",
  amount: 100,
  desc: "理财"
});
// pemKey 通过 `pay.getPublicKey` 获取

see: https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=24_2

Parameters

options: PayBankOptions

Returns Promise<PayBankResponseSuccess & SuccessReturn | PayBankResponseFail & FailReturn>

queryBank

queryBank(options: QueryBankOptions): Promise<QueryBankResponseSuccess & SuccessReturn | QueryBankResponseFail & FailReturn>

- Defined in pays/Bank.ts:108
查询企业付款到银行卡
```
pay.queryBank({
  partner_trade_no: "1212121221227"
});
```
see

https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=24_3
Parameters
- options: QueryBankOptions
Returns Promise<QueryBankResponseSuccess & SuccessReturn | QueryBankResponseFail & 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>

transfers

transfers(options: TransfersOptions): Promise<TransfersResponseSuccess & SuccessReturn | TransfersResponseFail & FailReturn>

- Defined in pays/Bank.ts:40
企业付款到零钱
```
pay.transfers({
  partner_trade_no: "10000098201411111234567890",
  openid: "oxTWIuGaIt6gTKsQRLau2M0yL16E",
  check_name: "FORCE_CHECK",
  amount: 10099,
  desc: "理赔",
  spbill_create_ip: "192.168.0.1"
});
```
see

https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=14_2
Parameters
- options: TransfersOptions
Returns Promise<TransfersResponseSuccess & SuccessReturn | TransfersResponseFail & FailReturn>

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 Bank

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

getPublicKey

Parameters

options: GetPublicKeyOptions

Returns Promise<GetPublicKeyResponseSuccess & SuccessReturn | GetPublicKeyResponseFail & FailReturn>

getTransferInfo

Parameters

options: GetTransferInfoOptions

Returns Promise<GetTransferInfoResponseSuccess & SuccessReturn | GetTransferInfoResponseFail & FailReturn>

payBank

Parameters

options: PayBankOptions

Returns Promise<PayBankResponseSuccess & SuccessReturn | PayBankResponseFail & FailReturn>

queryBank

Parameters

options: QueryBankOptions

Returns Promise<QueryBankResponseSuccess & SuccessReturn | QueryBankResponseFail & FailReturn>

setDebug

Parameters

useDebug: boolean

Returns Promise<void>

transfers

Parameters

options: TransfersOptions

Returns Promise<TransfersResponseSuccess & SuccessReturn | TransfersResponseFail & FailReturn>

verifySign

Parameters

data: object

sign: string

Default value signType: SignType = types.SignType.MD5

Returns boolean