终止
概述:该接口应用于线上场景(如线上小程序商城等),使用轻POS的分笔支付功能下,订单到期而顾客仅支付部分金额,业务系统需要退回支付的金额。适用于业务系统没有记录未完成订单的支付流水,而需退款给顾客的情形。
订单支付未完成时,调用该接口关闭订单。如果此订单顾客未支付过(订单状态为待操作),系统会将此订单关闭;如果顾客支付订单部分金额(状态是操作中),系统会将此订单关闭并把支付成功的资金退还给顾客。
API endpoint: {api_domain}/api/lite-pos/v1/sales/terminate
Verb: POST
Signature :需要签名,参考统一签名说明
请求参数:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
request_id | 1 | String | 字符串,最大64位 | 请求编号,每次请求必须唯一;表示每一次请求时不同的业务,如果第一次请求业务失败了,再次请求,可以用于区分是哪次请求的业务。 |
brand_code | 1 | String | 数字,最大32位 | 品牌编号,系统对接前由"收钱吧"分配并提供 |
store_sn | 0-1 | String | 字符串,最大36位 | 商户内部使用的门店编号 |
workstation_sn | 0-1 | String | 字符串,最大36位 | 门店收银机编号,如果没有请传入“0” |
check_sn | 0-1 | String | 字符串,最大32位 | 原始商户订单号 |
order_sn | 0-1 | String | 字符串,最大32位 | 本系统为该订单生成的订单号 |
store_sn+workstation_sn+check_sn和order_sn不能同时为空,
优先按order_sn查询,如果没有再按store_sn+workstation_sn+check_sn查询。
返回参数:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
brand_code | 1 | String | 数字,最大32位 | 品牌编号,系统对接前由"收钱吧"分配并提供,返回调用方传入的值 |
store_sn | 1 | String | 字符串,最大36位 | 商户内部使用的门店编号,返回调用方传入的值 |
workstation_sn | 1 | String | 字符串,最大36位 | 门店收银机编号,返回调用方传入的值 |
check_sn | 1 | String | 字符串,最大32位 | 商户订单号,返回调用方传入的值 |
order_sn | 1 | String | 字符串,最大32位 | 本系统为该订单生成的订单号 |
order_status | 1 | String | 数字,1位 | 订单状态 0:已取消,1:待操作,2:操作中,3:等待结果中,4:操作完成,5:部分完成,6:操作失败,7:已终止 |
当order_status不等于7时,需重新调用终止订单接口