Skip to content

Latest commit

 

History

History
158 lines (125 loc) · 5.92 KB

order.md

File metadata and controls

158 lines (125 loc) · 5.92 KB
Raw

订单查询

通过 BaaS SDK 提供的 Order.getOrderList(params) 方法, 可查询到交易的详细信息。典型的使用场景为: 调用 wx.BaaS.pay(object) 发起支付, 在成功回调中获取到 transaction_no 或 trade_no, 在要路由到新的页面时带上此 ID, 在新页面的 onLoad 方法中获取到该 ID, 从而使用此 ID 获取交易的详细信息。

函数签名

Order.getOrderList(params)

参数说明

参数 类型 说明
params.merchandise_record_id String 商品记录 ID，可用于定位用户购买的物品
params.merchandise_schema_id Number 商品表 ID，可用于定位用户购买的物品
params.status String 订单支付状态,可选值有：complete（退款成功）、pending（待支付）、success（支付成功）、partial（部分退款）
params.trade_no String 真正的交易 ID, 业务方在微信后台对账时可看到此字段
params.transaction_no String 知晓云平台所记录的流水号
params.gateway_type String 支付方法，可选值有：weixin_tenpay（微信支付）、alipay（支付宝支付）

示例代码 {% ifanrxCodeTabs %}

var order = new wx.BaaS.Order()

// 通过 trade_no 查询订单
order.getOrderList({trade_no: '1gCeU9ZKQQAA8iQgUM0lWhEbnqr89Qtxxx'}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

// 通过 transaction_no 查询订单
order.getOrderList({transaction_no: 'v4WoZ7aNyZPaZbNlFffOZLvagUKqDcOw'}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

// 分页查询所有订单
order.offset(20).limit(20).getOrderList().then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

// 查询商品表为 1234 且状态为待支付的订单
order.getOrderList({merchandise_schema_id: 1234, status: 'pending'}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

{% endifanrxCodeTabs %}

HError 对象结构请参考错误码和 HError 对象

返回示例

成功时 res 对象结构如下

{
  "data": {
    "meta": {"limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 1},
    "objects": [{
      "created_at": "2018-10-12T17:18:10.992125",
      "gateway_extra_info": "{'payment_parameters': {'nonceStr': '1gAtaFdVpelLBqH1iNu6Drny159aN7CL', 'timeStamp': '1539335891', 'appId': 'xxxxxxxxx', 'signType': 'MD5', 'paySign': '9A9277CEDBE9A47B5A0E4CD664E3A6E9', 'package': 'prepay_id=wx121718113084277cb388281e2112421151'}}",
      "id": 47963,
      "ip_address": "183.61.109.211",
      "merchandise_description": "一条支付描述",
      "merchandise_record_id": null,
      "merchandise_schema_id": null,
      "merchandise_snapshot": "{}",
      "paid_at": null,
      "refund_status": null,
      "status": "pending",
      "total_cost": "398.00",
      "trade_no": "1gAtaEFcmu6DyHm5b0ycBSmNO302NGzA",
      "transaction_no": "XDiXbfLFyd8DpxSWqBUcb2jW1AvhVORC",
      "updated_at": "2018-10-12T17:18:11.317089"
    }]
  },
  "statusCode": 200
}

err 对象结构请参考错误码和 HError 对象

常见错误：

错误码 err.code 可能的原因
400 查询参数不合法

返回参数说明

部分关键字段：

参数 类型 说明
created_at Number 调用 wx.BaaS.pay(object) 的时刻
merchandise_description String 微信支付-微信支付凭证-商品详情上的文字描述
paid_at Number 付款时间, 未支付的话为 null
status String 订单支付状态
total_cost Number 发起交易请求时的支付金额
trade_no String 真正的交易 ID, 业务方在微信后台对账时可看到此字段
transaction_no String 知晓云平台所记录的流水号
gateway_extra_info String 支付结果返回信息

支付结果返回信息 gateway_extra_info 参数说明

gateway_extra_info 目前只支持 gateway_type == 'weixin_tenpay'（微信支付）时，返回支付成功后回调的订单详细信息。

gateway_extra_info 返回的数据结构如下：

{
  "gateway_extra_info": {
    "wechat_response": {
      "appid": "wx3b040d33346exxxx",
      "bank_type": "OTHERS",
      "cash_fee": "1",
      "fee_type": "CNY",
      "is_subscribe": "N",
      "mch_id": "1501889000",
      "nonce_str": "1jFEJyNvEkr2IePMYXOeUEOHP11eXXXX",
      "openid": "om4vu0FZiwoQbTVAt0U-FEzXXXXX",
      "out_trade_no": "1jFEJyxlAuqzAtGcd4uuNxJwMS1TXXXX",
      "result_code": "SUCCESS",
      "return_code": "SUCCESS",
      "sign": "AB329F580E6E342246350DFE96AEXXXX",
      "time_end": "20200320175220",
      "total_fee": "1",
      "trade_type": "JSAPI",
      "transaction_id": "4200000519202003205153312216"
    }
  }
}

wechat_response 中部分关键字段：

参数 类型 说明
appid String 微信分配的小程序ID
bank_type String 银行类型，采用字符串类型的银行标识，银行类型见银行列表
total_fee String 订单总金额，单位为分
is_subscribe String 用户是否关注公众账号，Y-关注，N-未关注
fee_type String 货币类型，符合ISO4217标准的三位字母代码，默认人民币：CNY，其他值列表详见货币类型

具体返回参数详情可参照微信支付结果通知