申请退款(SPI)
收藏
我的收藏接口说明
- 1.抖音侧请求第三方申请退款,允许同步返回审核结果。当退款审核结果为接受,若传入手续费小于等于平台计算手续费,以平台计算罚金为准,否则视为拒绝。
- 2.客服发起的退款为免审退款,不会通过此接口请求第三方
基本信息
Scope | life.capacity.trip_order_after_sale_refund_apply | |||
权限要求 | 景区行业解决方案-景区退款审核 | |||
回调场景 | 景区申请退款 |
请求头
- •Content-Type:
application/json
- •X-Bytedance-Logid: 请求 logid, 用于问题排查用
- •x-life-clientkey: 服务商应用的 client_key
- •X-life-sign: 请求签名,签名规则
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
order_id | string | 是 | 抖音侧订单 ID | 100001 |
order_out_id | string | 否 | 第三方订单 ID | 200001 |
biz_uniq_key | string | 是 | 业务唯一键,用于审核回调(可作幂等键) | 123456 |
apply_source | int64 | 否 | 申请退款类型
| |
refund_fee_amount | int | 是 | 抖音侧计算的退款手续费金额,分 | 2345 |
apply_refund_time_unix | int | 是 | 申请退款的时间戳,秒 | 1678859379 |
vouchers | list | 否 | 凭证列表(只有部分退才会给该字段) | |
- entrance | struct | 是 | 景区的入园项目(若入园凭证是单独的凭证,则使用此字段用来传入园凭证。若不是单独的凭证,可使用自定义项目的字段传入) | |
--project_id | string | 是 | 入园项目的唯一标识,与projects中不能重复(核销时需要) | |
-projects | list<object> | 否 | 可自定义的项目(例:景区项目索道A、索道B等) | |
--project_id | string | 是 | 项目唯一标识,不能重复(核销时需要) | |
请求示例
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
data | struct | 是 | | |
- error_code | int | 是 | 错误码
| 0 |
- description | string | 是 | 错误信息 | |
- audit_refund_result | int | 否 | 审核退款结果,当处理成功时必须返回,1 接受,2 拒绝,3 等待审核 | 1 |
- refund_fee_amount | int | 否 | 退款手续费金额,审核退款结果为接受时必须返回,分 | 2340 |
-vouchers | list | 否 | 凭证列表(补码需要) | |
--entrance | struct | 否 | 景区的入园项目(若入园凭证是单独的凭证,则使用此字段用来传入园凭证。若不是单独的凭证,可使用自定义项目的字段传入) | |
---project_id | string | 是 | 入园项目的唯一标识,同一个订单下不能重复(核销时需要) | |
---id_cards | list<string> | 否 | 身份证号码,最多限100个 | |
---qrcodes | list<string> | 否 | 二维码凭证内容,会生成二维码展示,每个字符串长度不能超过512。 | |
---certificate_nos | list<string> | 否 | 券号凭证,最多限100个 | |
---urls | list<string> | 否 | 链接凭证,在C端直接展示此链接,最多XX个 | 需加白使用 |
---credentials | list<object> | 否 | 证件列表 | |
----credential_type | int | 否 | 凭证类型 | 1:身份证 2:港澳通行证 3:台湾通行证 4:回乡证 5:台胞证 6:护照 |
----credential_no | string | 否 | 凭证号 | 不能为空 |
--projects | list<object> | 否 | 可自定义的项目(例:景区项目索道A、索道B等) | |
---project_id | string | 是 | 入园项目的唯一标识,同一个订单下不能重复(核销时需要) | |
---name | string | 是 | 自定义的项目名称(例:景区XXXX索道) | |
---id_cards | list<string> | 否 | 身份证号码,最多限100个 | |
---qrcodes | list<string> | 否 | 二维码凭证,展示为二维码,每个URL长度不能超过512。 | |
---certificate_nos | list<string> | 否 | 券号凭证,在C端展示为数字串,最多限100个 | |
---urls | list<string> | 否 | 链接凭证,在C端直接展示此链接,最多XX个 | 需加白使用 |
---credentials | list<object> | 否 | 证件列表 | |
----credential_type | int | 否 | 凭证类型 | 1:身份证 2:港澳通行证 3:台湾通行证 4:回乡证 5:台胞证 6:护照 |
----credential_no | string | 否 | 凭证号 | 不能为空 |
响应示例
{ "data": { "error_code": 0, "description": "", "audit_refund_result": 1, "refund_fee_amount": 100 } }
错误码
- •重试(最多 15次)
- ◦创建订单失败(error_code!=0 )并且 error_code!=100
- ◦服务商返回结果不符合协议,比如字段类型错误
- •幂等
- ◦为防止重试导致的重复申请,服务商可根据抖音 biz_uniq_key 做幂等处理
error_code | description | 备注 |
0 | | 成功,只要有明确的审核结果 |
100 | ... | 抖音侧需要重试,其他错误码抖音不重试 |