付款码查询
API endpoint: {api_domain}/api/lite-pos/v1/utility/authcode/query
Verb: POST
Signature :需要签名,参考统一签名说明
请求参数
参数 |
出现 |
类型 |
约束 |
描述 |
request_id |
1 |
String |
字符串,最大64位 |
请求编号,每次请求必须唯一 |
brand_code |
1 |
String |
数字,最大32位 |
品牌编号,系统对接前由“收钱吧”提供 |
store_sn |
1 |
String |
字符串,最大36位 |
商户门店编号 |
workstation_sn |
1 |
String |
字符串,最大36位 |
门店收银机编号,如果没有请传入“0” |
dynamic_id |
1 |
String |
字符串,最大36位 |
授权码 |
返回参数
参数 |
出现 |
类型 |
约束 |
描述 |
brand_code |
1 |
String |
数字,最大32位 |
品牌编号,系统对接前由“收钱吧”提供 |
store_sn |
1 |
String |
字符串,最大36位 |
商户门店编号 |
workstation_sn |
1 |
String |
字符串,最大36位 |
门店收银机编号,如果没有请传入“0” |
dynamic_id |
1 |
String |
字符串,最大36位 |
授权码 |
type |
1 |
String |
字符串,最大 4 位 |
1 储值卡;2 券;3 钱包 |
card |
0-1 |
对象 |
- |
type为1返回 |
coupon |
0-1 |
对象 |
- |
type为2返回 |
wallet |
0-1 |
对象 |
|
type为3返回 |
card:
参数 |
必填 |
类型 |
约束 |
描述 |
card_number |
1 |
String |
字符串,最大 36 位 |
卡号 |
card_name |
1 |
String |
字符串,最大 36 位 |
卡名 |
card_denomination |
1 |
String |
数字,最大 12 位 |
面额,以分为单位 |
card_external_discount |
0-1 |
String |
数字,最大 12 位 |
外部优惠金额,以分为单位 |
card_balance |
1 |
String |
数字,最大 12 位 |
余额,以分为单位 |
card_net_balance |
1 |
String |
数字,最大 12 位 |
净额,以分为单位 |
discount_rate |
1 |
String |
浮点数,最多2位小数 |
折扣率,净额/余额 |
status |
1 |
String |
数字,最大 4 位 |
卡状态 1:未激活(未领取) 2:已激活(已领取) 4:冻结中(退卡中/已过期) 6:已失效(已退卡) |
disabled_time |
0-1 |
String |
字符串,20- 25位 |
失效时间,格式详见 1.5时间数据元素定义 |
expiration_date |
0-1 |
String |
字符串,20- 25位 |
有效期截止日, 例:2027-04-01,代表截止到这一天,卡仍然可以正常使用 |
member_id |
0-1 |
String |
字符串,最大 36 位 |
用户编号 |
business_tag |
0-1 |
String |
字符串,最大60位 |
业务标签 |
coupon:
参数 |
必填 |
类型 |
约束 |
描述 |
coupon_platform |
1 |
String |
字符串,最大 2 位 |
发券方, 1:收钱吧,2:抖音,3:美团 |
coupon_number |
1 |
String |
字符串,最大 36 位 |
券号 |
coupon_name |
1 |
String |
字符串,最大 36 位 |
券名 |
coupon_type |
1 |
String |
字符串,最大 4 位 |
券类型 1:单品券,2:团购券 |
coupon_count |
1 |
String |
字符串 |
券可用数量 |
coupon_amount |
1 |
String |
字符串,最大 20 位 |
余额,以分为单位 |
coupon_net_amount |
1 |
String |
字符串,最大 20 位 |
净额,以分为单位 |
discount_rate |
1 |
String |
字符串,最大 20 位 |
折扣率 |
status |
1 |
String |
字符串,最大 4 位 |
券状态 1:未激活(未领取) 2:已激活(已领取) 4:冻结中(退券中/已过期) 6:已失效(已退券) |
disabled_time |
1 |
String |
字符串,20- 25位 |
失效时间,格式详见 1.5时间数据元素定义 |
expiration_date |
0-1 |
String |
字符串,20- 25位 |
有效期截止日, 例:2027-04-01,代表截止到这一天,卡仍然可以正常使用 |
member_id |
0-1 |
String |
字符串,最大 36 位 |
用户编号 |
coupon_spec_id |
0-1 |
String |
字符串,最大128 位 |
券对应商品 sku 的规则 id。 规则 id对应商家端可能是一个 sku,也可能是一组 sku |
coupon_spec_desc |
0-1 |
String |
字符串,最大256位 |
券使用规则描述 |
business_tag |
0-1 |
String |
字符串,最大60位 |
业务标签 |
wallet:
参数 |
必填 |
类型 |
约束 |
描述 |
wallet_type |
1 |
String |
数字,最大2位 |
钱包类型,1 会员卡钱包;2 员工卡钱包 |
member_id |
0-1 |
String |
字符串,最大 36 位 |
用户编号 |