107 lines
4.3 KiB
YAML
107 lines
4.3 KiB
YAML
CustomerCheck:
|
||
post:
|
||
tags:
|
||
- 账单管理
|
||
summary: 客户基本信息查询
|
||
description: |
|
||
银行向公用事业单位发起的客户基本信息查询请求接口。
|
||
用于查询客户的基本信息，包括客户姓名、联系方式、地址等详细信息。
|
||
|
||
## 交易码说明
|
||
- 请求交易码：CustomerCheck
|
||
- 应答交易码：CustomerCheckRes
|
||
|
||
## 查询信息包括
|
||
- 客户基本信息：姓名、身份证号等
|
||
- 客户联系信息：电话、地址等
|
||
- 客户状态信息：账户状态、服务状态等
|
||
- 历史缴费记录摘要
|
||
|
||
## 使用场景
|
||
- 客户信息核验
|
||
- 代扣协议签约前的客户信息确认
|
||
- 客户服务和支持
|
||
- 风险评估和反欺诈检查
|
||
|
||
operationId: customerCheck
|
||
parameters:
|
||
- $ref: '../components/parameters.yaml#/components/parameters/ContentTypeHeader'
|
||
- $ref: '../components/parameters.yaml#/components/parameters/EncryptTypeHeader'
|
||
- $ref: '../components/parameters.yaml#/components/parameters/EncryptModeHeader'
|
||
- $ref: '../components/parameters.yaml#/components/parameters/DataTypeHeader'
|
||
requestBody:
|
||
required: true
|
||
content:
|
||
application/xml:
|
||
schema:
|
||
$ref: '../components/schemas.yaml#/components/schemas/CustomerCheckRequest'
|
||
example: |
|
||
<?xml version="1.0" encoding="GBK"?>
|
||
<in>
|
||
<Version>1.0.1</Version>
|
||
<InstId>00001</InstId>
|
||
<TranCode>CustomerCheck</TranCode>
|
||
<TranDate>20240101</TranDate>
|
||
<TranSeq>123456789012</TranSeq>
|
||
<billKey>123456</billKey>
|
||
<companyId>654321</companyId>
|
||
<queryType>0</queryType>
|
||
<contractNo>CONTRACT001</contractNo>
|
||
<filed1></filed1>
|
||
<filed2></filed2>
|
||
</in>
|
||
application/json:
|
||
schema:
|
||
$ref: '../components/schemas.yaml#/components/schemas/CustomerCheckRequest'
|
||
responses:
|
||
'200':
|
||
description: 客户基本信息查询成功
|
||
headers:
|
||
Content-Type:
|
||
$ref: '../components/headers.yaml#/components/headers/ContentType'
|
||
X-Response-Time:
|
||
$ref: '../components/headers.yaml#/components/headers/ResponseTime'
|
||
X-Request-Id:
|
||
$ref: '../components/headers.yaml#/components/headers/RequestId'
|
||
content:
|
||
application/xml:
|
||
schema:
|
||
$ref: '../components/schemas.yaml#/components/schemas/CustomerCheckResponse'
|
||
example: |
|
||
<?xml version="1.0" encoding="GBK"?>
|
||
<out>
|
||
<Version>1.0.1</Version>
|
||
<InstId>00001</InstId>
|
||
<TranCode>CustomerCheckRes</TranCode>
|
||
<TranDate>20240101</TranDate>
|
||
<TranSeq>123456789012</TranSeq>
|
||
<RespCode>AAAAAAA</RespCode>
|
||
<RespMessage>查询成功</RespMessage>
|
||
<billKey>123456</billKey>
|
||
<companyId>654321</companyId>
|
||
<contractNo>CONTRACT001</contractNo>
|
||
<customerName>张三</customerName>
|
||
<customerPhone>13812345678</customerPhone>
|
||
<customerAddress>北京市朝阳区xxx街道xxx号</customerAddress>
|
||
<customerStatus>1</customerStatus>
|
||
<serviceStatus>1</serviceStatus>
|
||
<registerDate>20200101</registerDate>
|
||
<lastPayDate>20231215</lastPayDate>
|
||
<totalPayCount>36</totalPayCount>
|
||
<totalPayAmount>540000</totalPayAmount>
|
||
<filed1></filed1>
|
||
<filed2></filed2>
|
||
<filed3></filed3>
|
||
</out>
|
||
application/json:
|
||
schema:
|
||
$ref: '../components/schemas.yaml#/components/schemas/CustomerCheckResponse'
|
||
'400':
|
||
$ref: '../components/responses.yaml#/components/responses/BusinessError'
|
||
'500':
|
||
$ref: '../components/responses.yaml#/components/responses/SystemError'
|
||
'403':
|
||
$ref: '../components/responses.yaml#/components/responses/SecurityError'
|
||
security:
|
||
- ApiKeyAuth: []
|
||
- EncryptedData: [] |