文档中心 企业收付平台 API 文档 企业收付相关接口 云鉴-查询银行在途清算结果

云鉴-查询银行在途清算结果

最近更新时间:2020-04-08 08:18:04

1. 接口描述

接口请求域名: cpdp.tencentcloudapi.com 。

查询银行在途清算结果。查询时间段内交易网的在途清算结果。

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:QueryBankClear。
Version String 公共参数,本接口取值:2019-08-20。
Region String 公共参数,本接口不需要传递此参数。
MrchCode String String(22),商户号(签约客户号)
FunctionFlag String STRING(2),功能标志(1: 全部; 2: 指定时间段)
PageNum String STRING (10),页码(起始值为1,每次最多返回20条记录,第二页返回的记录数为第21至40条记录,第三页为41至60条记录,顺序均按照建立时间的先后)
StartDate String STRING(8),开始日期(若是指定时间段查询,则必输,当查询全部时,不起作用。格式: 20190101)
EndDate String STRING(8),终止日期(若是指定时间段查询,则必输,当查询全部时,不起作用。格式:20190101)
ReservedMsg String STRING(1027),保留域

3. 输出参数

参数名称 类型 描述
TxnReturnCode String String(20),返回码
TxnReturnMsg String String(100),返回信息
CnsmrSeqNo String String(22),交易流水号
ResultNum String STRING (10),本次交易返回查询结果记录数
注意:此字段可能返回 null,表示取不到有效值。
StartRecordNo String STRING(30),起始记录号
注意:此字段可能返回 null,表示取不到有效值。
EndFlag String STRING(2),结束标志(0: 否; 1: 是)
注意:此字段可能返回 null,表示取不到有效值。
TotalNum String STRING (10),符合业务查询条件的记录总数(重复次数, 一次最多返回20条记录)
注意:此字段可能返回 null,表示取不到有效值。
TranItemArray Array of ClearItem 交易信息数组
注意:此字段可能返回 null,表示取不到有效值。
ReservedMsg String STRING(1027),保留域
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询银行在途清算结果

输入示例

https://xxx.tencentcloudapi.com/?Action=QueryBankClear
&Placement.Zone=ap-guangzhou-2
&ImageId=img-pmqg1cw7
&<公共请求参数>
&MrchCode=1234&FunctionFlag=1&PageNum=1

输出示例

{
  "Response": {
    "TranItemArray": [
      {
        "SubAcctType": "7",
        "TotalAmt": "0.0",
        "ClearingReturnMsg": "",
        "ReconcileReturnMsg": "在途对账成功",
        "ClearingStatus": "0",
        "Date": "20191018",
        "ReconcileStatus": "0"
      }
    ],
    "TxnReturnCode": "000000",
    "EndFlag": "1",
    "TotalNum": "1",
    "RequestId": "123123123123123123",
    "ResultNum": "1",
    "TxnReturnMsg": "交易成功",
    "ReservedMsg": "",
    "CnsmrSeqNo": "123123123123123",
    "StartRecordNo": "1"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.BackendError 云鉴内部调用失败。
InternalError.BackendError 后端服务访问错误。
InternalError.DBAccessError 数据库访问错误。
InternalError.FundSummaryAcctNoInconsistentError 资金汇总账号不一致错误。
InternalError.ParameterError 参数错误。
InternalError.SaveDBError 数据保存失败。
InternalError.SubAccountNotFoundError 子账户不存在错误。
InternalError.Unknown 内部错误。
InternalError.UnkownError 未知错误。