92 lines
3.6 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

PaymentCheck:
post:
tags:
- 账单管理
summary: 缴费单对账
description: |
代理收费向公用事业单位发起的缴费单对账请求接口。
由代理收费公司每天日切后,进行批处理,自动生成和传送对账文件给公用事业单位。
## 交易码说明
- 请求交易码PayCheck
- 应答交易码PayCheckRes
## 对账文件格式
对账文件为文本文件txt格式编码格式为UTF-8包括明细行和汇总行。
行内每个分项之间以"|"为分隔符。
### 汇总行格式
`交易笔数|总金额`
### 明细行格式
`交易日期|交易流水号|客户编号|缴费金额|二级渠道|交易类型`
operationId: paymentCheck
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/PaymentCheckRequest'
example: |
<?xml version="1.0" encoding="GBK"?>
<in>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>PayCheck</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<companyId>654321</companyId>
<payDate>20240101</payDate>
<payCount>10</payCount>
<payMoney>150000</payMoney>
<fileName>654321_20240101.txt</fileName>
</in>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/PaymentCheckRequest'
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/PaymentCheckResponse'
example: |
<?xml version="1.0" encoding="GBK"?>
<out>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>PayCheckRes</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<RespCode>AAAAAAA</RespCode>
<RespMessage>对账成功</RespMessage>
<companyId>654321</companyId>
<payDate>20240101</payDate>
<payAmount>150000</payAmount>
</out>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/PaymentCheckResponse'
'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: []