channelLink

阿凡达平台对接外部渠道,如果渠道方需要使用专用接口,即对接使用渠道方的接口文档。如果渠道方没有定制接口需求,则按照阿凡达平台接口文档规范进行交互


3.10 退保通知接口

<p>请求模式:鸿雁平台→渠道</p> <p>接口描述:退保通知,保司端发起的退保通知渠道方</p> <p>测试接口地址:渠道方地址</p> <p>生产接口地址:渠道方地址</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>refundNoticeBody</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>endorseNo</td> <td>varchar</td> <td>Y</td> <td></td> </tr> <tr> <td>退保类型</td> <td>refundType</td> <td>varchar</td> <td>Y</td> <td>退保类型(核心返回类型)&lt;br&gt; 0-正常退:以下除外的所有场景 &lt;br&gt;1-全额退:非犹豫期内,倒签情况下的保费全退场景 &lt;br&gt;2-犹豫期内退保:批改生效日期和批改日期均在犹豫期内的退保场景 &lt;br&gt;3-当期退:通过通融退接口退保且除第一期保费外其他期次整期退保的场景 &lt;br&gt;4-未生效退保:保单未起保发起的退保场景 &lt;br&gt;5-脱保退保 &lt;br&gt;<del>6-满期后退保</del> &lt;br&gt; <del>87-理赔解约退保</del></td> </tr> <tr> <td>退保生效时间</td> <td>refundEffectTime</td> <td>DateTime</td> <td>Y</td> <td></td> </tr> <tr> <td>核批通知时间</td> <td>undwrtEndDate</td> <td>DateTime</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>installmentsDetails</td> <td>List&lt;Object&gt;</td> <td>Y</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>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> <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>respBody</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>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> </tbody> </table> <h3>报文示例</h3> <h4>请求</h4> <pre><code class="language-json">{ &amp;quot;head&amp;quot;: { &amp;quot;interfaceType&amp;quot;: &amp;quot;refundNotice&amp;quot;, &amp;quot;orderNo&amp;quot;: &amp;quot;T202212061421334356257&amp;quot;, &amp;quot;policySource&amp;quot;: &amp;quot;PHN_ZAZX&amp;quot;, &amp;quot;reqTime&amp;quot;: 1671174972039, &amp;quot;uuid&amp;quot;: &amp;quot;d33fc78d-c44a-4f7d-8866-35682656b515&amp;quot; }, &amp;quot;refundNoticeBody&amp;quot;: { &amp;quot;endorseNo&amp;quot;: &amp;quot;X00272634220121341579_001&amp;quot;, &amp;quot;installmentsDetails&amp;quot;: [ { &amp;quot;num&amp;quot;: 1, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 121.00 }, { &amp;quot;num&amp;quot;: 2, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 3, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 4, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 5, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 6, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 7, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 8, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 9, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 10, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 11, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 }, { &amp;quot;num&amp;quot;: 12, &amp;quot;paymentAmount&amp;quot;: 121.00, &amp;quot;refundAmount&amp;quot;: 0.00 } ], &amp;quot;policyNo&amp;quot;: &amp;quot;X00272634220121341579&amp;quot;, &amp;quot;refundEffectTime&amp;quot;: 1670342400000, &amp;quot;refundPremium&amp;quot;: 121.00, &amp;quot;refundType&amp;quot;: &amp;quot;2&amp;quot; } } </code></pre> <h4>返回</h4> <pre><code class="language-json">{ &amp;quot;head&amp;quot;: { &amp;quot;interfaceType&amp;quot;: &amp;quot;refundNotice&amp;quot;, &amp;quot;orderNo&amp;quot;: &amp;quot;T202212061421334356257&amp;quot;, &amp;quot;policySource&amp;quot;: &amp;quot;PHN_ZAZX&amp;quot;, &amp;quot;respTime&amp;quot;: &amp;quot;2022-12-16 15:16:13&amp;quot;, &amp;quot;reqTime&amp;quot;: 1671174972039, &amp;quot;uuid&amp;quot;: &amp;quot;d33fc78d-c44a-4f7d-8866-35682656b515&amp;quot; }, &amp;quot;respBody&amp;quot;: { &amp;quot;dealCode&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;policyNo&amp;quot;: &amp;quot;X00272634220121341579&amp;quot;, &amp;quot;dealDesc&amp;quot;: &amp;quot;处理成功&amp;quot; } }</code></pre>

页面列表

ITEM_HTML