履约完成通知
收藏我的收藏
使用限制
接口说明
•由于网络波动等原因,可能会产生重复的通知消息,接入方需要做好幂等,正确处理。
•回调可能存在延时。
•在开发者服务端收到回调且处理成功后,需要按以下正常返回示例返回并且 HTTP 响应状态码设为 200,否则会认为通知失败进行重试。
•结果通知失败的重试间隔为:10s/10s/30s/1m/2m/3m/4m/5m/6m/7m/8m,一 共重试 10 次。
基本信息
基本信息 | |
HTTP URL | 在解决方案配置-消息通知中指定的回调地址,配置方式参考解决方案配置文档 |
HTTP Method | POST |
权限要求 | 无 |
请求头
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
msg | string | 是 | 订单履约相关信息的 JSON 字符串 | 见下文示例 |
type | string | 是 | 枚举值 ,目前只有固定值:"fulfill" | fulfill |
version | string | 是 | 固定值:"3.0"。回调版本,用于开发者识别回调参数的变更 | 3.0 |
msg 字段:
名称 | 类型 | 是否必填 | 描述 | 示例值 |
app_id | string | 是 | 小程序 id | ttcfdbb0e33350 |
order_id | string | 是 | 商户单订单号 | motb123456789 |
out_order_no | string | 是 | 开发者自己的商户单订单号 | ext_1234567 |
fulfill_type | string | 是 | 履约方式,目前只有固定值:"FULFILL_ON_EXPIRE",表示超期未履约平台自动发起履约 | FULFILL_ON_EXPIRE |
status | string | 是 | 商户单履约状态,目前只有固定值:FULFILL_DONE | FULFILL_DONE |
event_time | int64 | 是 | 履约通知发送时间,毫秒时间戳,可能和履约完成时间有一些差异,取决于重试成功的时间 | 1643189272388 |
item_fulfill_info | json<Object> | 是 | item单履约信息 | |
item_fulfill_info 字段
名称 | 类型 | 是否必填 | 描述 | 示例值 |
item_order_id | string | 是 | item单订单id | motb123456789 |
status | string | 是 | item子单当前履约状态,目前只有固定值:"FULFILL_DONE" | FULFILL_DONE |
fulfill_time | int64 | 是 | 履约完成时间,毫秒时间戳 | 1643189272388 |
请求示例
curl --location --request POST 'https://xxxxxxx.net/api/v2/result_callback?timestamp=1345678901234&nonce=iuy987q4htafreqw' \--header 'Content-Type: application/json' --data-raw='{ "version": "3.0", //本次固定为3.0, 通过版本信息识别,用不同的结构体去解析上述关键参数 "msg": "{\"app_id\": \"ttecbe9a0373d92dd001\",\"order_id\":\"motb74648924143197739964344\",\"out_order_no\": \"test_1738056122196\",\"fulfill_type\":\"FULFILL_ON_EXPIRE\",\"status\":\"FULFILL_DONE\",\"event_time\": 1739002681666,\"item_fulfill_info\":[{\"item_order_id\":\"motb74648928992562240444344\",\"status\":\"FULFILL_DONE\",\"fulfill_time\": 1739002681666}] }"", "type": "fulfill" }'
msg 字段内容示例:
{ "app_id": "ttecbe9a0373d92dd001", "order_id": "motb74648924143197739964344", "out_order_no": "test_1738056122196", "fulfill_type": "FULFILL_ON_EXPIRE", "status": "FULFILL_DONE", "event_time": 1739002681666, "item_fulfill_info": [ { "item_order_id": "motb74648928992562240444344", "status": "FULFILL_DONE", "fulfill_time": 1739002681666 } ] }
响应参数
名称 | 类型 | 描述 | 示例值 |
err_no | int64 | 错误码 | 0 |
err_tips | string | 错误提示 | success |
响应示例
正常示例
//正常返回响应且http状态码为200 //注意: //正常返回时一定要保证err_no和err_tips为下面标准返回方式,不然都认为失败,将会重试 { "err_no" : 0, "err_tips" : "success" }
异常示例
//异常响应或http状态码为非200,//字节服务端会不断重试 { "err_no": 1, //非0 "err_tips": "system error" //非success }
错误码
系统通知,无错误码。