退款结果通知
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/api/v2/result_callback
注意事项
基本信息
基本信息 | |
---|---|
HTTP URL | 请参考解决方案使用指南配置消息 |
HTTP Method | POST |
msg 字段
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
app_id | string | 是 | 小程序 id | ttcfdbb96650e33350 |
status | string | 是 | 退款状态枚举值: SUCCESS:退款成功 FAIL:退款失败 | SUCCESS |
order_id | string | 是 | 抖音开平侧订单号 | ot7057435515980663048 |
refund_id | string | 是 | 抖音开平侧退款单号 | ot7057416814925531429 |
refund_item_detail | Json Object | 是 | 退款商品单信息 | |
out_refund_no | string | 是 | 开发者自定义的退款单号(可能为空) | 5304340298302398023 |
cp_extra | string | 是 | 退款时开发者传入字段 | whatever |
refund_total_amount | int64 | 是 | 退款金额,单位分 | 9900 |
is_all_settled | bool | 是 | 是否为分账后退款 | false |
event_time | int64 | 是 | 退款时间戳,单位为毫秒 | 1643189272388 |
message | string | 否 | 结果描述信息,如失败原因 | |
refund_type | int64 | 否 | 退款来源类型,枚举值: 1:交易模板发起 2:开发者发起 3:商品过期自动发起退款 4:抖音客服退款 5:预约失败自动退款 | 1 |
refund_item_detail 字段
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
item_order_quantity | int64 | 是 | 用户退款商品单数量 | 3 |
item_order_detail | Json Object | 是 | 本次退款的商品单 |
item_order_detail 字段
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
item_order_id | string | 是 | 抖音开平侧商品单id | ot7057435515980663048 |
refund_amount | int64 | 是 | 该商品单退款金额,单位分 | 3300 |
msg 字段内容示例
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/v2/result_callback?timestamp=1345678901234&nonce=iuy987q4htafreqw' \
--header 'Content-Type: application/json' \
--data-raw '{
"version": "2.0", //本次固定为2.0, 通过版本信息识别,用不同的结构体去解析上述关键参数
"msg": "{\"app_id\":\"ttcfdbb96650e33350\",\"status\":\"SUCCESS\",\"order_id\":\"ot7057422956397562142\",\"cp_extra\":\"\",\"message\":\"\",\"event_time\":1643185934447,\"refund_id\":\"ot7057422412346034445\",\"out_refund_no\":\"ext_order_no_1643185898403\",\"refund_total_amount\":1,\"is_all_settled\":false,\"refund_item_detail\":{\"item_order_quantity\":1,\"item_order_detail\":[{\"refund_amount\":1,\"item_order_id\":\"ot7057422956397594910\"}]}}",
"type": "refund"
}'
响应示例响应示例
200 - 成功示例
{
"err_no": 0,
"err_tips": "success"
}
请求参数
Query 参数
timestamp
string
必需
示例值:
1345678901234
nonce
string
必需
示例值:
iuy987q4htafreqw
Header 参数
Content-Type
string
必需
示例值:
application/json
Body 参数application/json