销售类结果通知
API endpoint: 由商户提供,收钱吧配置
Verb: POST
Signature :请求参数中包含签名,商家需要对签名进行验签,参考统一签名说明
请求参数:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
notification_sn | 1 | String | 字符串,最大32位 | 通知编号 |
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_type | 1 | String | 数字,1位 | 订单类型,1 销售; 2 退款 |
sales_sn | 0-1 | String | 字符串,最大36位 | POS 或 电商等业务系统内的实际销售订单号,不同于check_sn。如果发起支付请求时该订单号已经生成,强烈建议传入,方便后续对账和运营流程使用。本字段不影响交易本身。 |
order_source | 1 | String | 数字,1 位 | 订单来源:1=商户系统,3=智能终端,4=门店码牌,5=商户后台 |
order_status | 1 | String | 数字,1位 | 产生回调时订单状态可能有: 0:已取消,2:操作中,4:操作完成,5:部分完成,6:操作失败,7:已终止 |
scene | 1 | String | 数字,1位 | 业务场景值:0-无场景,1-智能终端,2-H5,4-PC,5-微信小程序/插件,7-刷脸终端,8-立即付,10-APP支付,11-顾客扫码支付,12-顾客出码 |
sales_time | 1 | String | 字符串,20- 25位 | 订单创建时间,格式详见 1.5时间数据元素定义 |
amount | 1 | String | 数字,最大12位 | 订单总金额,精确到分。 |
currency | 1 | String | 字符串,3位 | 币种,ISO numeric currency code 如:"156"for CNY |
subject | 1 | String | 字符串,最大64位 | 订单简短描述 |
description | 0-1 | String | 字符串,最大255位 | 订单描述 |
operator | 1 | String | 字符串,最大32位 | 操作员,可以传入收款的收银员或导购员。例如"张三" |
customer | 0-1 | String | 字符串,最大32位 | 可以传入需要备注顾客的信息 |
extension_1 | 0-1 | String | 字符串,最大32位 | 拓展字段1,可以用于做自定义标识,如座号,房间号; 智能终端手动录单功能需要添加此字段请联系收钱吧技术支持 |
extension_2 | 0-1 | String | 字符串,最大32位 | 拓展字段2,可以用于做自定义标识,如座号,房间号; 智能终端手动录单功能需要添加此字段请联系收钱吧技术支持 |
industry_code | 1 | String | 数字,1位 | 行业代码, 0=零售;1:酒店; 2:餐饮; 3:文娱; 4:教育; |
pos_info | 1 | String | 字符串,最大64位 | 商户系统的产品名称、系统编号等信息,便于帮助商户调查问题 |
notify_url | 0-1 | String | 字符创,最大255位 | 通知接收地址。总共回调7次,回调时间间隔:4m,10m,10m,1h,2h,6h,15h。 |
reflect | 0-1 | String | 字符串,最大255位 | 反射参数; 任何开发者希望原样返回的信息,可以用于关联商户ERP系统的订单或记录附加订单内容。可以在订单结果通知中返回 |
items | 0-n | [Item] | item数组 | 订单货物清单,定义如下表 |
tenders | 0-n | [tender] | tender数组 | 指定本订单的流水信息,定义如下表 |
items:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
item_code | 1 | String | 字符串,最大32位 | 商户系统中的商品编号 |
item_desc | 1 | String | 字符串,最大64位 | 商品描述信息,例"白色短袖" |
category | 0-1 | String | 字符串,最大32位 | 商品所属大类,例"短袖" |
unit | 0-1 | String | 字符串,最大32位 | 商品单位,例"件" |
item_qty | 1 | String | 数字,最大8位 | 商品数量,例"2" |
item_price | 1 | String | 数字,最大12位 | 商品单价,精确到分 |
sales_price | 1 | String | 数字,最大12位 | 商品成交价格,一般为数量*单价,如有折扣再进行扣减,精确到分;当退货时成交价为负数;目前不校验"数量*单价"结果是否与此字段值相等 |
type | 1 | String | 数字,1位 | 0-销售,1-退货 |
spec | 0-1 | String | 字符串,最大64位 | 商品的规格 |
remark | 0-1 | String | 字符串,最大128位 | 商品的备注 |
extra | 0-1 | String | 字符串,最大128位 | 备用 |
return_store_sn | 0-1 | String | 字符串,最大36位 | 原商品销售门店号,退货时必填 |
return_workstation_sn | 0-1 | String | 字符串,最大36位 | 原商品销售收银机号,退货时必填 |
return_check_sn | 0-1 | String | 字符串,最大32位 | 原商品销售订单号,退货时必填 |
tenders:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
original_transaction_sn | 0-1 | String | 字符串,最大32位 | 退款对应的原购货订单商家支付流水号,没有则不会返回 |
transaction_sn | 0-1 | String | 字符串,最大36位 | 支付/退款指定中商户系统流水号,在商户系统中唯一 |
original_tender_sn | 0-1 | String | 字符串,最大32位 | 退款对应的原购货订单完成后本系统返回的支付流水号 |
tender_sn | 1 | String | 数字,最大32位 | 支付/退款成功后,轻POS生成的唯一流水号 |
amount | 1 | String | 数字,最大12位 | 支付/退款金额,精确到分 |
collected_amount | 1 | String | 数字,最大12位 | 商家实收/实退金额,精确到分 |
paid_amount | 1 | String | 数字,最大12位 | 消费者实付/实退金额,精确到分 |
pay_time | 0-1 | String | 字符串,20- 25位 | 支付源交易流水完成时间,格式详见 1.5时间数据元素定义 |
pay_status | 1 | String | 数字,1位 | 支付状态, 1:待操作; 2:支付中; 3:支付成功; 4:退款中; 5:退款成功;6:退款失败;7:支付失败;8:未知状态; |
reason | 0-1 | String | 字符串 | 结果原因描述 |
tender_type | 1 | String | 数字,1位 | 支付方式类型:0-其他,1-预授权完成,2-银行卡,3-QRCode,4-分期,99-外部 |
sub_tender_type | 0-1 | String | 数字 | 二级支付方式类型: 001-现金,如需在轻POS录入其他支付方式,在对接时与收钱吧沟通配置; 101-银行卡预授权完成,102-微信预授权完成,103-支付宝预授权完成; 201-银行卡; 301-微信,302-支付宝; 402-花呗分期 |
sub_tender_desc | 0-1 | String | 字符串 | 二级支付方式描述。如:微信支付 |
channel_sn | 0-1 | String | 字符串,最大 | 支付渠道流水号,操作成功时存在。 微信支付宝:微信支付宝流水号; 银行卡:银行卡流水号。 |
internal_transaction_sn | 0-1 | String | 字符串,最大 | 移动支付:收钱吧传入支付宝/微信的out_trade_no; 银行卡支付:交易返回的交易授权码 |
installment_number | 0-1 | String | 数字 | 分期数,分期支付时返回 |
installment_fee_merchant_percent | 0-1 | String | 数字 | 商家贴息比例,分期支付时返回 |
operation | 0-1 | String | 字符串,最大2位 | 退款操作类型 9-原路退还, 10-转账。退款订单返回该字段。 |
channel_info | 0-1 | JSON | 对象 | 支付渠道(银行卡/移动支付/礼品卡等)交易信息。定义见下表 |
channel_info:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
card_info | 0-1 | JSON | 银行卡交易信息 二级支付方式为“201-银行卡”返回 定义见下表card_info |
|
mobile_payment_info | 0-1 | JSON | 移动支付交易信息 二级支付方式为“301-微信”,“302-支付宝”,“402-花呗分期”等返回 定义见下表mobile_payment_info |
|
card_payment_info | 0-1 | JSON | 卡券支付交易信息 二级支付方式为“801-会员储值卡”、“804-单品券”、“807-以旧换新券”时返回 定义见下表card_payment_info |
|
giftcard_infos | 0-1 | [giftcard_info] | giftcard_info数组 | 礼品卡核销时返回 |
card_info:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
trace_no | 1 | String | 字符串 | 凭证号 |
batch_no | 1 | String | 字符串 | 批次号 |
ref_no | 1 | String | 字符串 | 系统参考号 |
auth_no | 1 | String | 字符串 | 授权码 |
issuer_no | 1 | String | 字符串 | 发卡行号 |
issuer_name | 1 | String | 字符串 | 发卡行名称 详情见附录部分 |
card_no | 1 | String | 字符串 | 卡号(卡号中段为“*”号,已加密) |
card_type_identity | 1 | String | 字符串 | 借贷记卡标识 0:借记;1:贷记 |
abroad_card_type | 1 | String | 字符串 | 内外卡标识 0:内卡;1:外卡 |
mobile_payment_info:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
payer_uid | 1 | String | 字符串,最大64位 | 付款人ID,支付平台(微信,支付宝)上的付款人ID |
payment_list | 0-n | [payment] | payment数组 | 活动优惠,定义如下表 详情见:活动优惠 |
provider_response | 0-1 | JSON | 字符串 | 优惠详情,定义如下表, 详情见:优惠详情 · GitBook (shouqianba.com) |
card_payment_info:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
payer_unionid | 0-1 | String | 字符串,最大128位 | 付款人ID,(微信公众平台unionid) |
card_number | 0-1 | String | 字符串,最大128位 | 卡号或者券号 |
old_device_sn | 0-1 | String | 字符串,最大64位 | 旧机号(以旧换新券出现) |
card_type | 0-1 | Integer | 数字,最大128位 | 卡类型 1-商品卡 |
card_form | 0-1 | Integer | 数字,最大128位 | 卡形态 1-电子卡;2-实体卡 |
giftcard_info:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
card_number | 1 | String | 字符串,最大12位 | 卡号 |
expiration_date | 1 | String | 字符串 | 有效期截止日, 例:2027-04-01,代表截止到这一天,卡仍然可以正常使用 |
balance_movement | 0-1 | JSON | BalanceMovement | 余额变化 |
BalanceMovement:
参数 | 出现 | 类型 | 约束 | 描述 |
---|---|---|---|---|
beginning | 1 | Long | 数字,最大12位 | 期初余额,单位分 |
activity | 1 | Long | 数字,最大12位 | 发生金额,单位分。支付时为负数,退款时为正数 |
ending | 1 | Long | 数字,最大12位 | 期末余额,单位分 |
商户收到通知后的响应,收钱吧判断通知成功的标志,参考响应通用定义。示例:
{
"response":{
"head":{
"version":"1.0.0",
"sign_type":"SHA256",
"appid":"28lp61847655",
"response_time":"2019-08-01T12:00:00+08:00"
},
"body":{
"result_code":"200",
"biz_response":{
"result_code":"200"
}
}
},
"signature":"签名值"
}