支付订单操作

获取订单

Order#getOrderList(params)

参数说明

params 是 Object 类型，为订单过滤条件，你可以参考后面的返回参数说明，进行筛选。

返回参数说明

部分关键字段：

示例代码

查找微信支付订单

var order = new BaaS.Order()
// 通过 gateway_type 查询订单
order.getOrderList({gateway_type: 'weixin_tenpay'}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

根据订单号查找

var order = new 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 对象
})

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"
    }]
  },
  "status": 200
}

支付结果返回信息 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 中部分关键字段：

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

微信直连商户分账

产品介绍，详见微信直连商户分账官方文档。

“分账接收方操作”、“分账账单操作”，请查看微信直连商户分账文档

为了支持“微信微信直连商户分账”，在创建支付订单时，需要添加参数 profitSharing（值为 true），具体请参考 JS SDK 支付接口文档中微信支付部分。

订单单次分账

Order#wechatPay.profitSharing(options)

参数说明

options 是 Object 类型，它包括以下几个属性:

Receiver 类型说明:

ReceiverType 可选值说明:

示例代码

var order = new BaaS.Order()
order.wechatPay.profitSharing({
  trade_no: '...',
  appid: '...',
  receivers: [{
    type: '...',
    account: '...',
    amount: 10,
    description: '...',
  }],
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

返回示例

成功时 res 对象结构如下

{
  "data": {
    "return_code": "SUCCESS",
    "appid": "...",
    "mch_id": "...",
    "trade_no": "...",
    "wechat_order_no": "..."
  },
  "status": 200
}

订单多次分账

Order#wechatPay.multiProfitSharing(options)

参数说明

options 是 Object 类型，它包括以下几个属性:

Receiver 类型说明:

ReceiverType 可选值说明:

示例代码

var order = new BaaS.Order()
order.wechatPay.multiProfitSharing({
  trade_no: '...',
  appid: '...',
  receivers: [{
    type: '...',
    account: '...',
    amount: 10,
    description: '...',
  }],
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

返回示例

成功时 res 对象结构如下

{
  "data": {
    "return_code": "SUCCESS",
    "appid": "...",
    "mch_id": "...",
    "trade_no": "...",
    "wechat_order_no": "..."
  },
  "status": 200
}

支付宝商家分账

产品介绍，详见支付宝商家分账官方文档。

“分账接收方操作”、“分账账单操作”，请查看支付宝商家分账文档

订单分账

Order#alipay.profitSharing(options)

参数说明

options 是 Object 类型，它包括以下几个属性:

Receiver 类型说明:

ReceiverType 可选值说明:

示例代码

var order = new BaaS.Order()
order.alipay.profitSharing({
  trade_no: '...',
  receivers: [{
    type: '...',
    account: '...',
    amount: 10,
    description: '...',
  }],
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

返回示例

成功时 res 对象结构如下

{
  "data": {
    "return_code": "10000",
    "trade_no": "1iIUfhTxivu6RxvyQgkRRwp9VklswK46"
  },
  "status": 200
}

退款

BaaS.refund(data)

参数说明

data 是 Object 类型，它包括以下几个属性

返回参数说明

部分关键字段：

示例代码

调用退款接口，需要先通过上文的 Order#getOrderList API，拿取返回数据中的 id 字段作为 order_id 的值，来进行退款操作 也可以通过 trade_no 和 transaction_no 来退款。

// 通过订单 ID 退款
BaaS.refund({
  order_id: 29973,
  memo: '测试退款'
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

// 通过 trade_no 退款
BaaS.refund({
  trade_no: '1gAtaEFcmu6DyHm5b0ycBSmNO302NGzA',
  memo: '测试退款'
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

// 通过 transaction_no 退款
BaaS.refund({
  transaction_no: '1gAtaEFcmu6DyHm5b0ycBSmNO302NGzA',
  memo: '测试退款'
}).then(res => {
  // success
}).catch(e=>{
  // HError 对象
})

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