fujian_water_biz_doc/docs/api/openapi/main/paths/withholding-send-disc-check.yaml

99 lines
3.9 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.

WithholdingSendDiscCheck:
post:
tags:
- 代扣管理
summary: 代扣送盘状态查询
description: |
银行向公用事业单位发起的代扣送盘状态查询请求接口。
用于查询已发起的代扣送盘交易的当前处理状态。
## 交易码说明
- 请求交易码SendDiscCheck
- 应答交易码SendDiscCheckRes
## 查询状态说明
- 0: 待处理
- 1: 处理中
- 2: 处理成功
- 3: 处理失败
- 4: 已取消
## 使用场景
- 银行系统需要确认送盘交易状态
- 处理异常情况的状态核查
- 定时批量状态查询
operationId: withholdingSendDiscCheck
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/WithholdingSendDiscCheckRequest'
example: |
<?xml version="1.0" encoding="GBK"?>
<in>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>SendDiscCheck</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<billKey>123456</billKey>
<companyId>654321</companyId>
<originalTranSeq>ORIG123456789012</originalTranSeq>
<originalTranDate>20240101</originalTranDate>
<contractNo>CONTRACT001</contractNo>
</in>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/WithholdingSendDiscCheckRequest'
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/WithholdingSendDiscCheckResponse'
example: |
<?xml version="1.0" encoding="GBK"?>
<out>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>SendDiscCheckRes</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<RespCode>AAAAAAA</RespCode>
<RespMessage>查询成功</RespMessage>
<billKey>123456</billKey>
<companyId>654321</companyId>
<originalTranSeq>ORIG123456789012</originalTranSeq>
<discStatus>2</discStatus>
<discStatusDesc>处理成功</discStatusDesc>
<discTime>20240101120000</discTime>
<payAmount>15000</payAmount>
<failReason></failReason>
</out>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/WithholdingSendDiscCheckResponse'
'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: []