createH5Order
创建 H5 支付订单
使用示例
ts
import { WechatService } from 'nest-wxpay'
import { Injectable, Body, Post } from '@nestjs/common'
import type { H5Order, H5OrderResponse } from 'nest-wxpay'
@Injectable()
export class Controller {
constructor(private readonly wechatService: WechatService) {}
@Post('H5')
async h5(@Body() order: H5Order): Promise<H5OrderResponse> {
return this.wechatService.createH5Order(order)
}
}
返回参数
H5Order
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
description | string | 是 | 商品描述 |
out_trade_no | string | 是 | 商户订单号 |
time_expire | string | 否 | 交易结束时间 |
attach | string | 否 | 附加数据 |
notify_url | string | 是 | 回调通知地址 |
goods_tag | string | 否 | 商品标记 |
support_fapiao | boolean | 否 | 是否支持开发票 |
amount | CommReqAmountInfo | 是 | 订单金额信息 |
detail | OrderDetail | 是 | 订单详情 |
scene_info | CommReqSceneInfo | 否 | 场景信息 |
settle_info | SettleInfo | 是 | 结算信息 |
CommReqAmountInfo
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
total | number | 是 | 总金额,单位为分 |
currency | string | 否 | 货币类型 |
GoodsDetail
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
merchant_goods_id | string | 是 | 商户侧商品编号 |
wechatpay_goods_id | string | 否 | 微信支付商品编号 |
goods_name | string | 否 | 商品名称 |
quantity | number | 是 | 商品数量 |
unit_price | number | 是 | 商品单价,单位为分 |
OrderDetail
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
cost_price | number | 否 | 订单原价,单位为分 |
invoice_id | string | 否 | 发票ID |
goods_detail | GoodsDetail | 否 | 商品详情信息 |
StoreInfo
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
id | string | 是 | 门店ID |
name | string | 否 | 门店名称 |
area_code | string | 否 | 门店地区编码 |
address | string | 否 | 门店详细地址 |
CommReqSceneInfo
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
payer_client_ip | string | 是 | 用户端IP |
device_id | string | 否 | 设备ID |
store_info | StoreInfo | 否 | 门店信息 |
SettleInfo
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
profit_sharing | boolean | 否 | 是否分账 |
返回参数
H5OrderResponse
字段名 | 类型 | 是否必填 | 用途 |
---|---|---|---|
h5_url | string | 是 | 跳转支付的链接 |