国库信息处理系统接口报文规范.docx
《国库信息处理系统接口报文规范.docx》由会员分享,可在线阅读,更多相关《国库信息处理系统接口报文规范.docx(34页珍藏版)》请在冰豆网上搜索。
国库信息处理系统接口报文规范
国际收支网上申报系统
企业联机接口报文规范
版本号:
V1.0
国家外汇管理局
2015年2月
变更履历
修改编号
版本
修改内容
修改人
修改日期
1范围2
2术语和接口说明2
3要求2
3.1数据类型定义2
3.2数据处理规则3
3.3报文格式校验3
4接口格式概述4
4.1报文接口格式结构4
5报文格式具体说明5
5.1实时业务类5
6集团型企业业务规则11
7国际收支网上申报系统报文定义11
7.1涉外收入申报单服务11
7.2境内收入申报单服务17
8涉外收支交易代码表23
9报文样例24
10Schema校验文件24
11 范围
《国际收支网上申报系统企业联机接口报文规范》,规定了国家外汇管理局(以下简称“外汇局”)国际收支网上申报系统与企业自身业务系统进行联机实时业务交互时,应采用的报文格式和规范。
12 术语和接口说明
●标识符:
唯一标识报文中一个数据项或者节点项的代码。
●报文:
用于外汇局与联网机构间交换信息的载体。
●报文头:
报文通讯使用的基本信息。
●XML节点TAG:
某一段数据域的标识,比如报文头、用户信息等,用于组织报文中节点项的代码。
●节点代码:
为了方便管理,对于接入的机构,由外汇局进行编码并分配给接入单位使用。
对于企业,节点代码采用“组织机构代码证”的代码,共9位。
13 要求
13.1 数据类型定义
字符集
X-字符集由以下87个字符组成:
ABCDEFGHIJKLMNOPQRSTUVWXYZ
ABCDEFGHIJKLMNOPQRSTUVWXYZ
0123456789
.,-()/=‘’+?
!
“”%&*<>;@#
(CR)(LF)(SPACE)
对于使用TCP/IP协议的系统,X-字符集的编码(字符的二进制编码)适用于ISO-2022(ASCII)
符号约定
符号
说明
STRING
表示由X-字符集组成的字符串,如:
PBCGKJCFCC
NSTRING
表示由数字[0-9]组成的字符串,如:
000045
GBSTRING
表示由GBK字符集组成的字符串,报文规范中的长度定义以字节为单位,如:
商业
CURRENCY
表示金额,符号位可选,整数部分最长15位,小数部分固定两位,不能包含逗号等分隔符,如:
8979.05
INTEGER
表示整数,符号位可选,数值部分最长8位,如:
88888
DECIMAL
表示实数,如:
655785.5676
LONG
表示日期。
日期是毫秒数,毫秒数是根据1970-1-1为参照值,由参数日期减去参照值将结果转换为毫秒数得来的如:
48
DATE
表示日期,格式为YYYYMMDD(年月日)。
如:
2005-06-11
TIME
表示时间,格式为HH:
MM:
SS(时分秒)。
如:
11:
28:
21
DATETIME
表示日期时间,格式为YYYY-MM-DDHH:
MM:
SS(年月日时分秒)。
如:
2005-06-1111:
27:
39
HEXBINARY
表示按十六进制编码,的二进制数据,如:
4F59B25A
BOOLEAN
表示布尔值(TRUE或FALSE),如:
TRUE
13.2 数据处理规则
(1)对于每个字段所填内容,在后面的章节中针对不同报文将具体说明。
(2)当“长度”是N时表示此域出现时,长度固定为N个字符;当“长度”是[1,N]时表示此域出现时,其最小长度为1个字符,其最大长度为N个字符。
(3)当“强制/可选”是M时,表示此要素为强制项,必须出现;当“强制/可选”是O时,表示此要素为可选项,根据业务要求填制,不必须出现,但一旦出现,则其中内容必须出现,不可为空。
13.3 报文格式校验
本规范对XML格式的请求报文提供了Schema校验文件,请求方系统在发起请求前需要根据Schema文件对请求报文进行格式校验。
14 接口格式概述
国家外汇管理局业务信息系统与商业银行接入机构通过报文进行联机交互。
14.1 报文接口格式结构
报文结构
参考原则
规范原则
所有数据报文使用XML进行描述(有特殊说明的部分以说明为准)。
高效性原则
由于国家外汇管理局业务信息系统对报文进行实时处理,因此将追求效率作为首要目标。
易读性原则
在保证报文交换和处理高效的前提下,尽可能提高报文的易读性,以利于系统测试和联调。
结构说明
报文结构如下图所示:
说明:
总体上,报文全部内容封装在一个XML报文中,报文分为三大部分:
报文头、报文体及报文尾。
⏹报文头部分
报文头部分用于标识XML报文的基本属性,包括报文版本号、机构类型、发起节点代码、接收节点代码、发送方系统标识、接收方系统标识、用户信息、发送时间等等信息。
⏹报文体部分
报文体部分是业务信息,包括业务参数、数据集合两部分。
⏹报文尾部分
数字签名部分用于存放报文的数字签名信息,用于交易参与方的身份认证。
算法对报文开始(即从
XMLVERSION=="1.0"ENCODING="GBK"?
>行开始)至之间的全部内容(不包括报文尾信息)进行签名,并以XML注释的形式存储于原XML报文的尾部。
校验和通常在通信过程中保证内容的完整性和准确性。
发送端通过对报文内容运用特定算法计算得出校验和,接收端接收到报文后也对报文进行同样的计算,如果结果一致则代表内容没被改变。
注:
标准XML报文首位字符不允许出现空格等字符,应以
XMLVERSION开始。
具体格式示例如下:
XMLVERSION="1.0"ENCODING="GBK"?
>
报文头内容
报文体内容
报文尾
⏹组件
组件是一个逻辑概念,它用来表示一组彼此之间有一定关系的消息域的组合。
这些组件在协议中都赋以相应的名称,用来更好的理解消息结构以及所应用的场景。
在实际消息传送过程中,这些组件名称并不会作为信息消息中出现,可以这么说,组件的出现是起到更好让人能够理解消息结构的作用。
⏹重复组
域可以在重复组里多次重复,用以传输数组同类的数据。
在协议中,重复组也同样是一个逻辑概念,它用来表示一组彼此之间有一定关系的消息域的组合能够连续反复地在消息中出现。
15 报文格式具体说明
15.1 实时业务类
此类报文主要包含请求报文和回执报文。
请求报文格式
报文格式
说明:
请求报文由报文头、报文体、报文尾组成。
报文头包括报文通讯使用的基本信息和控制信息;报文体包括公共参数和业务数据集合,而业务数据信息又包括分页信息、业务参数信息和业务数据信息;报文尾是数字签名和校验和信息。
数据项
报文头
XML节点TAG:
MSG->HEAD
标识符
字段名称
类型
长度
备注
强制/可选
VER
报文版本号
NSTRING
[1,4]
当前为2014
M
ORGTYPE
机构类型
NSTRING
[1,4]
1:
外汇局、2:
银行、3:
企业。
M
SRC
发起节点代码
NSTRING
4或9
企业:
组织机构代码
M
DES
接收节点代码
NSTRING
6
外汇局:
默认100000
M
SRCAPP
发送端应用代码
STRING
[1,100]
发送端应用名称,由报文的发起方自行控制
O
DESAPP
接收端应用代码
STRING
[1,100]
接收端应用名称,例如国际收支网上申报系统为BZCN
M
SENDTIME
发送时间
DATETIME
报文发送时间
M
COMMON_ORG_CODE
机构代码
STRING
[1,40]
企业:
组织机构代码
M
COMMON_USER_CODE
用户代码
STRING
[1,40]
用户代码
M
PASSWORD
密码
STRING
[1,50]
密码(MD5加密后的)
M
SERVICEPATH
访问服务信息
STRING
[5,100]
服务名称+“.”+方法名称
M
MSGNO
报文参考号
STRING
[1,33]
企业:
组织机构代码+年月日+8位唯一代码
M
报文体
公共参数信息
XML节点TAG:
MSG->BODY->PARAMETERS
说明:
此节点是业务公共参数位置,主要用于非分页查询和写操作时传参,参数的详细定义见本文档报文的定义部分。
数据集信息
XML节点TAG:
MSG->BODY->DATASTORES->DS
标识符
数据项名称
类型
长度
数据项描述
强制/可选
PAGESIZE
每页条数
NSTRING
[1,10]
最大不能超过1000条
M
PAGENUMBER
页码
NSTRING
[1,10]
当前是多少页
M
说明:
对于分页查询,以上内容是必输,如果不输入PAGESIZE值默认是1000;对于非分页查询和写操作,以上内容无需存在。
XML节点TAG:
MSG->BODY->DATASTORES->DS->PARAMETERS
说明:
PARAMETERS下是业务参数,此节点下的参数为非必输参数,此节点下的参数为非必输参数,此节点为分页查询和写操作入参位置。
XML节点TAG:
MSG->BODY->DATASTORES->DS->ROWSET
标识符
数据项名称
类型
长度
数据项描述
强制/可选
ROW
数据集
GBSTRING
数据集,可循环出现
O
说明:
ROW可以重复出现,详细定义见本文档对报文的定义部分。
报文尾
XML节点TAG:
MSG->TAIL
标识符
数据项名称
类型
长度
数据项描述
强制/可选
SIGNATURE
数字签名
STRING
[0,300]
暂不使用
O
CHECKSUM
预留字段
STRING
[0,300]
暂不使用
O
回执报文格式
报文格式
说明:
由一个报文头、一个回执信息、报文尾构成。
数据项
报文头
XML节点TAG:
MSG->HEAD
标识符
字段名称
类型
长度
备注
强制/可选
VER
报文版本号
NSTRING
[1,4]
当前为2014
M
SRC
发起节点代码
NSTRING
6
外汇局:
默认100000
M
DES
接收节点代码
NSTRING
4或9
银行:
总行代码【金融机构代码】
企业:
组织机构代码
M
SRCAPP
发送端应用代码
STRING
[1,100]
外汇局端应用名称,例如国际收支网上申报系统为BZCN
M
DESAPP