3.9 退保接口
<p>[TOC]</p>
<p>请求模式：渠道方→鸿雁平台</p>
<p>接口描述：退保</p>
<p>测试接口地址：<a href="https://hermesgyb.zhlic.net/avatar/refund/refundOrder">https://hermesgyb.zhlic.net/avatar/refund/refundOrder</a></p>
<p>生产接口地址：<a href="https://gyb.zhlic.net/avatar/refund/refundOrder">https://gyb.zhlic.net/avatar/refund/refundOrder</a></p>
<h3>请求头</h3>
<p><code>head</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>渠道代码</td>
<td>policySource</td>
<td>varchar</td>
<td>Y</td>
<td>保险公司分配给 渠道方的渠道编码</td>
</tr>
<tr>
<td>请求时间</td>
<td>repTime</td>
<td>DateTime</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>接口类型</td>
<td>interfaceType</td>
<td>varchar</td>
<td>Y</td>
<td>针对每个接口，使用接口的API信息</td>
</tr>
<tr>
<td>订单号</td>
<td>orderNo</td>
<td>varchar</td>
<td>Y</td>
<td>贯穿保单始终的订单号， 要求必须唯一，会进行幂等检查</td>
</tr>
<tr>
<td>唯一标识符</td>
<td>uuid</td>
<td>varchar</td>
<td>Y</td>
<td>单次请求唯一标识符，任一次请求不允许相同</td>
</tr>
</tbody>
</table>
<h3>请求体</h3>
<p><code>refundOrderBody</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>保单号</td>
<td>policyNo</td>
<td>varchar</td>
<td>Y</td>
<td>保单唯一标识信息</td>
</tr>
<tr>
<td>退保请求时间</td>
<td>refundReqTime</td>
<td>DateTime</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>退保生效时间</td>
<td>refundEffectTime</td>
<td>DateTime</td>
<td>CY</td>
<td>退保类型为0,正常退必传,格式:yyyy-MM-dd, 具体看 [退保规则](<a href="https://www.showdoc.com.cn/avatarPlus/9922410612010094">https://www.showdoc.com.cn/avatarPlus/9922410612010094</a> "退保规则")</td>
</tr>
<tr>
<td>退保保费</td>
<td>refundPremium</td>
<td>BigDecimal</td>
<td>CY</td>
<td></td>
</tr>
<tr>
<td>退保方式</td>
<td>refundMoneyType</td>
<td>varchar</td>
<td>Y</td>
<td>0-正常退<br> 1-全单退<br> 2-当期全额退<br>4-脱保退</td>
</tr>
<tr>
<td>退保起始期次</td>
<td>refundBeginPeriod</td>
<td>Integer</td>
<td>CY</td>
<td>当期退时,必传, 会将退保开始的期次之后的已缴费用退还</td>
</tr>
<tr>
<td>退保总保费</td>
<td>sumPremium</td>
<td>BigDecimal</td>
<td>CY</td>
<td>当期退时，必传</td>
</tr>
<tr>
<td>批改生效日</td>
<td>validDate</td>
<td>Date</td>
<td>CY</td>
<td></td>
</tr>
<tr>
<td>收款人账户</td>
<td>cAcctNme</td>
<td>varchar</td>
<td>CY</td>
<td>资金退必传</td>
</tr>
<tr>
<td>收款人账号</td>
<td>cAcctNo</td>
<td>varchar</td>
<td>CY</td>
<td>资金退必传</td>
</tr>
<tr>
<td>收款银行大类</td>
<td>cBankRelTyp</td>
<td>varchar</td>
<td>CY</td>
<td>资金退必传 ---见附件</td>
</tr>
<tr>
<td>开户行</td>
<td>cBankCde</td>
<td>varchar</td>
<td>CY</td>
<td>资金退必传 ---见附件</td>
</tr>
<tr>
<td>CNAPS号</td>
<td>cBankCnaps</td>
<td>varchar</td>
<td>CY</td>
<td>资金退必传 ---见附件</td>
</tr>
<tr>
<td>批改原因</td>
<td>endorseReason</td>
<td>varchar</td>
<td>CY</td>
<td></td>
</tr>
</tbody>
</table>
<h3>响应头</h3>
<p><code>head</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>渠道代码</td>
<td>policySource</td>
<td>varchar</td>
<td>Y</td>
<td>保险公司分配给 渠道方的渠道编码</td>
</tr>
<tr>
<td>响应时间</td>
<td>respTime</td>
<td>DateTime</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>接口类型</td>
<td>interfaceType</td>
<td>varchar</td>
<td>Y</td>
<td>针对每个接口，使用接口的API信息</td>
</tr>
<tr>
<td>订单号</td>
<td>orderNo</td>
<td>varchar</td>
<td>Y</td>
<td>贯穿保单始终的订单号， 要求必须唯一，会进行幂等检查</td>
</tr>
<tr>
<td>唯一标识符</td>
<td>uuid</td>
<td>varchar</td>
<td>Y</td>
<td>单次请求唯一标识符，任一次请求不允许相同</td>
</tr>
</tbody>
</table>
<h3>响应体</h3>
<p><code>refundOrderBodyResp</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>保单号</td>
<td>policyNo</td>
<td>varchar</td>
<td>CY</td>
<td></td>
</tr>
<tr>
<td>批单号</td>
<td>endorseNo</td>
<td>varchar</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>退保类型</td>
<td>refundType</td>
<td>varchar</td>
<td>Y</td>
<td>退保类型 1. 保障期前及保障期当日退保 2. 保障期内退保 3. 保期最后一天退保 4. 犹豫期内退保 5. 犹豫期最后一天退保 6. 犹豫期后退保</td>
</tr>
<tr>
<td>实退保费</td>
<td>refundPremium</td>
<td>BigDecimal</td>
<td>CY</td>
<td></td>
</tr>
<tr>
<td>退保生效时间</td>
<td>refundEffectTime</td>
<td>DateTime</td>
<td>CY</td>
<td></td>
</tr>
<tr>
<td>核批通知时间</td>
<td>undwrtEndDate</td>
<td>DateTime</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>处理状态码</td>
<td>dealCode</td>
<td>varchar</td>
<td>Y</td>
<td>处理结果状态码</td>
</tr>
<tr>
<td>处理结果描述</td>
<td>dealDesc</td>
<td>varchar</td>
<td>Y</td>
<td>处理结果描述</td>
</tr>
<tr>
<td>缴费计划信息</td>
<td>installmentsDetails</td>
<td>List<Object></td>
<td>CY</td>
<td>每一期次的缴费信息</td>
</tr>
<tr>
<td>退保批单</td>
<td>refundEleUrl</td>
<td>varchar</td>
<td>CY</td>
<td>退保批单链接</td>
</tr>
</tbody>
</table>
<p><code>installmentsDetail</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>期次</td>
<td>num</td>
<td>Integer</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>本期应收金额</td>
<td>paymentAmount</td>
<td>BigDecimal</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>本期退款金额</td>
<td>refundAmount</td>
<td>BigDecimal</td>
<td>Y</td>
<td></td>
</tr>
</tbody>
</table>
<h3>报文示例</h3>
<h4>请求</h4>
<pre><code class="language-json">{
&quot;head&quot;: {
&quot;interfaceType&quot;: &quot;refundOrder&quot;,
&quot;orderNo&quot;: &quot;QS221214223652678S12K01&quot;,
&quot;policySource&quot;: &quot;HN_HT_QNW&quot;,
&quot;reqTime&quot;: 1671376565000,
&quot;respTime&quot;: 1671376566367,
&quot;uuid&quot;: &quot;1593b86c-beb6-4d36-a71e-3a048234dbeb&quot;
},
&quot;refundOrderBody&quot;: {
&quot;policyNo&quot;: &quot;X11002749220000946969&quot;,
&quot;refundEffectTime&quot;: 1671349200000,
&quot;refundMoneyType&quot;: &quot;1&quot;,
&quot;refundPremium&quot;: 40.00,
&quot;refundReqTime&quot;: 1671376565000,
&quot;validHour&quot;: 0
}
}
</code></pre>
<h4>返回</h4>
<pre><code class="language-json">{
&quot;head&quot;: {
&quot;interfaceType&quot;: &quot;refundOrder&quot;,
&quot;orderNo&quot;: &quot;QS221214223652678S12K01&quot;,
&quot;policySource&quot;: &quot;HN_HT_QNW&quot;,
&quot;reqTime&quot;: 1671376565000,
&quot;respTime&quot;: 1671376566367,
&quot;uuid&quot;: &quot;1593b86c-beb6-4d36-a71e-3a048234dbeb&quot;
},
&quot;refundOrderBodyResp&quot;: {
&quot;dealCode&quot;: &quot;1&quot;,
&quot;dealDesc&quot;: &quot;退保成功&quot;,
&quot;endorseNo&quot;: &quot;X11002749220000946969_001&quot;,
&quot;installmentsDetails&quot;: [
{
&quot;num&quot;: 1,
&quot;paymentAmount&quot;: 40.00,
&quot;refundAmount&quot;: 40.00
}
],
&quot;policyNo&quot;: &quot;X11002749220000946969&quot;,
&quot;refundEffectTime&quot;: 1671292800000,
&quot;refundPremium&quot;: 40.00
}
}
</code></pre>
<p>[1]: <a href="https://www.showdoc.com.cn/avatarPlus/9922410612010094">https://www.showdoc.com.cn/avatarPlus/9922410612010094</a> "123"</p>