T∕CBA 213.1-2023 银行函证服务平台 应用编程接口 第1部分：直连函证服务平台

ICS03.060;35.240.40CCSA11团 体 标 准T/CBA213.1—20231Bankingconfirmationserviceplatform-ApplicationProgrammingInterface-Part1:Connectingdirectlytothebankingconfirmationserviceplatform2023-12-26发布 2024-01-01实施中国银行业协会 发布TT/CBA213.1—2023PAGE\*ROMANPAGE\*ROMANIII目  次前  言 III引  言 V范围 6规范性引用文件 6术语和定义 6缩略语 7应用编程接口 8概述 8基本要求 8接口方式 8系统测试 8等级测评 8应用投产 8接口概述 8函证请求方 8交互概述 9函证申请（函证请求方主填） 9函证申请（函证提供方主填） 11函证申请（验资） 14函证撤销 17函证实时状态查询 19函证实时状态批量查询 20函证状态流转记录查询 22函证文件下载 24函证申请秘钥获取 26函证提供方详细信息查询 28函证提供方 29交互概述 29函证状态更新 29回函文件上传 31回函密钥获取 33函证实时状态查询 35函证实时状态批量查询 37函证状态流转记录查询 39请求方汇聚转发平台 41交互概述 41函证申请（函证请求方主填） 41函证申请（函证提供方主填） 44函证申请（验资） 46函证撤销 49函证实时状态查询 51函证实时状态批量查询 52函证状态流转记录查询 55函证文件下载 56函证申请秘钥获取 58函证提供方详细信息查询 60函证提供方汇聚转发平台 61交互概述 62函证提供方汇聚转发平台接口 62附录A （资料性）银行函证服务平台应用编程接口返回码汇总 63返回码编码规则 63函证请求方返回码及返回信息 63函证提供方返回码及返回信息 65附录B （规范性）函证状态码、状态信息及交易状态响应码 67附录C （资料性）银行函证服务平台应用编程接口定义及参数示例 69概述 69函证申请（函证请求方主填） 69函证申请（函证提供方主填） 69函证申请（验资） 70函证撤销 70函证实时状态查询 71函证实时状态批量查询 71函证状态流转记录查询 72函证文件下载 72函证申请秘钥获取 73函证提供方详细信息查询 73函证状态更新 74回函文件上传 74回函密钥获取 75参 考 文 献 76前  言中国银行业协会(ChinaBankingAssociation，CBA)成立于2000年5月，是经中国人民银行和民政2003年中国银监会成立后，中国银行业协会主管单位由中国人民银行变更为中国银监会。2018年3月，原中国银行保险监督管理委员会成立后，中国银行业协会主管单位由中国银监会变更为中国银行保险监督管理委员会。中国银行业协会日常办事机构为秘书处。秘书处设秘书长1名，副秘书长若干名。根据工作需要，中国银行业协会设立32本文件按照T/CBA1—2021《中国银行业协会团体标准化文件的结构和起草规则》的规定起草。本文件是T/CBA2131部分。T/CBA213已经发布了以下部分：——第1部分：直连函证服务平台。请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别专利的责任。T/CBA函证服务平台的工作技术依据系列文件之一，本系列文件结构如下：——T/CBA210——T/CBA211——T/CBA212《银行函证服务平台基础数据元》；——T/CBA213（多部分）《银行函证服务平台应用编程接口》；——T/CBA214《银行函证服务平台运营规则》；——T/CBA215《银行函证服务平台候选分布式账本技术节点接入要求》；——T/CBA216《银行函证服务平台分布式账本应用编程接口》；——T/CBA217《银行函证服务平台分布式账本智能合约》；——T/CBA218《银行函证服务平台汇聚转发平台建设要求》。本文件由中国银行业协会银行函证服务平台服务中心提出。本文件由中国银行业协会银行业产品和服务标准化专业委员会归口。本文件为中国银行业协会制定，其著作权为中国银行业协会所有。本文件为中国银行业协会制定，其著作权为中国银行业协会所有。1512、15层电话：010-66553368010-66291132邮编：100033邮箱：cba.china@传真  言为全面规范银行函证系统各组件间的信息传输，T/CBA213拟由3个部分组成：12——第3部分：连接相关机构。目的在于规范函证服务平台与相关机构之间的联机信息交换。TT/CBA213.1—2023PAGEPAGE10银行函证服务平台应用编程接口第1部分：直连函证服务平台范围本文件界定了银行函证服务平台与直接连入处理银行函证业务的相关方联机交换信息涉及到的术注：在大多数情况下，函证请求方是会计师事务所，函证提供方是银行业金融机构。规范性引用文件（包括所有的修改单适用于本文件。GB/T22239—2019信息安全技术网络安全等级保护基本要求JR/T0101银行业软件测试文档规范T/CBA211—2021银行函证服务平台加密体系T/CBA212—2022银行函证服务平台基本数据元ISO/IEC21778:2017信息技术JSON数据交换语法(Informationtechnology—TheJSONdatainterchangesyntax)术语和定义下列术语和定义适用于本文件。银行函证业务 bankingconfirmationbusiness函证请求方在获取被审计单位授权后，直接向函证提供方发出询证函，函证提供方针对所收到的询证函，查询、核对相关信息并直接提供回函的过程。术语条目注1：函证请求方大多是会计师事务所，函证提供方大多是银行业金融机构。术语条目注2：询证函可能是能够进行数据元解析的，也可能仅是一个图像或不可更改格式的文件。[来源：T/CBA210—2021，3.1，有修改]积极式函证positiveconfirmation要求函证提供方直接向函证请求方回复，表明是否同意询证函所列示的信息，或填列所要求的信息的一种询证方式。1：1312直接向注册会计师回复，表明是否同意询证函所列示的信息，或填列所要求的信息的一种询证方T/CBA1—2021[来源：中国注册会计师审计准则第1312号，第六条，有修改——见术语条目注1]银行询证函（格式一）bankingconfirmationrequest(format1)适用于函证请求方执行财务报表审计业务时积极性函证（3.2）的一种格式要求，主要用于函证提供方对函证请求方掌握信息的确认和补充。1：在《银行函证及回函工作操作指引》中，二、（一）、2核对后回复相符或不符，如不符，银行业金融机构应当提供详细信息。”银行询证函（格式二）bankingconfirmationrequest(format2)适用于函证请求方执行财务报表审计业务时积极性函证（3.2）的一种格式要求，主要用于函证提供方对函证请求方询证账号相关情况的回复。术语条目注1：在《银行函证及回函工作操作指引》中，二、（一）、2项对格式二的描述为“由注册会计师填写需要询证的银行账号等相关信息，由银行业金融机构填写具体信息后回函。”银行询证函（格式三）bankingconfirmationrequest(format3)适用于验资业务的银行询证函格式。函证请求方 bankingconfirmationacquirer向函证提供方发出询证函的银行函证业务参与方。（202012的其他机构。函证提供方 bankingconfirmationprovider响应函证请求方的请求，提供询证回函的银行函证业务参与方。（202012行业金融机构；在本文件中，也包括法律法规所允许的其他机构。公钥publickey非对称密码算法中可公开的密钥。[来源：GB/T25056—2018，3.11]私钥privatekey非对称密码算法中只能由拥有者使用的不公开密钥。[来源：GB/T25056—2018，3.10]数字签名digitalsignature[来源：GB/T25069—2010，76]缩略语下列缩略语适用于本文件。JSON Java脚本对象表示法（JavaScriptObjectNotation）UTF-8 8位Unicode转换格式（8-bitUnicodeTransformationFormat）URL 统一资源定位符（UniformResourceLocator）注1：JSON定义于ISO/IEC21778:2017。注2：UTF-8定义于ISO/IEC10646:2020。应用编程接口概述基本要求应用系统自行开发的，应符合GB/T22239—2019中的要求；应用系统外包开发的，应符合GB/T22239—2019中的要求。接口方式函证请求方、函证提供方和汇聚转发平台应用编程接口支持如下方式之一：协议方式。通过HTTPSISO/IEC21778:2017JSONSDKSDK，需支持Java、C#等主流编程语言。系统测试测试的策划和设计应根据系统实际功能确定。不论采用何种方式开发，测试应符合GB/T22239—2019中的要求。软件测试文档的编制，应符合JR/T0101的规定。注：在必要时，由银行函证服务平台的管理方提供典型测试用例和测试规程。等级测评应按照GB/T22239—2019中的要求进行等级测评，并获得测评报告。应用投产应按照GB/T22239—2019中的要求组织投产。接口概述本文件按如下方式对应用编程接口进行描述：AURLhttpsJSON（key-value）容器使用，参数安排不区分顺序；每个键值对均有必要性属性，其中“M”为必要键值对、“O”为可选键值对、“C”为条件必要键值对；B；C函证请求方交互概述函证请求方应用场景可分为多个视角，其中：从业务上看，函证请求方是银行函证业务的发起方和接收方。函证申请（函证请求方主填）表1 函证申请（函证请求方主填）基本属性名称属性接口名称JSONapplyOnFirstTemplate(JSONparams)接口功能函证请求方提交函证申请URL/bpbcapi/v1/confirmation/application/format1URL参数无请求类型POST请求内容类型application/json字符集UTF-8表2 函证申请（函证请求方主填）输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16M5.1.4函证提供方名称bankNamestring50M5.1.6授权企业网银账户开户行支付系统行号cnapsstring12M5.1.7授权企业网银账户authPayAccountstring34M5.1.8被函证企业名称organizationNamestring60M5.1.9起始日期confirmBeginDatestring10M5.1.10截止日期confirmEndDatestring10M5.2.1发函文件密钥sCodestring/M5.2.2发函文件名confirmationFileNamestring/M5.2.3发函文件正文confirmationTextstring/M表2 函证申请（函证请求方主填）输入参数（续）章节号a中文名称键名字段类型字段长度必要性5.1.11经办人transactorstring60O5.1.12经办人职务transactorTitlestring30O5.1.13经办人电话transactorPhonestring20O5.1.14回函地址replyAddressstring100M5.1.15回函联系人replyContactstring50M5.1.16回函电话replyPhonestring20M5.1.17回函传真replyFaxstring20O5.1.18回函邮编replyPostalCodestring10O5.1.19回函电子邮箱replyEmailstring50OEndb业务参数体bizContentobject/M加密与签名要求：confirmationText”进行加密；函证请求方应使用函证提供方的公钥对键值对“sCode”进行加密；函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表3 函证申请（函证请求方主填）输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表4 函证申请（函证请求方主填）返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000001函证编号已存在请重新输入函证编号2000002银行名称重复请重新输入银行名称2000003银行不存在请输入正确的银行名称表4 函证申请（函证请求方主填）返回码信息及解决方案（续）返回码返回信息解决方案2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000007询证项起止时间格式错误起止日期格式为：yyyy-MM-dd2000008询证项起始时间大于截止时间请输入正确的起止日期2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000012bizContent字段超长请重新输入bizContent2000015联行号格式错误请输入正确的联行号2000016联行号不存在请输入正确的联行号2000017联行号对应机构非收函机构请输入正确的联行号2000018联行号与函证发往的银行不匹配请确认联行号对应得机构是否正确3000005银行不支持当前格式的函证申请请与银行确认支持的函证格式3000011ipAddress校验不通过请确认当前ipAddress是否正确3000012函证开始时间格式不正确，请重新填写日期格式为：yyyy-MM-dd3000013函证结束时间格式不正确，请重新填写日期格式为：yyyy-MM-dd7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent8000005请传入参数：applyFile请传入参数：applyFile8000006申请文件大小不超过平台限制请传入符合平台大小限制的申请文件8000008请传入正确的地址参数请传入正确的地址参数8000010文件名不合法请输入正确的文件名9000001请求区块链失败，区块链响应体为空请确认区块链地址及网络是否正常9000002bokhiRsose请确定平台是否收到请求9000003请求区块链失败，返回状态异常请确认区块链网络及区块链接口参数是否正确9000004请求区块链超时，请稍候再试请稍候再试注：完整的返回码列表参见附录A。函证申请（函证提供方主填）表5 函证申请（函证提供方主填）基本属性名称接口名称属性JSONapplyOnSecondTemplate(JSONparams)接口功能函证请求方提交函证申请URL/bpbcapi/v1/confirmation/application/format2表5 函证申请（函证提供方主填）基本属性（续）名称属性URL参数无请求类型POST请求内容类型application/json字符集UTF-8表6 函证申请（函证提供方主填）输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16M5.1.4银行名称bankNamestring50M5.1.6授权企业网银账户开户联行号cnapsstring12M5.1.7授权企业网银账户authPayAccountstring34M5.1.8被函证企业名称organizationNamestring60M5.1.11经办人transactorstring60O5.1.12经办人职务transactorTitlestring30O5.1.13经办人电话transactorPhonestring20O5.1.14回函地址replyAddressstring100Cc5.1.15回函联系人replyContactstring50Cc5.1.16回函电话replyPhonestring20Cc5.1.17回函传真replyFaxstring20O5.1.18回函邮编replyPostalCodestring10O5.1.19回函电子邮箱replyEmailstring50Cc5.1.20列表项->函证项编号conList->confirmationTypestring3M5.1.21列表项->函证项账户conList->conditionNOstring34M5.1.22列表项->函证项账户名称conList->accountNamestring140O5.1.9列表项->函证项起始日期conList->confirmBeginDatestring10M5.1.10列表项->函证项截止日期conList->confirmEndDatestring10MEndb业务参数体bizContentobject/M表6 函证申请（函证提供方主填）输入参数（续）章节号a中文名称键名字段类型字段长度必要性校验、加密与签名要求：函证提供方可根据实际需要选择是否校验列表项中的字段；bizContent”全文进行加密；bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。c若事务所未提供其它有效联系方式，则回函地址（replyAddress）、回函联系人（replyContact）、回函电话（replyPhone）、回函电子邮箱（replyEmail）为必填项。表7 函证申请（函证提供方主填）输出参数章节号中文名称键名字段类型字段长度存在性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表8 函证申请（函证提供方主填）返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000001函证编号已存在请重新输入函证编号2000002银行名称重复请重新输入银行名称2000003银行不存在请输入正确的银行名称2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000006conList缺少必填参数请输入conList中的必填参数2000007询证项起止时间格式错误起止日期格式为：yyyy-MM-dd2000008询证项起始时间大于截止时间请输入正确的起止日期2000009询证项列表为空请填入询证项2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000012bizContent字段超长请重新输入bizContent表8 函证申请（函证提供方主填）返回码信息及解决方案（续）返回码返回信息解决方案2000013conList字段超长请重新输入conList2000014询证项列表超过最大条数限制请重新填入询证项2000015联行号格式错误请输入正确的联行号2000016联行号不存在请输入正确的联行号2000017联行号对应机构非收函机构请输入正确的联行号2000018联行号与函证发往的银行不匹配请确认联行号对应得机构是否正确3000005银行不支持当前格式的函证申请请与银行确认支持的函证格式3000011ipAddress校验不通过请确认当前ipAddress是否正确3000012函证开始时间格式不正确，请重新填写日期格式为：yyyy-MM-dd3000013函证结束时间格式不正确，请重新填写日期格式为：yyyy-MM-dd7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000000请创建带有blockChainConnBean参数的连接请创建带有blockChainConnBean参数的连接8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent8000003请传入参数：询证项conList请传入参数：询证项conList8000005请传入参数：applyFile请传入参数：applyFile8000006申请文件大小不超过平台限制请传入符合平台大小限制的申请文件8000010文件名不合法请输入正确的文件名9000001请求区块链失败，区块链响应体为空请确认区块链地址及网络是否正常9000002bokhiRsose请确定平台是否收到请求9000003请求区块链失败，返回状态异常请确认区块链网络及区块链接口参数是否正确9000004请求区块链超时，请稍候再试请稍候再试注：完整的返回码列表参见附录A。函证申请（验资）在函证请求方验资时，函证请求方采用银行询证函格式三，应用编程接口信息描述于表9～表12。表9 函证申请（验资）基本属性名称属性接口名称JSONapplyOnThirdTemplate(JSONparams)接口功能函证请求方提交函证申请URL/bpbcapi/v1/confirmation/application/format3URL参数无请求类型POST请求内容类型application/json字符集UTF-8表10 函证申请（验资）输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16M5.1.4银行名称bankNamestring50M5.1.6授权企业网银账户开户联行号cnapsstring12M5.1.7授权企业网银账户authPayAccountstring34M5.1.8被函证企业名称organizationNamestring60M5.1.9起始日期confirmBeginDatestring10M5.1.10截止日期confirmEndDatestring10M5.2.1发函文件密钥sCodestring/M5.2.2发函文件名confirmationFileNamestring/M5.2.3发函文件正文confirmationTextstring/M5.1.11经办人transactorstring60O5.1.12经办人职务transactorTitlestring30O5.1.13经办人电话transactorPhonestring20O5.1.14回函地址replyAddressstring100O5.1.15回函联系人replyContactstring50O5.1.16回函电话replyPhonestring20O5.1.17回函传真replyFaxstring20O5.1.18回函邮编replyPostalCodestring10O5.1.19回函电子邮箱replyEmailstring50OEndb业务参数体bizContentobject/M加密与签名要求：confirmationText”进行加密；函证请求方应使用询证银行的公钥对键值对“sCode”进行加密；函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表11 函证申请（验资）输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表12 函证申请（验资）返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000001函证编号已存在请重新输入函证编号2000002银行名称重复请重新输入银行名称2000003银行不存在请输入正确的银行名称2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000007询证项起止时间格式错误起止日期格式为：yyyy-MM-dd2000008询证项起始时间大于截止时间请输入正确的起止日期2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000012bizContent字段超长请重新输入bizContent2000015联行号格式错误请输入正确的联行号2000016联行号不存在请输入正确的联行号2000017联行号对应机构非收函机构请输入正确的联行号2000018联行号与函证发往的银行不匹配请确认联行号对应得机构是否正确3000005银行不支持当前格式的函证申请请与银行确认支持的函证格式3000011ipAddress校验不通过请确认当前ipAddress是否正确3000012函证开始时间格式不正确，请重新填写日期格式为：yyyy-MM-dd3000013函证结束时间格式不正确，请重新填写日期格式为：yyyy-MM-dd7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent表12 函证申请（验资）返回码信息及解决方案（续）返回码返回信息解决方案8000005请传入参数：applyFile请传入参数：applyFile8000006申请文件大小不超过平台限制请传入符合平台大小限制的申请文件8000008请传入正确的地址参数请传入正确的地址参数8000010文件名不合法请输入正确的文件名9000001请求区块链失败，区块链响应体为空请确认区块链地址及网络是否正常9000002bokhiRsose请确定平台是否收到请求9000003请求区块链失败，返回状态异常请确认区块链网络及区块链接口参数是否正确9000004请求区块链超时，请稍候再试请稍候再试注：完整的返回码列表参见附录A。函证撤销表13 函证撤销基本属性名称属性接口名称JSONrevocation(JSONparams)接口功能函证请求方提交函证撤销URL/bpbcapi/v1/confirmation/revocationURL参数无请求类型POST请求内容类型application/json字符集UTF-8表14 函证撤销输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16MEndb业务参数体bizContentobject/M表14 函证撤销输入参数（续）章节号a中文名称键名字段类型字段长度必要性加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表15 函证撤销输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表16 函证撤销返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000012bizContent字段超长请重新输入bizContent3000001函证编号不存在请输入正确的函证编号3000002该函证状态不可撤销请重新发起函证3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000000请创建带有blockChainConnBean参数的连接请创建带有blockChainConnBean参数的连接8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent9000001请求区块链失败，区块链响应体为空请确认区块链地址及网络是否正常9000002bokhiRsose请确定平台是否收到请求表16 函证撤销返回码信息及解决方案（续）返回码返回信息解决方案9000003请求区块链失败，返回状态异常请确认区块链网络及区块链接口参数是否正确9000004请求区块链超时，请稍候再试请稍候再试注：完整的返回码列表参见附录A。函证实时状态查询函证请求方可调用此接口查询单条函证当前所处的状态，应用编程接口信息描述于表17～表20。表17 函证实时状态查询基本属性名称属性接口名称JSONactuality(JSONparams)接口功能函证请求方查询函证实时状态URL/bpbcapi/v1/confirmation/status/actualityURL参数无请求类型POST请求内容类型application/json字符集UTF-8表18 函证实时状态查询输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16MEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表19 函证实时状态查询输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O表19 函证实时状态查询输出参数（续）章节号中文名称键名字段类型字段长度必要性5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27M5.3.1a函证状态statusstring6MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。a银行函证状态编码规定于表B.1。表20 函证实时状态查询返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确3000001函证编号不存在请输入正确的函证编号3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent注：完整的返回码列表参见附录A。函证实时状态批量查询函证请求方可调用此接口查询多条函证当前所处的状态，应用编程接口信息描述于表21～表24。表21 函证实时状态批量查询基本属性名称属性接口名称JSONactualityBatch(JSONparams)接口功能函证请求方查询函证实时状态URL/bpbcapi/v1/confirmation/status/actualityBatchURL参数无请求类型POST请求内容类型application/json表21 函证实时状态批量查询基本属性（续）名称属性字符集UTF-8表22 函证实时状态批量查询输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号列表upstreamEventSerialNoListstring16C5.1.8函证申请开始日期applicationDateStartstring10C5.1.9函证申请结束日期applicationDateEndstring10C无页码currentPageint10O无每页显示条数limitint10OEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3注：（upstreamEventSerialNoList）applicationDateStarta章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表23 函证实时状态批量查询输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M无总条数totalNumberint10O无每页显示条数limitint10O无页码currentPageint10O5.1.5函证编号applicationList->upstreamEventSerialnostring27M表23 函证实时状态批量查询输出参数（续）章节号中文名称键名字段类型字段长度必要性5.3.1a函证状态applicationList->statusstring6MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。a银行函证状态编码规定于表B.1。表24 函证实时状态批量返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000031函证编号数组长度最大为20请重新输入函证编号2000032申请日期开始与申请日期结束，必须成对传入请同时输入起止申请日期2000033函证编号数组参数错误，参数中有不存在的函证编号请检查列表内的函证编号是否正确2000035函证分页参数不能小于0且每页显示数量要求在10-50之间请输入正确的limit参数2000036函证开始时间不能大于函证结束时间请输入正确的起止申请日期3000011ipAddress校验不通过请确认当前ipAddress是否正确3000012函证开始时间格式不正确，请重新填写日期格式为：yyyy-MM-dd3000013函证结束时间格式不正确，请重新填写日期格式为：yyyy-MM-dd7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent注：完整的返回码列表参见附录A。函证状态流转记录查询表25 函证状态流转记录查询基本属性名称属性接口名称JSONhistory(JSONparams)接口功能函证请求方查询函证状态流转记录URL/bpbcapi/v1/confirmation/status/historyURL参数无请求类型POST请求内容类型application/json字符集UTF-8表26 函证状态流转记录查询输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16MEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表27 函证状态流转记录查询输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27M5.3.1a状态列表->状态statusList->statusstring6M5.3.2状态列表->备注说明statusList->commentsstring500O5.3.3状态列表->更新时间statusList->timeStampstring19M5.3.4状态列表->操作人statusList->operatorstring50O表27 函证状态流转记录查询输出参数（续）章节号中文名称键名字段类型字段长度必要性5.3.5状态列表->操作IPstatusList->ipAddressstring45MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。a银行函证状态编码规定于表B.1。表28 函证状态流转记录查询返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确3000001函证编号不存在请输入正确的函证编号3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent注：完整的返回码列表参见附录A。函证文件下载表29 函证文件下载基本属性名称属性接口名称JSONdownload(JSONparams)接口功能函证请求方下载回函文件URL/bpbcapi/v1/confirmation/downloadURL参数无请求类型请求内容类型POSTapplication/json字符集UTF-8表30 函证文件下载输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring16MEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表31 函证文件下载输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.5函证编号upstreamEventSerialnostring27M5.2.4回函密钥sCodestring/M5.2.5回函文件名confirmationFileNamestring/M5.2.6回函正文confirmationTextstring/MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表32 函证文件下载返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数表32 函证文件下载返回码信息及解决方案（续）返回码返回信息解决方案2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确3000001函证编号不存在请输入正确的函证编号3000003回函文件不存在请与银行确认是否已上传回函文件3000006回函文件准备中，请稍候再试请稍后再试3000008回函文件已销毁，请重新申请请重新发起函证3000010函证当前状态非已回函状态，不可下载回函文件请确认当前函证状态3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent注：完整的返回码列表参见附录A。函证申请秘钥获取表33 函证申请秘钥获取基本属性名称属性接口名称JSONqueryBankPublicKey(JSONparams)接口功能函证请求方获取银行公钥用于加密对称密钥URL/bpbcapi/v1/confirmation/query/bankpublickeyURL参数无请求类型POST请求内容类型application/json字符集UTF-8表34 函证申请秘钥获取输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M表34 函证申请秘钥获取输入参数（续）章节号a中文名称键名字段类型字段长度必要性5.1.4银行名称bankNamestring16MEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表35 函证申请秘钥获取输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.5.1消息IDmsgIdstring32M5.1.4银行名称bankNamestring50M5.2.7银行公钥sCodestring/MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表36 函证申请秘钥获取返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000003银行不存在请输入正确的银行名称2000004缺少必填参数请确认必填参数是否已输入2000005bizContent缺少必填参数请输入bizContent中的必填参数2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确3000004查询的银行公钥不存在请确认银行是否上传公钥3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数8000002请传入参数：bizContent请传入参数：bizContent表36 函证申请秘钥获取返回码信息及解决方案（续）返回码返回信息解决方案注：完整的返回码列表参见附录A。函证提供方详细信息查询表37 函证提供方详细信息查询基本属性名称属性接口名称JSONqueryBankDetail(JSONparams)接口功能函证请求方查询已接入函证平台的银行详细信息(支持的模板类型、接入渠道类型、机构列表、联行号等等)URL/bpbcapi/v1/confirmation/bank/detailURL参数无请求类型POST请求内容类型application/json字符集UTF-8表38 函证提供方详细信息查询输入参数章节号a中文名称键名字段类型字段长度必要性5.1.1函证请求方IDtenantIdstring11M5.1.2函证请求方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.4函证提供方名称bankNamestring50MEndb业务参数体bizContentobject/M加密与签名要求：函证请求方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。表39 函证提供方详细信息查询输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O表39 函证提供方详细信息查询输出参数（续）章节号中文名称键名字段类型字段长度必要性5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentobject/M5.1.4函证提供方名称bankList->bankNamestring50M5.4.1银行金融许可证机构编码abankList->financialCodestring15M5.4.2函证提供方接入渠道bankList->bankChannelstring3M5.4.3函证提供方支持模板类型bankList->templatestring20M5.4.4银行函证业务说明bankList->instructionsstring65535OEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。a银行金融许可证机构编码是由中国银行保险监督委员会依法颁发的特许银行机构经营金融业务的法律文件数字编码。表40 函证提供方详细信息查询返回码信息及解决方案返回码返回信息解决方案0请求成功1000001函证请求方ID不存在请确认是否输入正确函证请求方ID1000002函证请求方ID未启用请联系平台工作人员确定函证请求方启停用情况1000003函证请求方公钥不存在请确认是否输入正确公钥2000004缺少必填参数请确认必填参数是否已输入2000010事务所名称为空或与在平台注册的名称不一致请检查函证请求方名称是否正确2000012bizContent字段超长请重新输入bizContent3000009查询的银行信息不存在请与银行确认是否已上传银行信息3000011ipAddress校验不通过请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000001请传入请求参数请传入请求参数注：完整的返回码列表参见附录A。函证提供方交互概述函证提供方应用场景可分为多个视角，其中：从技术上看，银行函证服务平台是服务提供方，函证提供方是银行函证平台服务的调用方；从业务上看，函证提供方是银行函证业务的服务提供方。函证状态更新表41 函证状态更新基本属性名称属性接口名称JSONcondirmationStatusUpdate(JSONparams)接口功能银行更新函证状态URL/bpbcapi/v1/confirmation/status/updateURL参数无请求类型POST请求内容类型application/json字符集UTF-8表42 函证状态更新输入参数章节号a中文名称键名字段类型字段长度必要性5.1.3函证提供方IDtenantIdstring11M5.1.4函证提供方名称tenantNamestring50M5.5.1消息IDmsgIdstring32M5.5.2消息发送时间timeStampstring19M5.5.3发起方地址ipAddressstring128M5.5.4提交人submitterstring19M5.5.5消息签名signstring300MStartb业务参数体bizContentobject/M5.1.5函证编号upstreamEventSerialnostring27M5.3.1c函证状态statusstring6M5.3.6扣费金额paymentstring10O5.3.2函证状态更新说明commentsstring500OEndb业务参数体bizContentobject/M加密与签名要求：函证提供方应使用私钥对业务参数体“bizContent”全文进行签名；T/CBA211—20216.3a章节号指的是T/CBA212—2021中的章节号。b“start”和“End”之间的信息是JSON报文中的一个对象，即一组信息的集合。c函证提供方函证状态编码规定于表B.1。表43 函证状态更新输出参数章节号中文名称键名字段类型字段长度必要性5.5.6返回代码retCodestring7M5.5.7返回信息retMsgstring100O5.5.5返回消息签名signstring/OStart返回业务参数体responseBizContentstring/M表43 函证状态更新输出参数（续）章节号中文名称键名字段类型字段长度必要性5.5.1消息IDmsgIdobject32M5.1.5函证编号upstreamEventSerialnostring27MEnd返回业务参数体responseBizContentobject/M银行函证服务平台使用平台私钥对返回业务参数体“responseBizContent”内所有键值对进行签名。表44 函证状态更新返回码信息及解决方案返回码返回信息解决方案0请求成功400009请求数据不存在请确认函证编号是否正确400010银行函证状态无法更新，请确认该数据是否可更新为当前状态请确认函证当前状态400011comments长度校验不通过请确认comments是否超过500字符400016当前状态不可更新为目标状态请确认函证当前状态400017函证提供方ID不存在请确认是否输入正确银行ID400018函证提供方ID与函证提供方名称必须匹配请确认银行ID是否正确400019函证提供方ID未启用请确定银行启停用情况3000011ipAddress字段超长请确认当前ipAddress是否正确7000001请求失败，获取响应体异常请确定报文加密是否使用了平台公钥7000002请求失败，返回的responseBizContent为空请确定平台是否收到请求7000003返回消息格式异常请确定平台是否收到请求7000004响应消息验签失败请确认数字签名信息是否正确8000000请创建带有blockChainConnBean参数的连接请创建带有blockChainConnBean参数的连接8000001请传入