WeChat Pay OpenAPI SDK for NodeJS

https://wechatpay.js.org/
Admin
This project provides comprehensive documentation for the WeChat Pay OpenAPI SDK for NodeJS,...
Tokens:280,511
Snippets:1,654
Trust Score:8.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET v3/marketing/favor/stocks

Source: https://wechatpay.js.org/openapi/v3/marketing/favor/stocks

查询多个批次的信息，包括批次的配置信息以及批次概况数据。

```APIDOC
## GET v3/marketing/favor/stocks

### Description
通过此接口可查询多个批次的信息，包括批次的配置信息以及批次概况数据。

### Method
GET

### Endpoint
v3/marketing/favor/stocks

### Response
#### Success Response (200)
- **total_count** (integer) - 批次总数
- **limit** (integer) - 分页大小
- **offset** (integer) - 分页偏移量
- **data** (array) - 批次数据列表

#### Response Example
{
  "total_count": 10,
  "limit": 10,
  "offset": 0,
  "data": []
}
```

--------------------------------

### GET /v3/hire-power-bank/user-qualifications/{openid}

Source: https://wechatpay.js.org/openapi/v3/hire-power-bank/user-qualifications/%7Bopenid%7D

查询用户保险订单领取资格的SDK调用方法。

```APIDOC
## GET /v3/hire-power-bank/user-qualifications/{openid}

### Description
商户通过该接口查询用户保险订单领取资格。

### Parameters
#### Path Parameters
- **openid** (string) - Required - 用户的唯一标识

### Response
#### Success Response (200)
- **qualified_user** (boolean) - 用户是否具有领取资格

### Request Example
```javascript
wxpay.v3.hirePowerBank.userQualifications._openid_.get({
  openid: 'example_openid'
})
```
```

--------------------------------

### GET /v3/profitsharing/merchant-configs/{sub_mchid}

Source: https://wechatpay.js.org/openapi/v3/profitsharing/merchant-configs/%7Bsub_mchid%7D

查询特约商户设置的允许服务商分账的最大比例。

```APIDOC
## GET /v3/profitsharing/merchant-configs/{sub_mchid}

### Description
查询特约商户设置的允许服务商分账的最大比例。

### Method
GET

### Endpoint
/v3/profitsharing/merchant-configs/{sub_mchid}

### Parameters
#### Path Parameters
- **sub_mchid** (string) - Required - 特约商户号

### Response
#### Success Response (200)
- **sub_mchid** (string) - 特约商户号
- **max_ratio** (integer) - 最大分账比例
```

--------------------------------

### GET v3/pay/partner/transactions/out-trade-no/{out_trade_no}

Source: https://wechatpay.js.org/openapi/v3/pay/partner/transactions/out-trade-no/%7Bout_trade_no%7D

通过商户订单号查询订单状态的SDK调用方法。

```APIDOC
## GET v3/pay/partner/transactions/out-trade-no/{out_trade_no}

### Description
通过商户订单号查询订单状态。适用于商户后台未接收到支付通知、返回系统错误或需要确认支付状态的场景。

### Method
GET

### Endpoint
v3/pay/partner/transactions/out-trade-no/{out_trade_no}

### Parameters
#### Path Parameters
- **out_trade_no** (string) - Required - 商户订单号

#### Query Parameters
- **sp_mchid** (string) - Required - 服务商商户号
- **sub_mchid** (string) - Required - 子商户号

### Request Example
```javascript
wxpay.v3.pay.partner.transactions.outTradeNo._out_trade_no_.get({
  out_trade_no: '123456789',
  params: { 
    sp_mchid: '1234567890', 
    sub_mchid: '0987654321' 
  }
}).then(({ data }) => data)
```
```

--------------------------------

### POST /v3/smartguide/guides/{guide_id}/assign

Source: https://wechatpay.js.org/openapi/v3/smartguide/guides/%7Bguide_id%7D/assign

为指定的订单分配服务人员。

```APIDOC
## POST /v3/smartguide/guides/{guide_id}/assign

### Description
用于服务商/商户开发者在顾客下单后为顾客分配服务人员使用。

### Method
POST

### Endpoint
/v3/smartguide/guides/{guide_id}/assign

### Parameters
#### Path Parameters
- **guide_id** (string) - Required - 服务人员ID

#### Request Body
- **sub_mchid** (string) - Required - 子商户号
- **out_trade_no** (string) - Required - 商户订单号

### Response
#### Success Response (204)
- **status** (number) - 状态码，204表示分配成功
```

--------------------------------

### Execute API Request via CLI

Source: https://wechatpay.js.org/guide

Example of executing a GET request to the ecommerce applyments endpoint using the CLI tool.

```bash
./my-cli.sh v3.ecommerce.applyments.2000004250058765 -m get
```

--------------------------------

### GET v3/vehicle/parking/services/find

Source: https://wechatpay.js.org/openapi/v3/vehicle/parking/services/find

查询车牌服务开通信息接口，用于确认车牌是否被用户开通车主服务。

```APIDOC
## GET v3/vehicle/parking/services/find

### Description
该接口用于查询车牌服务开通信息，确认该车牌是否被该用户开通车主服务。

### Method
GET

### Endpoint
v3/vehicle/parking/services/find

### Response
#### Success Response (200)
- **plate_number** (string) - 车牌号
- **service_open_time** (string) - 服务开通时间
- **openid** (string) - 用户唯一标识
- **service_state** (string) - 服务状态
```

--------------------------------

### POST /v3/marketing/favor/stocks/{stock_id}/start

Source: https://wechatpay.js.org/openapi/v3/marketing/favor/stocks/%7Bstock_id%7D/start

激活代金券批次接口，用于启动已创建的批次并锁定相关资金。

```APIDOC
## POST /v3/marketing/favor/stocks/{stock_id}/start

### Description
制券成功后，通过调用此接口激活批次。如果是预充值代金券，激活时会从商户账户余额中锁定本批次的营销资金。

### Method
POST

### Endpoint
/v3/marketing/favor/stocks/{stock_id}/start

### Parameters
#### Path Parameters
- **stock_id** (string) - Required - 代金券批次ID

#### Request Body
- **stock_creator_mchid** (string) - Required - 创建批次的商户号

### Response
#### Success Response (200)
- **start_time** (string) - 批次激活时间
- **stock_id** (string) - 代金券批次ID
```

--------------------------------

### GET /v3/payscore/serviceorder

Source: https://wechatpay.js.org/openapi/v3/payscore/serviceorder

用于查询单笔微信支付分订单的详细信息。

```APIDOC
## GET /v3/payscore/serviceorder

### Description
用于查询单笔微信支付分订单的详细信息。

### Method
GET

### Query Parameters
- **params** - 查询参数

### Response
#### Success Response (200)
- **out_order_no** - 商户订单号
- **appid** - 应用ID
- **service_id** - 服务ID
- **post_payments** - 后付费项目
- **post_discounts** - 后付费优惠
- **time_range** - 服务时间范围
- **location** - 服务位置
- **service_introduction** - 服务介绍
- **risk_fund** - 风险金
- **attach** - 附加数据
- **notify_url** - 通知地址
- **mchid** - 商户号
- **state** - 订单状态
- **state_description** - 状态描述
- **order_id** - 微信支付分订单号
- **openid** - 用户标识
```

--------------------------------

### POST /v3/payscore/plan/partner/payscore-plans

Source: https://wechatpay.js.org/openapi/v3/payscore/plan/partner/payscore-plans

创建支付分计划的 SDK 调用方法。

```APIDOC
## POST /v3/payscore/plan/partner/payscore-plans

### Description
商户可以基于有按计划确认权限的服务，通过此接口创建支付分计划。

### Request Body
- **service_id** (string) - Required
- **appid** (string) - Required
- **sub_mchid** (string) - Required
- **sub_appid** (string) - Optional
- **plan_name** (string) - Required
- **plan_duration** (integer) - Required
- **deduction_quantity** (integer) - Required
- **total_original_price** (integer) - Required
- **total_actual_price** (integer) - Required
- **plan_detail_list** (array) - Required
- **merchant_plan_no** (string) - Required

### Response
- **plan_id** (string) - 支付分计划ID
- **service_id** (string) - 服务ID
- **mchid** (string) - 商户号
- **sub_mchid** (string) - 子商户号
- **appid** (string) - 公众账号ID
- **sub_appid** (string) - 子商户公众账号ID
- **merchant_plan_no** (string) - 商户计划号
- **plan_name** (string) - 计划名称
- **plan_duration** (integer) - 计划周期
- **plan_state** (string) - 计划状态
- **total_original_price** (integer) - 原价总额
- **deduction_quantity** (integer) - 扣费次数
- **total_actual_price** (integer) - 实付总额
- **plan_detail_list** (array) - 计划明细列表
- **stop_mchid** (string) - 停止商户号
- **stop_time** (string) - 停止时间
```

--------------------------------

### wxpay.v3.platsolution.mchTransfer.batches.summaryReceipts.outBatchNo._out_batch_no_.get

Source: https://wechatpay.js.org/openapi/v3/platsolution/mch-transfer/batches/summary-receipts/out-batch-no/%7Bout_batch_no%7D

查询商家转账批次汇总电子回单受理进度信息，当电子回单文件生成结束后，将返回电子回单文件的hash值、电子回单文件的下载地址等。

```APIDOC
## GET /v3/platsolution/mch-transfer/batches/summary-receipts/out-batch-no/{out_batch_no}

### Description
查询商家转账批次汇总电子回单受理进度信息，当电子回单文件生成结束后，将返回电子回单文件的hash值、电子回单文件的下载地址等。

### Method
GET

### Endpoint
/v3/platsolution/mch-transfer/batches/summary-receipts/out-batch-no/{out_batch_no}

### Parameters
#### Path Parameters
- **out_batch_no** (string) - Required - 商家转账批次号

### Response
#### Success Response (200)
- **batch_id** (string) - 微信批次单号
- **out_batch_no** (string) - 商家转账批次号
- **sub_mchid** (string) - 子商户号
- **receipt_state** (string) - 电子回单状态
- **hash_type** (string) - 哈希类型
- **hash_value** (string) - 哈希值
- **download_url** (string) - 电子回单下载地址
```

--------------------------------

### GET /invoicing/fapiao/fapiao-file

Source: https://wechatpay.js.org/openapi/v3/new-tax-control-fapiao/download

下载发票文件接口，通过GET请求获取发票文件流。

```APIDOC
## GET /invoicing/fapiao/fapiao-file

### Description
调用此接口下载发票文件。该接口不支持签名和验签。

### Method
GET

### Endpoint
/invoicing/fapiao/fapiao-file

### Request Example
```javascript
const axios = require('axios')
const { createWriteStream } = require('fs')

axios.get('/invoicing/fapiao/fapiao-file', {
  baseURL,
  params,
  responseType,
  transformResponse: [],
})
.then(({ data, headers: { 'sm3-digest': sm3DigestString } }) => {
  data.pipe(createWriteStream('./downloaded.pdf'))
})
```
```

--------------------------------

### 扣费受理接口调用

Source: https://wechatpay.js.org/openapi/v3/qrcode/transactions

使用微信支付SDK发起扣费受理请求，并处理返回的订单数据。

```javascript
wxpay.v3.qrcode.transactions.post({
  appid,
  sub_appid,
  sub_mchid,
  description,
  attach,
  out_trade_no,
  trade_scene,
  goods_tag,
  contract_id,
  notify_url,
  amount,
  bus_info,
  metro_info,
}).then(({ data: { appid, sub_appid, sp_mchid, sub_mchid, description, create_time, out_trade_no, transaction_id, trade_state, trade_state_description, success_time, bank_type, user_repay_state, repay_transaction_id, repay_time, attach, contract_id, trade_scene, bus_info, metro_info, amount, promotion_detail, }, }) => ({ appid, sub_appid, sp_mchid, sub_mchid, description, create_time, out_trade_no, transaction_id, trade_state, trade_state_description, success_time, bank_type, user_repay_state, repay_transaction_id, repay_time, attach, contract_id, trade_scene, bus_info, metro_info, amount, promotion_detail, }))
```

--------------------------------

### GET /v3/marketing/membercard-open/phonenumber-member/search

Source: https://wechatpay.js.org/openapi/v3/marketing/membercard-open/phonenumber-member/search

查询导入成功的加密手机号是否已被用户领取。

```APIDOC
## GET /v3/marketing/membercard-open/phonenumber-member/search

### Description
商户可查询导入成功的加密手机号是否已被用户领取。

### Method
GET

### Endpoint
/v3/marketing/membercard-open/phonenumber-member/search

### Response
#### Success Response (200)
- **user_card_information** (object) - 用户的会员卡信息
```

--------------------------------

### wxpay.v3.discountCard.cards.post

Source: https://wechatpay.js.org/openapi/v3/discount-card/cards

Initiates a pre-acceptance request for a discount card to obtain a prepare_card_token.

```APIDOC
## POST wxpay.v3.discountCard.cards

### Description
Requests a pre-acceptance token for a discount card, which is required before guiding a user to the card collection page.

### Parameters
- **out_card_code** (string) - Required - The merchant's unique card code.
- **card_template_id** (string) - Required - The ID of the card template.
- **appid** (string) - Required - The application ID.
- **notify_url** (string) - Required - The notification URL for card events.

### Response
- **prepare_card_token** (string) - The token used to proceed with the card collection flow.
```

--------------------------------

### GET /v3/marketing/busifavor/subsidy/pay-receipts

Source: https://wechatpay.js.org/openapi/v3/marketing/busifavor/subsidy/pay-receipts

查询商家券营销补差付款单列表。

```APIDOC
## GET /v3/marketing/busifavor/subsidy/pay-receipts

### Description
查询商家券营销补差付款单列表。

### Parameters
#### Query Parameters
- **params** (object) - 查询参数

### Response
- **pay_receipt_list** (array) - 补差付款单列表
```

--------------------------------

### wxpay.v3.applyment4sub.applyment.post

Source: https://wechatpay.js.org/openapi/v3/applyment4sub/applyment

提交商家入驻申请单的SDK方法。

```APIDOC
## POST wxpay.v3.applyment4sub.applyment

### Description
普通服务商使用该接口提交商家资料，帮助商家入驻成为微信支付的特约商户。

### Parameters
- **business_code** (string) - 业务申请编号
- **contact_info** (object) - 超级管理员信息
- **subject_info** (object) - 主体资料
- **business_info** (object) - 经营场景资料
- **settlement_info** (object) - 结算规则
- **bank_account_info** (object) - 结算银行账户
- **addition_info** (object) - 补充材料

### Response
- **applyment_id** (string) - 申请单编号
```

--------------------------------

### wxpay.v3.combineTransactions.outTradeNo.get

Source: https://wechatpay.js.org/openapi/v3/combine-transactions/out-trade-no/%7Bcombine_out_trade_no%7D

查询合单订单状态的SDK方法。

```APIDOC
## GET /v3/combine-transactions/out-trade-no/{combine_out_trade_no}

### Description
电商平台通过合单查询订单API查询订单状态，完成下一步的业务逻辑。

### Method
GET

### Endpoint
/v3/combine-transactions/out-trade-no/{combine_out_trade_no}

### Parameters
#### Path Parameters
- **combine_out_trade_no** (string) - Required - 合单商户订单号

### Response
#### Success Response (200)
- **combine_appid** (string) - 合单发起方的appid
- **combine_mchid** (string) - 合单发起方商户号
- **combine_out_trade_no** (string) - 合单商户订单号
- **scene_info** (object) - 场景信息
- **sub_orders** (array) - 子单信息
- **combine_payer_info** (object) - 支付者信息
```

--------------------------------

### GET /v3/certificates

Source: https://wechatpay.js.org/openapi/v3/certificates

获取商户当前可用的平台证书列表。

```APIDOC
## GET /v3/certificates

### Description
获取商户当前可用的平台证书列表，帮助商户后台系统实现平台证书的平滑更换。

### Method
GET

### Endpoint
/v3/certificates

### Request Example
```javascript
wxpay.v3.certificates.get({ params })
```

### Response
#### Success Response (200)
- **data** (array) - 证书列表
  - **effective_time** (string) - 证书生效时间
  - **expire_time** (string) - 证书过期时间
  - **serial_no** (string) - 证书序列号
  - **encrypt_certificate** (object) - 加密证书信息
    - **ciphertext** (string) - 加密内容
    - **nonce** (string) - 随机串
    - **associated_data** (string) - 附加数据
```

--------------------------------

### GET /v3/vehicle/etc/transactions/out-trade-no/{out_trade_no}

Source: https://wechatpay.js.org/openapi/v3/vehicle/etc/transactions/out-trade-no/%7Bout_trade_no%7D

通过商户订单号查询ETC交易订单详情。

```APIDOC
## GET /v3/vehicle/etc/transactions/out-trade-no/{out_trade_no}

### Description
查询微信支付ETC交易订单详情，支持通过商户订单号进行检索。

### Method
GET

### Endpoint
/v3/vehicle/etc/transactions/out-trade-no/{out_trade_no}

### Parameters
#### Path Parameters
- **out_trade_no** (string) - Required - 商户订单号

### Response
#### Success Response (200)
- **mchid** (string) - 商户号
- **sub_mchid** (string) - 子商户号
- **appid** (string) - 应用ID
- **sub_appid** (string) - 子应用ID
- **out_trade_no** (string) - 商户订单号
- **transaction_id** (string) - 微信支付订单号
- **attach** (string) - 附加数据
- **trade_type** (string) - 交易类型
- **bank_type** (string) - 付款银行
- **success_time** (string) - 支付完成时间
- **trade_state** (string) - 交易状态
- **trade_state_desc** (string) - 交易状态描述
- **payer** (object) - 支付者信息
- **amount** (object) - 订单金额信息
- **device_info** (object) - 设备信息
- **promotion_detail** (array) - 优惠信息
```

--------------------------------

### wxpay.v3.platsolution.mchTransfer.batches.apply.post

Source: https://wechatpay.js.org/openapi/v3/platsolution/mch-transfer/batches/apply

发起商家转账接口，商户可以通过该接口同时向多个已经确认预约的用户进行转账操作。

```APIDOC
## POST /v3/platsolution/mch-transfer/batches/apply

### Description
发起商家转账接口。商户可以通过该接口同时向多个已经确认预约的用户进行转账操作。

### Parameters
#### Request Body
- **sub_mchid** (string) - Required - 子商户号
- **sp_appid** (string) - Required - 服务商应用ID
- **sub_appid** (string) - Optional - 子商户应用ID
- **out_batch_no** (string) - Required - 商家批次单号
- **batch_name** (string) - Required - 批次名称
- **batch_remark** (string) - Required - 批次备注
- **total_amount** (integer) - Required - 转账总金额
- **total_num** (integer) - Required - 转账总笔数
- **transfer_scene_id** (string) - Required - 转账场景ID
- **transfer_detail_list** (array) - Required - 转账明细列表
- **notify_url** (string) - Optional - 通知地址

### Response
#### Success Response (200)
- **out_batch_no** (string) - 商家批次单号
- **batch_id** (string) - 微信批次单号
- **create_time** (string) - 批次创建时间
- **batch_state** (string) - 批次状态
```

--------------------------------

### GET /v3/vehicle/etc/contracts/{contract_id}

Source: https://wechatpay.js.org/openapi/v3/vehicle/etc/contracts/%7Bcontract_id%7D

通过商户ETC绑定号查询签约状态。

```APIDOC
## GET /v3/vehicle/etc/contracts/{contract_id}

### Description
通过商户ETC绑定号查询签约状态。

### Method
GET

### Endpoint
/v3/vehicle/etc/contracts/{contract_id}

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - 商户ETC绑定号

### Response
#### Success Response (200)
- **appid** (string) - 公众账号ID
- **sp_mchid** (string) - 服务商商户号
- **sp_openid** (string) - 服务商用户标识
- **sub_appid** (string) - 子商户公众账号ID
- **sub_mchid** (string) - 子商户号
- **contract_id** (string) - 商户ETC绑定号
- **bind_state** (string) - 绑定状态
- **plate_number** (string) - 车牌号
- **sub_openid** (string) - 子商户用户标识
```

--------------------------------

### 查询用户会员卡列表

Source: https://wechatpay.js.org/openapi/v3/marketing/membercard-open/user/cards

使用 SDK 的 get 方法获取用户会员卡数据，并解构返回的响应对象。

```javascript
wxpay
.v3
.marketing
.membercardOpen
.user
.cards
.get
({
  params,
})
.then(
  ({ 
    data: {
      data,
      total_count,
      offset,
      limit,
    },
  }) => ({
    data,
    total_count,
    offset,
    limit,
  })
)
```

--------------------------------

### GET /v3/transfer/batches/out-batch-no/{out_batch_no}

Source: https://wechatpay.js.org/openapi/v3/transfer/batches/out-batch-no/%7Bout_batch_no%7D

查询转账批次单及明细单信息。

```APIDOC
## GET /v3/transfer/batches/out-batch-no/{out_batch_no}

### Description
商户可以通过该接口查询转账批次单以及指定状态的转账明细单。

### Method
GET

### Endpoint
/v3/transfer/batches/out-batch-no/{out_batch_no}

### Parameters
#### Path Parameters
- **out_batch_no** (string) - Required - 商家批次单号

#### Query Parameters
- **params** (object) - Optional - 查询参数，用于筛选明细单状态等

### Response
#### Success Response (200)
- **transfer_batch** (object) - 转账批次单信息
- **transfer_detail_list** (array) - 转账明细单列表
- **offset** (integer) - 偏移量
- **limit** (integer) - 最大资源条数
```

--------------------------------

### POST v3/payscore/sign-plan/user-sign-plans

Source: https://wechatpay.js.org/openapi/v3/payscore/sign-plan/user-sign-plans

创建用户的签约计划接口，用于发起用户签约流程。

```APIDOC
## POST v3/payscore/sign-plan/user-sign-plans

### Description
商户通过此接口基于商户已创建且正常进行中的支付分计划，创建用户的签约计划以供用户签约。

### Method
POST

### Endpoint
v3/payscore/sign-plan/user-sign-plans

### Request Body
- **service_id** (string) - Required - 服务ID
- **plan_id** (string) - Required - 支付分计划ID
- **appid** (string) - Required - 应用ID
- **openid** (string) - Required - 用户OpenID
- **merchant_sign_plan_no** (string) - Required - 商户签约计划单号
- **notify_url** (string) - Required - 回调地址
- **sign_plan_detail** (object) - Required - 签约计划详情

### Response
#### Success Response (200)
- **sign_plan** (string) - 签约计划信息
- **package** (string) - 签约包信息
```

--------------------------------

### GET /v3/transfer/batches/batch-id/{batch_id}

Source: https://wechatpay.js.org/openapi/v3/transfer/batches/batch-id/%7Bbatch_id%7D

查询转账批次单以及指定状态的转账明细单。

```APIDOC
## GET /v3/transfer/batches/batch-id/{batch_id}

### Description
商户可以通过该接口查询转账批次单以及指定状态的转账明细单。

### Method
GET

### Endpoint
/v3/transfer/batches/batch-id/{batch_id}

### Parameters
#### Path Parameters
- **batch_id** (string) - Required - 微信批次单号

#### Query Parameters
- **params** (object) - Optional - 查询参数，用于指定明细状态等过滤条件

### Response
#### Success Response (200)
- **transfer_batch** (object) - 转账批次单信息
- **transfer_detail_list** (array) - 转账明细单列表
```

--------------------------------

### GET /v3/taxi-invoice/taxies/{plate_number}

Source: https://wechatpay.js.org/openapi/v3/taxi-invoice/taxies/%7Bplate_number%7D

通过车牌号获取出租车详细信息。

```APIDOC
## GET /v3/taxi-invoice/taxies/{plate_number}

### Description
获取指定车牌号的出租车信息。

### Parameters
#### Path Parameters
- **plate_number** (string) - Required - 出租车车牌号

### Response
#### Success Response (200)
- **plate_number** (string) - 车牌号
- **company_name** (string) - 公司名称
- **company_mchid** (string) - 公司商户号
- **main_license** (string) - 主许可证
- **deputy_license** (string) - 副许可证
- **region_id** (string) - 地区ID
- **support_invoice** (boolean) - 是否支持发票
- **taxi_state** (string) - 出租车状态
```

--------------------------------

### 调用重试扣费通知接口

Source: https://wechatpay.js.org/openapi/v3/partner-papay/contracts/%7Bcontract_id%7D/fail-notify

使用 SDK 发起重试扣费通知请求，并在成功时返回状态码 204。

```javascript
wxpay
.v3
.partnerPapay
.contracts
._contract_id_
.failNotify
.post
({
  sp_mchid,
  sp_appid,
  sub_mchid,
  sub_appid,
}, { contract_id })
.then(({ status, }) => status === 204)
```

--------------------------------

### GET /v3/taxi-invoice/drivers/{driver_license}

Source: https://wechatpay.js.org/openapi/v3/taxi-invoice/drivers/%7Bdriver_license%7D

获取指定驾驶证号的司机信息。

```APIDOC
## GET /v3/taxi-invoice/drivers/{driver_license}

### Description
获取指定驾驶证号的司机详细信息。

### Method
GET

### Endpoint
/v3/taxi-invoice/drivers/{driver_license}

### Parameters
#### Path Parameters
- **driver_license** (string) - Required - 司机驾驶证号

### Response
#### Success Response (200)
- **driver_name** (string) - 司机姓名
- **company_name** (string) - 所属公司名称
- **company_mchid** (string) - 所属公司商户号
- **driver_license** (string) - 司机驾驶证号
- **driver_category** (string) - 司机类别
- **driver_photo** (string) - 司机照片
- **region_id** (string) - 区域ID
- **driver_state** (string) - 司机状态
```

--------------------------------

### wxpay.v3.transferdownload.elecvoucherfile.get

Source: https://wechatpay.js.org/openapi/v3/transferdownload/elecvoucherfile

调用SDK方法下载电子回单PDF文件。该方法依赖于查询回单接口返回的下载地址。

```APIDOC
## GET wxpay.v3.transferdownload.elecvoucherfile.get

### Description
下载电子回单PDF文件。请务必对比下载的回单文件的摘要值与查询接口返回的摘要值的一致性，确保得到的回单文件的真实性和完整性。

### Method
GET

### Parameters
- **params** (object) - Required - 包含下载地址相关参数的配置对象
- **responseType** (string) - Optional - 响应类型设置

### Request Example
```javascript
const { createWriteStream } = require('fs')

wxpay.v3.transferdownload.elecvoucherfile.get({
  params,
  responseType,
}).then(({ data }) => {
  data.pipe(createWriteStream('./downloaded.pdf'))
})
```

--------------------------------

### GET /v3/recharge/bank-transfer-recharges/out-recharge-no/{out_recharge_no}

Source: https://wechatpay.js.org/openapi/v3/recharge/bank-transfer-recharges/out-recharge-no/%7Bout_recharge_no%7D

查询银行转账充值结果。

```APIDOC
## GET /v3/recharge/bank-transfer-recharges/out-recharge-no/{out_recharge_no}

### Description
提交充值申请后，可调用该接口查询充值状态。银行充值到账存在延迟：一般可在10分钟内到账。受央行大额系统工作时间限制，周一至周四17:15-20:30，周五17:15-24:00，节假日全天会延迟到账。

### Method
GET

### Endpoint
/v3/recharge/bank-transfer-recharges/out-recharge-no/{out_recharge_no}

### Parameters
#### Path Parameters
- **out_recharge_no** (string) - Required - 商户充值单号

### Response
#### Success Response (200)
- **mchid** (string) - 商户号
- **recharge_id** (string) - 微信充值单号
- **out_recharge_no** (string) - 商户充值单号
- **account_type** (string) - 账户类型
- **recharge_state** (string) - 充值状态
- **recharge_scene** (string) - 充值场景
- **recharge_state_desc** (string) - 充值状态描述
- **recharge_amount** (integer) - 充值金额
- **bank_transfer_info** (object) - 银行转账信息
- **accept_time** (string) - 受理时间
- **success_time** (string) - 成功时间
- **close_time** (string) - 关闭时间
```

--------------------------------

### wxpay.v3.payrollCard.authentications.preOrder.post

Source: https://wechatpay.js.org/openapi/v3/payroll-card/authentications/pre-order

调用微工卡核身预下单接口。

```APIDOC
## POST wxpay.v3.payrollCard.authentications.preOrder.post

### Description
服务商在拉起微工卡前端服务给用户做微工卡核身前，需要先调用本接口预下单。

### Parameters
- **openid** (string) - 用户标识
- **appid** (string) - 公众号ID
- **sub_mchid** (string) - 子商户号
- **sub_appid** (string) - 子商户公众号ID
- **authenticate_number** (string) - 商户核身单号
- **project_name** (string) - 项目名称
- **employer_name** (string) - 用工单位名称
- **authenticate_type** (string) - 核身类型

### Response
- **authenticate_number** (string) - 商户核身单号
- **openid** (string) - 用户标识
- **mchid** (string) - 商户号
- **sub_mchid** (string) - 子商户号
- **token** (string) - 核身令牌
- **expires_in** (integer) - 有效期
```

--------------------------------

### wxpay.v3.payscore.partner.permissions.applyForScene.post

Source: https://wechatpay.js.org/openapi/v3/payscore/partner/permissions/apply-for-scene

在服务商场景中申请预授权。

```APIDOC
## POST /v3/payscore/partner/permissions/apply-for-scene

### Description
该接口用于服务商场景下的预授权申请。

### Request Body
- **service_id** (string) - 服务ID
- **appid** (string) - 公众账号ID
- **sub_appid** (string) - 子商户公众账号ID
- **sub_mchid** (string) - 子商户号
- **authorization_code** (string) - 授权码
- **notify_url** (string) - 通知地址
- **scene** (string) - 场景
- **transaction_scene_info** (object) - 交易场景信息

### Response
#### Success Response (200)
- **scene** (string) - 场景
- **transaction_permissions_token** (string) - 交易权限令牌
```

--------------------------------

### GET /v3/qrcode/user-services/contract-id/{contract_id}

Source: https://wechatpay.js.org/openapi/v3/qrcode/user-services/contract-id/%7Bcontract_id%7D

查询用户服务可用信息，通过返回的服务可用状态判断是否可以正常使用公共出行代扣服务。

```APIDOC
## GET /v3/qrcode/user-services/contract-id/{contract_id}

### Description
查询用户服务可用信息，通过用户服务可用信息中的服务可用状态，来判断是否可以正常使用公共出行代扣服务。

### Method
GET

### Endpoint
/v3/qrcode/user-services/contract-id/{contract_id}

### Parameters
#### Path Parameters
- **contract_id** (string) - Required - 委托代扣协议ID

### Response
#### Success Response (200)
- **contract_id** (string) - 委托代扣协议ID
- **user_service_state** (string) - 用户服务可用状态
- **block_reason** (string) - 服务不可用原因
```

--------------------------------

### GET /v3/platsolution/mch-transfer/reservation/out-reservation-no/{out_reservation_no}

Source: https://wechatpay.js.org/openapi/v3/platsolution/mch-transfer/reservation/out-reservation-no/%7Bout_reservation_no%7D

通过商户预约单号查询预约商家转账记录详情。

```APIDOC
## GET /v3/platsolution/mch-transfer/reservation/out-reservation-no/{out_reservation_no}

### Description
商户可通过此接口查询预约商家转账记录详情。API提供的查询时限为3个月，创建时间超过3个月的预约记录不支持查询。

### Method
GET

### Endpoint
/v3/platsolution/mch-transfer/reservation/out-reservation-no/{out_reservation_no}

### Parameters
#### Path Parameters
- **out_reservation_no** (string) - Required - 商户预约单号

### Response
#### Success Response (200)
- **sp_mchid** (string) - 服务商商户号
- **sub_mchid** (string) - 子商户号
- **sp_appid** (string) - 服务商应用ID
- **sub_appid** (string) - 子商户应用ID
- **reservation_id** (string) - 微信预约单号
- **out_reservation_no** (string) - 商户预约单号
- **transfer_scene_id** (string) - 转账场景ID
- **estimated_date** (string) - 预计最晚转账日期
- **estimated_max_amount** (integer) - 预计最大转账金额
- **exact_amount** (integer) - 确切转账金额
- **openid** (string) - 用户OpenID
- **bank_type** (string) - 银行类型
- **state** (string) - 预约记录状态
- **accept_time** (string) - 受理时间
- **reserve_time** (string) - 预约时间
- **close_info** (object) - 预约关闭信息
```

--------------------------------

### 通过加密手机号查询会员领卡状态

Source: https://wechatpay.js.org/openapi/v3/marketing/membercard-open/phonenumber-member/search

使用SDK调用查询接口，传入必要的参数和请求头。

```javascript
wxpay
.v3
.marketing
.membercardOpen
.phonenumberMember
.search
.get
({
  
params
,
  
headers
,
})
.then
(
  ({ 
    
data
: {
      
user_card_information
,
    },
  }) => ({
    
user_card_information
,
  })
)
```

--------------------------------

### wxpay.v3.ecommerce.applyments.post

Source: https://wechatpay.js.org/openapi/v3/ecommerce/applyments

提交二级商户申请资料，完成二级商户入驻。

```APIDOC
## POST wxpay.v3.ecommerce.applyments

### Description
电商平台通过提交二级商户资料，完成二级商户入驻，入驻成为微信支付商户。

### Parameters
- **out_request_no** (string) - 业务申请编号
- **organization_type** (string) - 主体类型
- **finance_institution** (boolean) - 是否金融机构
- **business_license_info** (object) - 营业执照信息
- **finance_institution_info** (object) - 金融机构信息
- **id_holder_type** (string) - 证件持有人类型
- **id_doc_type** (string) - 证件类型
- **authorize_letter_copy** (string) - 授权函影印件
- **id_card_info** (object) - 身份证信息
- **id_doc_info** (object) - 证件信息
- **owner** (boolean) - 是否经营者
- **ubo_info_list** (array) - 最终受益人信息列表
- **account_info** (object) - 结算账户信息
- **contact_info** (object) - 超级管理员信息
- **sales_scene_info** (object) - 经营场景信息
- **settlement_info** (object) - 结算规则信息
- **merchant_shortname** (string) - 商户简称
- **qualifications** (array) - 特殊资质
- **business_addition_pics** (array) - 补充材料
- **business_addition_desc** (array) - 补充说明

### Response
#### Success Response
- **applyment_id** (string) - 微信支付申请单号
- **out_request_no** (string) - 业务申请编号
```

--------------------------------

### GET /v3/platsolution/mch-transfer/reservation/reservation-id/{reservation_id}

Source: https://wechatpay.js.org/openapi/v3/platsolution/mch-transfer/reservation/reservation-id/%7Breservation_id%7D

查询预约商家转账记录详情。

```APIDOC
## GET /v3/platsolution/mch-transfer/reservation/reservation-id/{reservation_id}

### Description
商户可通过接口查询预约商家转账记录详情。API提供的查询时限为3个月，创建时间超过3个月的预约记录不支持查询。

### Method
GET

### Endpoint
/v3/platsolution/mch-transfer/reservation/reservation-id/{reservation_id}

### Parameters
#### Path Parameters
- **reservation_id** (string) - Required - 预约单号

### Response
#### Success Response (200)
- **sp_mchid** (string) - 服务商商户号
- **sub_mchid** (string) - 子商户号
- **sp_appid** (string) - 服务商应用ID
- **sub_appid** (string) - 子商户应用ID
- **reservation_id** (string) - 微信预约单号
- **out_reservation_no** (string) - 商户预约单号
- **transfer_scene_id** (string) - 转账场景ID
- **estimated_date** (string) - 预计最晚转账日期
- **estimated_max_amount** (integer) - 预计最大转账金额
- **exact_amount** (integer) - 确切转账金额
- **openid** (string) - 用户OpenID
- **bank_type** (string) - 银行类型
- **state** (string) - 预约状态
- **accept_time** (string) - 受理时间
- **reserve_time** (string) - 预约时间
- **close_info** (object) - 关闭信息
```

--------------------------------

### 创建先用后付订单接口调用

Source: https://wechatpay.js.org/openapi/v3/payscore/partner/servicepayondeliveryorder

使用wxpay v3 SDK调用创建先用后付订单接口，传入必要的订单信息及配置参数。

```javascript
wxpay
.v3
.payscore
.partner
.servicepayondeliveryorder
.post
({
  out_order_no,
  appid,
  sub_mchid,
  sub_appid,
  service_id,
  service_introduction,
  post_payments,
  post_discounts,
  time_range,
  location,
  risk_fund,
  attach,
  notify_url,
  openid,
  sub_openid,
  need_user_confirm,
  mchid,
  shopping_info,
})
.then(
  ({ 
    data: {
      out_order_no,
      service_id,
      appid,
      mchid,
      sub_appid,
      sub_mchid,
      service_introduction,
      state,
      state_description,
      post_payments,
      post_discounts,
      risk_fund,
      time_range,
      location,
      attach,
      notify_url,
      order_id,
      package: packageStr,
      shopping_info,
    },
  }) => ({
    out_order_no,
    service_id,
    appid,
    mchid,
    sub_appid,
    sub_mchid,
    service_introduction,
    state,
    state_description,
    post_payments,
    post_discounts,
    risk_fund,
    time_range,
    location,
    attach,
    notify_url,
    order_id,
    package: packageStr,
    shopping_info,
  })
)
```
Tokens:
Raw