3.8 退保试算接口
<p>[TOC]</p>
<p>请求模式：渠道方→鸿雁平台</p>
<p>接口描述：退保试算，试算退保金额不会对保单进行退保</p>
<p>测试接口地址：<a href="https://hermesgyb.zhlic.net/avatar/refund/refundCal">https://hermesgyb.zhlic.net/avatar/refund/refundCal</a></p>
<p>生产接口地址：<a href="https://gyb.zhlic.net/avatar/refund/refundCal">https://gyb.zhlic.net/avatar/refund/refundCal</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>reqTime</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>refundCalBody</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,正常退时必传</td>
</tr>
<tr>
<td>退保方式</td>
<td>refundMoneyType</td>
<td>varchar</td>
<td>Y</td>
<td>0-正常退 1-全单退 2-当期全额退</td>
</tr>
<tr>
<td>退保起始期次</td>
<td>refundBeginPeriod</td>
<td>Integer</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>refundCalRespBody</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>refundPremium</td>
<td>BigDecimal</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>Y</td>
<td>每一期次的缴费信息</td>
</tr>
<tr>
<td>团单人团清单</td>
<td>insuredDetails</td>
<td>List<Object></td>
<td>N</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>Integer</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>本期退款金额</td>
<td>refundAmount</td>
<td>Integer</td>
<td>Y</td>
<td>当期退时,必传, 会将退保开始的期次之后的已缴费用退还</td>
</tr>
</tbody>
</table>
<p><code>insuredDetails</code></p>
<table>
<thead>
<tr>
<th>字段名称</th>
<th>字段代码</th>
<th>类型</th>
<th>是否必传</th>
<th>字段描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>姓名</td>
<td>insuredName</td>
<td>varchar</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>证件号</td>
<td>identifyNo</td>
<td>varchar</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>起保时间</td>
<td>startDate</td>
<td>DateTime</td>
<td>Y</td>
<td></td>
</tr>
<tr>
<td>终保时间</td>
<td>endDate</td>
<td>DateTime</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;refundCal&quot;,
&quot;orderNo&quot;: &quot;QS221218222618843C40T59&quot;,
&quot;policySource&quot;: &quot;HN_HT_QNW&quot;,
&quot;reqTime&quot;: &quot;2022-12-1823: 53: 11&quot;,
&quot;uuid&quot;: &quot;82faa759-00c2-477f-a282-cb354b174945 &quot;
},
&quot;refundCalBody&quot;: {
&quot;policyNo&quot;: &quot;X11002749220000963418&quot;,
&quot;refundEffectTime&quot;: &quot;2022-12-19 09:15:00&quot;,
&quot;refundMoneyType&quot;: &quot;1&quot;,
&quot;refundReqTime&quot;: &quot;2022-12-18 23:53:11&quot;
}
}
</code></pre>
<h4>返回</h4>
<pre><code class="language-json">{
&quot;head&quot;: {
&quot;interfaceType&quot;: &quot;refundCal&quot;,
&quot;orderNo&quot;: &quot;QS221218222618843C40T59&quot;,
&quot;policySource&quot;: &quot;HN_HT_QNW&quot;,
&quot;respTime&quot;: 1671378792233,
&quot;uuid&quot;: &quot;82faa759-00c2-477f-a282-cb354b174945&quot;
},
&quot;refundCalRespBody&quot;: {
&quot;dealCode&quot;: &quot;1&quot;,
&quot;dealDesc&quot;: &quot;成功&quot;,
&quot;installmentsDetails&quot;: [
{
&quot;num&quot;: 1,
&quot;paymentAmount&quot;: 40.00,
&quot;refundAmount&quot;: 40.00
}
],
&quot;policyNo&quot;: &quot;X11002749220000963418&quot;,
&quot;refundPremium&quot;: 40.00,
&quot;refundType&quot;: &quot;4&quot;
}
}
</code></pre>