支付订单操作
参数说明
options 是 Object 类型,它包括以下几个属性:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
trade_no | String | 是 | 支付订单订单号(必须为微信支付订单,并且在创建支付订单时,添加参数 |
receivers | Array | 是 | 分账接收方列表 |
appid | String | 是 | 微信分配的公众账号ID |
Receiver 类型说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
type | ReceiverType | 是 | 分账接收方类型 |
account | String | 是 | 分账接收方账户 |
amount | Number | 是 | 分账金额,单位为分,只能为整数,不能超过原订单支付金额及最大分账比例金额 |
description | String | 是 | 分账描述 |
{{profitSharing.receiverType()}}
支付订单操作
获取订单
Order#getOrderList(params)
参数说明
params 是 Object 类型,为订单过滤条件,你可以参考后面的返回参数说明,进行筛选。
返回参数说明
部分关键字段:
参数 | 类型 | 说明 |
---|---|---|
params.gateway_type | String | 支付方式,可选值有:weixin_tenpay(微信支付)、alipay(支付宝支付) |
params.created_at | Number | 创建支付请求的时间戳 |
params.created_by_id | Number | 订单创建者 id |
params.created_by_name | String | 订单创建者姓名 |
params.id | Number | 订单 id,用于退款的 order_id |
params.ip_address | Number | - |
params.merchandise_description | String | 商品详情上的文字描述 |
params.merchandise_record_id | String | 商品记录 ID,可用于定位用户购买的物品 |
params.merchandise_schema_id | Number | 商品表 ID,可用于定位用户购买的物品 |
params.merchandise_snapshot | String | - |
params.paid_at | Number | 付款时间, 未支付的话为 null |
params.refund_amount | Number | 退款金额 |
params.refund_status | String | 退款状态,可能的值有:complete(退款成功)、partial(部分退款),也可能为 null |
params.status | String | 订单状态, pending(待支付)、success(支付成功) |
params.total_cost | Number | 发起交易请求时的支付金额 |
params.trade_no | String | 知晓云平台所记录的订单号 |
params.transaction_no | String | 对应微信(或支付宝)支付成功后返回的 transaction_no,支付流水号 |
params.updated_at | Number | 订单更新时间 |
params.paid_at__gte | Number | 付款时间区间的开始时间 |
params.paid_at__lte | Number | 付款时间区间的结束时间 |
示例代码
查找微信支付订单
根据订单号查找
分页查询所有订单
HError 对象结构请参考错误码和 HError 对象
返回示例
成功时 res 对象结构如下
支付结果返回信息 gateway_extra_info 参数说明
gateway_extra_info 目前只支持 gateway_type == 'weixin_tenpay'
(微信支付)时,返回支付成功后回调的订单详细信息。
gateway_extra_info 返回的数据结构如下:
wechat_response 中部分关键字段:
参数 | 类型 | 说明 |
---|---|---|
appid | String | 微信分配的小程序ID |
bank_type | String | 银行类型,采用字符串类型的银行标识,银行类型见银行列表 |
total_fee | String | 订单总金额,单位为分 |
is_subscribe | String | 用户是否关注公众账号,Y-关注,N-未关注 |
fee_type | String | 货币类型,符合ISO4217标准的三位字母代码,默认人民币:CNY,其他值列表详见货币类型 |
具体返回参数详情可参照微信支付结果通知
微信直连商户分账
产品介绍,详见微信直连商户分账官方文档。
“分账接收方操作”、“分账账单操作”,请查看微信直连商户分账文档
为了支持“微信微信直连商户分账”,在创建支付订单时,需要添加参数 profitSharing
(值为 true
),具体请参考 JS SDK 支付接口文档中微信支付部分。
info
只支持使用微信支付的订单
需要先添加分账接收方才能分账
订单单次分账
{{ profitSharing.warning() }}
Order#wechatPay.profitSharing(options)
{{ profitSharingCommon() }}
示例代码
返回示例
成功时 res 对象结构如下
订单多次分账
{{ profitSharing.warning() }}
Order#wechatPay.multiProfitSharing(options)
{{ profitSharingCommon() }}
示例代码
返回示例
成功时 res 对象结构如下
支付宝商家分账
产品介绍,详见支付宝商家分账官方文档。
“分账接收方操作”、“分账账单操作”,请查看支付宝商家分账文档
info
只支持使用支付宝支付的订单
需要先添加分账接收方才能分账
订单分账
Order#alipay.profitSharing(options)
参数说明
options 是 Object 类型,它包括以下几个属性:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
trade_no | String | 是 | 支付订单订单号(必须为支付宝支付订单) |
receivers | Array | 是 | 分账接收方列表 |
Receiver 类型说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
type | ReceiverType | 是 | 分账接收方类型 |
account | String | 是 | 分账接收方账户 |
amount | Number | 是 | 分账金额,单位为分,只能为整数,不能超过原订单支付金额 |
description | String | 是 | 分账描述 |
{{profitSharing.receiverTypeAlipay()}}
示例代码
返回示例
成功时 res 对象结构如下
退款
BaaS.refund(data)
info 使用了分账的订单,需要先调用分账回退接口将钱回退到订单商户号中,否则可能会退款失败
参数说明
data 是 Object 类型,它包括以下几个属性
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
refund_amount | Number | 否 | 默认为退还剩余所有款项 |
order_id | Number | 是 | 订单 id |
trade_no | String | 是 | - |
transaction_no | String | 是 | - |
memo | String | 否 | 备注信息 |
返回参数说明
部分关键字段:
参数 | 类型 | 说明 |
---|---|---|
error_msg | String | - |
id | Number | - |
memo | String | 备注信息 |
order_id | Number | 订单 id |
refund_amount | String | 退款金额 |
refund_no | String | 退款单号 |
status | String | 订单支付状态(succeed:成功;failed:失败) |
示例代码
调用退款接口,需要先通过上文的 Order#getOrderList
API,拿取返回数据中的 id 字段作为 order_id 的值,来进行退款操作 也可以通过 trade_no
和 transaction_no
来退款。
HError 对象结构请参考错误码和 HError 对象
Last updated