DB14-T2543-2022政府非税网上支付平台第三方接入接口规范

DB14/T2543—2022

政府非税网上支付平台第三方接入接口规范

1范围

本文件规定了政府非税网上支付平台第三方接入接口的术语和定义、缩略语、基本要求和接口组成。

本文件适用于政府非税网上支付平台第三方接入接口的设计、开发和应用。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，

仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本

文件。

IETFRFC3629UTF-8,ISO10646转换格式（UTF-8,atransformationformatofISO10646）

3术语和定义

下列术语和定义适用于本文件。

3.1

Base64

Base64是一种基于64个可打印ASCII字符对任意字节数据进行编码的算法。

3.2

siteCode

政府非税收入网上支付平台分配给第三方的接入编码。

3.3

3DES

三重数据加密算法，对每个数据块应用三次加密算法。

3.4

注册中心

存储第三方IP地址和认证信息的服务。

4缩略语

下列缩略语适用于本文件。

HTTP:超文本传输协议（HyperTextTransferProtocol）

URL:统一资源定位符（UniformResourceLocator）

1

DB14/T2543—2022

5基本要求

5.1接口协议

接口协议统一采用HTTP协议。

5.2数据结构

5.2.1基本数据类型

接口基本数据类型见表1。

表1基本数据类型

类型名类型描述类型约束

String文本字符串内容为所有的有效字符

List<>列表类型每一项均为一个子数据项，子数据项编码方式与父数据项编码方式相同

Date日期类型日期表示为：yyyy-MM-dd

Float浮点数类型内容为浮点数类型字符

Int整数类型内容为整型字符

File文件流类型内容为对文件的操作定义

Boolean布尔类型内容为True或False

Time时间类型时间表示为：yyyy-MM-ddHH:mm:ss

5.2.2数据编码方式

应符合IETFRFC3629的规定。

5.2.3数据交换格式

应采用JSON传输数据。

5.3接口调用地址

应向政府非税网上支付平台获取接口调用地址及端口号。

5.4安全策略

5.4.1在政府非税网上支付平台与第三方互联过程中，应采取必要的通信安全措施，采用TLS.IP验证、

数字签名、用户身份验证等方法。

5.4.2应采用Base64加密解密保证数据在传输过程中的机密性。

5.4.3宜使用3DES、MD5及以上算法，保证数据在传输过程中的完整性。

5.4.4验证和授权通过以下两种方式进行：

——确保相互访问的地址是可信任的，相关证书通过数字签名进行验证；

2

DB14/T2543—2022

——IP验证仅为初步验证请求来源的合法性方法。应将第三方的IP及相关认证信息存储至注册中

心，政府非税网上支付平台在收到请求时，将请求的IP和系统认证信息及注册中心进行对比，

确认请求源的合法性。

5.4.5政府非税网上支付平台应通过请求频率和请求配额对单一请求方进行限制。

5.4.6应通过数字签名校验保证数据不被篡改。

6接口组成

6.1接口列表

政府非税网上支付平台第三方接入应支持的接口见表2。

表2接口列表

接口名称接口描述

缴款书开具接口本接口用于生成非税收入缴款书，同时生成统一缴款识别码和项目识别码

缴款书状态查询接口本接口用于查询非税收入缴款书信息

缴款书作废接口本接口用于对已经开具的缴款书进行作废（缴款书必须是未缴款状态）

退付申请接口本接口用于对已缴款的缴款书进行退付申请（缴款书必须是已缴款状态）

本接口用于对已提交缴款书退付申请进行终止（缴款书必须是已缴款状态并且已提

退付申请终止接口

交退付申请）

缴款书明细查询接口本接口用于查询本单位缴款书开具明细

电子票据信息接口本接口用于自动生成电子票据

单位可用收费项目接口本接口用于查询第三方接入单位可用的收费项目信息

跳转支付页面接口本接口用于缴款书在线支付

生成支付二维码接口本接口用于生成缴款书二维码

缴款书支付结果异步通知接口本接口用于缴款书支付成功后通知第三方

6.2缴款书开具接口

缴款书开具接口见表3。

表3缴款书开具接口

接口名称缴款书开具接口

接口URLhttp://ip:port/api/issuePayment接口请求方式post

请求参数

3

DB14/T2543—2022

表3缴款书开具接口（续）

参数代码参数名称数据类型长度是否必填说明

guid业务idString50是唯一识别码

billingDate开票日期String10是yyyy-MM-dd格式

expireDate截止有效期String10否yyyy-MM-dd格式

chargeItemCount收费项目个数String10是

若单一收费项目中含有多项收费标准，需要

summary摘要/备注String100否在此字段详细解释说明，涉及电子发票此项

必填

totalAmount票据总金额String20是两位小数

payerName付款人名称String100是

payerType缴款人类型String20是个人/企业

企业:统一社会信用代码

payerId缴款人号码String20是

个人:身份证号

contacts联系人名称String50是

contactNumber联系电话String20是

email邮箱地址String30否

entryUser录入人员String30是开具电子发票需要

entryTime录入时间String20是yyyy-MM-ddHH:mm:ss格式

auditUser审核人员String30否

auditTime审核时间String20否yyyy-MM-ddHH:mm:ss格式

detailData收费项目明细String是

响应参数

参数代码参数名称数据类型长度是否必填说明

guid业务idString50是接入系统单据唯一识别码

orderId订单idString50是非税唯一的订单id

paymentId缴款识别码String20是统一缴款识别码

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

4

DB14/T2543—2022

6.3缴款书状态查询接口

缴款书状态查询接口见表4。

表4缴款书状态查询接口

接口名称缴款书状态查询接口

接口URLhttp://ip:port/api/queryPaymentStatus接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

orderId订单idString50是非税唯一的订单id

addTime通知书开具时间String20是yyyy-MM-ddHH:mm:ss格

auditTime通知书审核时间String20否yyyy-MM-ddHH:mm:ss格式

10-未支付

payStatus支付状态String10是11-支付中

20-已支付

payTime支付时间String20否yyyy-MM-ddHH:mm:ss格

invalidTime作废时间String20否yyyy-MM-ddHH:mm:ss格式

payAmount支付金额String20是两位小数

refundAmount已退款金额String20否两位小数

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.4缴款书作废接口

缴款书作废接口见表5。

5

DB14/T2543—2022

表5缴款书作废接口

接口名称缴款书作废接口

接口URLhttp://ip:port/api/invalidPayment接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

applyUser申请人员String30是

applyTime申请时间String20是yyyy-MM-ddHH:mm:ss格式

reason作废原因String100是

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

invalidTime作废时间String20是yyyy-MM-ddHH:mm:ss格式

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.5退付申请接口

退付申请接口见表6。

表6退付申请接口

接口名称退付申请接口

接口URLhttp://ip:port/api/applyRefund接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

applyUser申请人员String100是

applyTime申请时间String20是yyyy-MM-ddHH:mm:ss格式

refundAmount退款金额String20是两位小数

reason退款原因String100是

6

DB14/T2543—2022

表6退付申请接口（续）

参数代码参数名称数据类型长度是否必填说明

退回指定账户

refundType退回方式String10是

原支付渠道退回

payeeName收款人名称String100否

payeeAccount收款人账号String50否

refundType=0时，必填

payeeBankName收款开户行String100否

payeeBankNo收款开户行行号String50否

detailData退款项目明细String

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

refundId退付IDString50是

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.6退付申请终止接口

退付申请终止接口见表7。

表7退付申请终止接口

接口名称退付申请终止接口

接口URLhttp://ip:port/api/stopRefound接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

refundId退付IDString50是

applyUser申请人员String30是

applyTime申请时间String20是yyyy-MM-ddHH:mm:ss格式

reason终止原因String100是

7

DB14/T2543—2022

表7退付申请终止接口（续）

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

refundId退付IDString50是

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.7缴款书明细查询接口

缴款书明细查询接口见表8。

表8缴款书明细查询接口

接口名称缴款书明细查询接口

接口URLhttp://ip:port/api/queryPaymentList接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

startDate开始日期String10是

endDate结束日期String10是

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是

billingDate开票日期String10是yyyy-MM-dd格式

payAmount应缴金额String20是两位小数

payerName付款人名称String100是

payerId缴款人号码String20是

10-未支付

payStatus支付状态String10是11-支付中

20-已支付

payTime支付时间String20否yyyy-MM-ddHH:mm:ss格式

payOrgan支付机构String100否

refundAmount已退款金额String20否两位小数

8

DB14/T2543—2022

6.8电子票据信息接口

电子票据信息接口见表9。

表9电子票据信息接口

接口名称电子票据信息接口

接口URLhttp://ip:port/api/getElectronicBill接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

url电子票据地址String150否

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.9单位可用收费项目接口

单位可用收费项目接口见表10。

表10单位可用收费项目接口

接口名称单位可用收费项目接口

接口URLhttp://ip:port/api/queryChargeItems接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

siteCode接入节点代码String50是

响应参数

参数代码参数名称数据类型长度是否必填说明

chargeItem收费项目名称String100是

chargeCode收费代码String20是

standardType标准类型String20否定额/开放

minAmout最小金额String20否

maxAmout最大金额String20否

9

DB14/T2543—2022

6.10跳转支付页面接口

跳转支付页面接口见表11。

表11跳转支付页面接口

接口名称跳转支付页面接口

接口URLhttp://ip:port/api/goToPay接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

deviceType终端设备类型String10是1-PC个人电脑2-手机终端

redirectUrl回调地址String200否支付成功后的跳转地址

响应参数

参数代码参数名称数据类型长度是否必填说明

payUrl支付页面地址String200是

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.11生成支付二维码接口

生成支付二维码接口见表12。

表12生成支付二维码接口

接口名称生成支付二维码接口

接口URLhttp://ip:port/api/getPayQrCode接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

qrimage二维码图片地址String200是

qrcode支付地址String200是

10

DB14/T2543—2022

表12生成支付二维码接口（续）

参数代码参数名称数据类型长度是否必填说明

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

6.12缴款书支付结果异步通知接口

缴款书支付结果异步通知接口见表13。

表13缴款书支付结果异步通知接口

接口名称缴款书支付结果异步通知接口

接口URL本URL向政府非税网上支付平台第三方系统获取接口请求方式post

请求参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

transacNo支付确认流水号String50是收单机构确认交易流水号

payTime支付时间String20否yyyy-MM-ddHH:mm:ss格式

payAmount支付金额String20是两位小数

响应参数

参数代码参数名称数据类型长度是否必填说明

paymentId缴款识别码String20是统一缴款识别码

result处理结果String100是

0-成功

status处理状态String10是

其他-失败

11

DB14/T2543—2022

参考