验券接口
接口说明
- 提货券抖音券码的核销需要先调用验券准备接口,再调用本接口。
- 可支持多个批量验券,需为同一个订单,不可跨订单验券。
- error_code、result 均为 0 代表验券成功。error_code非0时则表示调用验券接口失败,建议服务商侧主动发起重试,建议间隔5s发起。第一次调用error_code非0,第二次调用error_code=0且result=1208或2,也可以代表验券成功
- 接口报错返回”服务器错误,请稍后重试“、“您的访问过于频繁,请稍后重试”等建议重试的文案后,建议以如下重试策略进行重试,接口成功返回后即可停止重试:
- 前5次重试以5s间隔进行
- 之后以40s间隔进行
- 最高重试14次,如果接口依然报错,请进线反馈
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/verify/ |
HTTP Method | POST |
Scope | life.capacity.compre_retail_certificate_verify |
权限要求 | 综合到店提货解决方案-提货券抖音码交易,提货券三方码交易能力 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body展开全部子属性
poi_id必填String
verify_token必填String
一次验券的标识
抖音码交易:验券准备接口返回的验券标识
三方码交易:针对三方码订单,每次请求都需要保证幂等!(请求维度,非券码/订单维度)
account_idString
核销的商家账号
code_with_time_listList
核销前验证核销时间
展开子属性
codesArray<String>
三方券码:券码值列表 codes (encrypted_codes/codes/code_with_time_list必须三选一)
注:抖音券码需要先调用验券准备接口,一般是传encrypted_codes字段,三方码传code_with_time_list 或 codes
encrypted_codesArray<String>
针对抖音券码:验券准备接口返回的加密抖音券码
order_idString
抖音侧的订单号
verify_extraStruct
核销额外信息
展开子属性
verify_sign_listArray<String>
三方核销验签
voucherStruct
景区核销,字段废弃,请勿使用
展开子属性
vouchersList
团购景区核销,字段废弃,请勿使用
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/goodlife/v1/compre_retail/fulfilment/certificate/verify/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"account_id":"ahfgtX0nVq","code_with_time_list":[{"code":"vNuz0QRzPC","verify_time":7656814283627259075,"serial_num":178017137652746140,"outer_numb":{"coupon_number":"PeTQx6L5Tz","order_number":"7UPzR7SiUD"}}],"poi_id":"KBJjsDknUr","encrypted_codes":["1JVlpHQFPW"],"verify_extra":{"offline_add_price_info":{"is_offline_add_price":false},"out_good_ids":["pIkScvQ5qs"],"verify_model":1,"dynamic_coupon_info":{"actual_deduction_amount":7294847579486467121,"biz_time":5858272174542967628},"total_verify":false},"codes":["8vvqMRpH2O"],"order_id":"3RzYl6EnOt","voucher":{"project_id":"EtIvHGKAhs","id_card_list":["QlF5JSvhdI"],"qrcode_list":["DSd3yxsiHi"],"certificate_no_list":["a7QDxURrsh"],"verify_time":565533088333880082},"verify_token":"MxVDUfunmk","vouchers":[{"project_id":"Fv31dkKuTQ","id_card_list":["0BJpzakNoo"],"qrcode_list":["9VedNaS0cH"],"certificate_no_list":["0OURltYSIo"],"verify_time":43736546335539867}],"verify_sign_list":["viAHdowRxK"]}'
响应参数
Body展开全部子属性
data必填Struct
展开子属性
extra必填Struct
扩展信息
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202503262016189550D7E35C177B064D89", "now": 1742991379 }, "data": { "verify_results": [ { "id_card": "zNGOFiuBnk", "verify_id": "lo7xezTWFw", "origin_code": "BCdJDbRqKw", "verify_amount_info": { "time_card_amount": { "amount": 7736938724435580000 }, "times_card_serial_amount": { "serial_numb": 2360762874988607500, "amount": { "original_amount": 683142310536636700, "payment_discount_amount": 5917937161018379000, "coupon_pay_amount": 733872222752798600, "platform_discount_amount": 5374887657358468000, "list_market_amount": 7311758984843849000, "merchant_ticket_amount": 7451789696865421000, "origin_list_market_amount": 8963419380364305000, "pay_amount": 7089670017565273000, "brand_ticket_amount": 8146916932260111000, "original_currency": "MfIlX7vclv" } } }, "product_id": "qLNDHM2eO0", "certificate_no": "An2S1yK8lz", "code": "fNzUxnsQkb", "result": 2083505183348073500, "order_id": "7BFQHJsDGI", "msg": "6THjab9gKL", "account_id": "iEVFcx5sBG", "qrcode": "VDaVLVi05H", "certificate_id": "oeRWGuimIy", "out_good_id": "rKdbchiaHk" } ], "error_code": 0, "description": "" } }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
200 | 2100005 | 参数不合法 | 更换参数 |
200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
200 | 2190008 | access_token过期,请刷新或重新授权 |