进件状态回调
收藏我的收藏
将进件成功或失败的消息通知给开发者/服务商。
使用限制
无
接口说明
- 1.在小程序开发者平台上的担保支付平台设置页面中,填写回调相关配置。回调 token 与回调 url。该回调地址为必填项。开发者可以在请求中动态指定回调地址,动态指定地址会覆盖默认配置。
- 2.进件请求如果包含多个渠道,每个渠道进件成功或者失败都会回调通知开发者,可以通过回调通知中的channel参数来区分渠道。
- 3.进件状态请以status为准。
- 4.开发者服务端接收到异步通知时,必须通过验签(验证通知中的 msg_signature 参数)来确保支付通知是由抖音发送的。详细验签规则详见签名DEMO。
- 5.回调可能存在延时,若实时性要求高,开发者可以通过主动请求查询进件结果接口,感知进件结果。
- 6.在开发者服务端收到回调且处理成功后,需要按以下 json 返回表示处理成功,否则小程序服务端会认为通知失败进行重试。
{ "err_no": 0, "err_tips": "success" }
- 5.通知失败的重试时间间隔:15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h。
回调参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
timestamp | string | 是 | 12 | Unix 秒级时间戳,字符串类型 | 1646398076 |
nonce | string | 是 | 4 | 随机数 | 4353 |
msg | string | 是 | - | 进件信息的 json 字符串 | "msg": { "status": "SUCCESS", "channel": "hz", "uid": "70372492201318182840", "apply_time": "2022-03-04 21:10:15", "apply_id": "SMA202202212156514", "sub_status": "SUCCESS", "sub_fail_reason": "" } |
type | string | 是 | 32 | 回调类型标记,进件成功回调为"create_merchant" | create_merchant |
msg_signature | string | 是 | 128 | 详见 | a0e96a41c3fe0bb81ef527f3fb2948dad2fb2616 |
msg 参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
status | string | 是 | - | 进件状态枚举,进件状态判断请以该字段为准 SUCCESS:成功 FAIL:失败 | SUCCESS |
channel | string | 是 | 32 | 渠道枚举: wx: 微信渠道 alipay: 支付宝渠道 hz: 抖音支付渠道 yzt: 担保支付企业版聚合账户 | hz |
uid | string | 是 | 64 | 商户号 | 70372492201318182840 |
apply_time | string | 是 | - | 进件申请时间 | 2022-03-04 21:10:15 |
apply_id | string | 是 | 128 | 申请单id | SMA202202212156514 |
sub_status | string | 是 | - | 渠道进件状态,进件状态判断请以status字段为准 SUCCESS:成功 FAIL:失败 | SUCCESS |
sub_fail_reason | string | 是 | - | 渠道失败原因 | Business Failed:支付宝账号不存在 |
is_new | boolean | 是 | - | 标识抖音信息和光合信号主体 true:光合信号 false:抖音信息 | true |
pay_info_status | string | 条件选填 | - | channel为yzt的场景下必填。 担保支付企业版聚合账户的渠道状态信息,详见下面 渠道进件状态 参数 | {\"wx\":\"SUCCESS\",\"alipay\":\"SUCCESS\",\"hz\":\"SUCCESS\"} |
渠道进件状态
名称 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
wx | string | 是 | - | 聚合账户渠道进件状态枚举: SUCCESS: 成功 FAIL: 失败 | SUCCESS |
alipay | string | 是 | - | 聚合账户渠道进件状态枚举: SUCCESS: 成功 FAIL: 失败 | SUCCESS |
hz | string | 是 | - | 聚合账户渠道进件状态枚举: SUCCESS: 成功 FAIL: 失败 | SUCCESS |
回调示例
{ "msg": { "status": "SUCCESS", "channel": "hz", "uid": "70372492201318182840", "apply_time": "2022-03-04 21:10:15", "apply_id": "SMA202202212156514", "sub_status": "SUCCESS", "sub_fail_reason": "", "is_new": true }, "msg_signature": "a0e96a41c3fe0bb81ef527f3fb2948dad2fb2616", "nonce": "5269", "timestamp": "1646399490", "type": "create_merchant" }
响应示例
正常响应示例
{ "err_no": 0, "err_tips": "success" }
异常响应示例
{ "err_no": 1000, "err_tips": "内部错误,请稍后重试" }