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

96 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.

WithholdingCancelDisc:
post:
tags:
- 代扣管理
summary: 取消代扣交易
description: |
银行向公用事业单位发起的取消代扣交易请求接口。
用于取消已经发起但尚未完成的代扣交易。
## 交易码说明
- 请求交易码CancelDisc
- 应答交易码CancelDiscRes
## 使用场景
- 代扣交易发起后,用户要求取消
- 代扣交易异常需要撤销
- 银行系统故障需要回滚交易
## 注意事项
- 只能取消当天发起的代扣交易
- 已经成功扣款的交易不能取消,需要通过退款流程处理
- 取消成功后,相关的代扣协议仍然有效
operationId: withholdingCancelDisc
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/WithholdingCancelDiscRequest'
example: |
<?xml version="1.0" encoding="GBK"?>
<in>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>CancelDisc</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<billKey>123456</billKey>
<companyId>654321</companyId>
<originalTranSeq>ORIG123456789012</originalTranSeq>
<originalTranDate>20240101</originalTranDate>
<cancelReason>用户申请取消</cancelReason>
<contractNo>CONTRACT001</contractNo>
<payAmount>15000</payAmount>
</in>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/WithholdingCancelDiscRequest'
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/WithholdingCancelDiscResponse'
example: |
<?xml version="1.0" encoding="GBK"?>
<out>
<Version>1.0.1</Version>
<InstId>00001</InstId>
<TranCode>CancelDiscRes</TranCode>
<TranDate>20240101</TranDate>
<TranSeq>123456789012</TranSeq>
<RespCode>AAAAAAA</RespCode>
<RespMessage>取消代扣交易成功</RespMessage>
<billKey>123456</billKey>
<companyId>654321</companyId>
<originalTranSeq>ORIG123456789012</originalTranSeq>
<cancelStatus>1</cancelStatus>
<cancelTime>20240101120000</cancelTime>
</out>
application/json:
schema:
$ref: '../components/schemas.yaml#/components/schemas/WithholdingCancelDiscResponse'
'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: []