货物贸易外汇监测系统.DOC

1、 第 1 页货 物 贸 易 外 汇 监 测 系 统企 业 联 机 接 口 报 文 规 范版 本 号 ： V1.0国 家 外 汇 管 理 局2015 年 2 月变更履历第 2 页修改编号 版本 修改内容 修改人 修改日期目 录1 范围 .4第 3 页2 术语和接口说明 .43 要求 .43.1 数据类型定义 .43.2 数据处理规则 .53.3 报文格式校验 .54 接口格式概述 .64.1 报文接口格式结构 .65 报文格式说明 .75.1 实时业务类 .76 集团企业数据权限说明 .127 报文定义 .127.1 基础业务数据查询 .147.2 预收 /预付报告 .217.3 延收 /延付报

2、告 .277.4 转口贸易收支时间差报告 .347.5 多收汇 /多付汇差额报告 .397.6 多进口 /多出口差额报告 .437.7 其他特殊交易报告 .467.8 出口收入存放境外报告 .517.9 企业信息查询 .657.10 业务指标情况查询服务 .667.11 业务汇总数据查询 .717.12 现场核查 .727.13 信息交互 .747.14 登记表业务 .778 报文样例 .839 SCHEMA 校验文件 .8310 数据字典 .8310.1 收汇性质 .8310.2 付汇性质 .8410.3 结算方式 .8410.4 涉外收支交易代码 .8410.5 贸易方式 .8410.6

3、登记表类别 .8710.7 登记表状态 .8710.8 差额原因代码 .8711 错误编码与错误名称对应表 .881 范围第 4 页货物贸易外汇监测系统企业联机接口报文规范，规定了国家外汇管理局（以下简称“外汇局”）货物贸易外汇监测系统与企业自身业务系统进行联机实时业务交互时，应采用的报文格式和规范。2 术语和接口说明 标识符：唯一标识报文中一个数据项或者节点项的代码。 报文：用于外汇局与联网机构间交换信息的载体。 报文头：报文通讯使用的基本信息。 XML节点TAG：某一段数据域的标识，比如报文头、用户信息等，用于组织报文中节点项的代码。 节点代码：为了方便管理，对于接入的机构，由外汇局进行编

4、码并分配给接入单位使用。对于企业，节点代码采用“组织机构代码证”的代码，共9位。3 要求3.1 数据类型定义3.1.1 字符集x-字符集由以下87个字符组成：a b c d e f g h i j k l m n o p q r s t u v w x y zA B C D E F G H I J K L M N O P Q R S T U V W X Y Z0 1 2 3 4 5 6 7 8 9 . , - ( ) / = + ? ! “ ” % #(cr) (lf) (space)对于使用TCP/IP协议的系统， x-字符集的编码（字符的二进制编码）适用于 ISO-2022（ASCII）3

5、.1.2 符号约定符号 说明String 表示由 x-字符集组成的字符串，如： PbcGkjCfccNString 表示由数字0-9组成的字符串，如： 000045GBString 表示由 GBK 字符集组成的字符串，报文规范中的长度定义以字节为单位，如：商业第 5 页Currency 表示金额，符号位可选，整数部分最长 15 位，小数部分固定两位，不能包含逗号等分隔符，如：8979.05Integer 表示整数，符号位可选，数值部分最长 8 位，如：88888Decimal 表示实数，如：655785.5676Long 表示日期。日期是毫秒数，毫秒数是根据 1970-1-1 为参照值，由参数

6、日期减去参照值将结果转换为毫秒数得来的如：1333248494648Date 表示日期，格式为 yyyy-mm-dd（年月日） 。如：2005-06-11Time 表示时间，格式为 HH:MM:SS（时分秒） 。如：11:28:21DateTime 表示日期时间，格式为 yyyy-mm-dd HH:MM:SS（年月日时分秒） 。如：2005-06-11 11:27:39 HexBinary 表示按十六进制编码,的二进制数据，如：4F59B25ABoolean 表示布尔值(true 或 false)，如：true3.2 数据处理规则(1)对于每个字段所填内容，在后面的章节中针对不同报文将具体说明

7、。(2)当“长度”是n时表示此域出现时，长度固定为n个字符；当“长度”是1,n时表示此域出现时，其最小长度为1个字符，其最大长度为n个字符。(3)当“强制/可选”是M时，表示此要素为强制项，必须出现；当“强制/可选”是O时，表示此要素为可选项，根据业务要求填制，不必须出现，但一旦出现，则其中内容必须出现，不可为空。3.3 报文格式校验本规范对XML格式的请求报文提供了 Schema校验文件，请求方系统在发起请求前需要根据Schema文件对请求报文进行格式校验。4 接口格式概述第 6 页国家外汇管理局业务信息系统与企业接入机构通过报文进行联机交互。4.1 报文接口格式结构4.1.1 报文结构4.

8、1.1.1 参考原则4.1.1.1.1 规范原则所有数据报文使用 XML 进行描述（有特殊说明的部分以说明为准） 。4.1.1.1.2 高效性原则由于国家外汇管理局业务信息系统对报文进行实时处理，因此将追求效率作为首要目标。4.1.1.1.3 易读性原则在保证报文交换和处理高效的前提下，尽可能提高报文的易读性，以利于系统测试和联调。4.1.1.2 结构说明报文结构如下图所示：域 1C o m p o e n t组件M e s s a g e报文H e a d e r报文头B o d y报文体T a i l报文尾域 2域 3域块域块域 1 0域块R e p e a t i n g G r o u

9、 p重复组G r o u p B l o c k 1组块 1G r o u p B l o c k 2组块 2G r o u p B l o c k n组块 n域域块域块域域块域域块组块： 表示重复组中每块重复部分 ， 也是由域块组成域： 表示某个域域块： 表示多个域集合重复组： 表示重复组 ， 可由多个重复组块组成组件： 表示多个域的集合 ， 这些域所代表的含义之间具有关联性说明：总体上，报文全部内容封装在一个 XML 报文中，报文分为三大部分：报文头、报文体及报文尾。 报文头部分报文头部分用于标识 XML 报文的基本属性，包括报文版本号、机构类型、发起节点代码、接收节点代码、发送方系统标识

10、、接收方系统标识、用户信息、发送时间等等信息。 报文体部分第 7 页报文体部分是业务信息，包括业务参数、数据集合两部分。 报文尾部分数字签名部分用于存放报文的数字签名信息，用于交易参与方的身份认证。算法对报文开始（即从 行开始）至之间的全部内容（不包括报文尾信息）进行签名，并以 XML 注释的形式存储于原 XML 报文的尾部。校验和通常在通信过程中保证内容的完整性和准确性。发送端通过对报文内容运用特定算法计算得出校验和，接收端接收到报文后也对报文进行同样的计算，如果结果一致则代表内容没被改变。注：标准 XML 报文首位字符不允许出现空格等字符，应以 报文头内容 报文体内容 报文尾 组件组件是一

11、个逻辑概念，它用来表示一组彼此之间有一定关系的消息域的组合。这些组件在协议中都赋以相应的名称，用来更好的理解消息结构以及所应用的场景。在实际消息传送过程中，这些组件名称并不会作为信息消息中出现，可以这么说，组件的出现是起到更好让人能够理解消息结构的作用。 重复组域可以在重复组里多次重复，用以传输数组同类的数据。在协议中，重复组也同样是一个逻辑概念，它用来表示一组彼此之间有一定关系的消息域的组合能够连续反复地在消息中出现。5 报文格式说明5.1 实时业务类此类报文主要包含请求报文和回执报文。第 8 页5.1.1 请求报文格式5.1.1.1 报文格式通讯基本信息公共参数信息业务数据集合报文尾报文体

12、业务参数信息 业务数据信息 （ 0 , N ）分页信息报文头控制信息说明：请求报文由报文头、报文体、报文尾组成。报文头包括报文通讯使用的基本信息和控制信息；报文体包括公共参数和业务数据集合，而业务数据信息又包括分页信息、业务参数信息和业务数据信息；报文尾是数字签名和校验和信息。5.1.1.2 数据项5.1.1.2.1 报文头XML 节点 TAG：MSG-HEAD标识符 字段名称 类型 长度 备注 强制/可选VER 报文版本号 NString 1,4 当前为 2014 MCOMMON_ORG_TYPE机构类型 NString 1,4 1：外汇局、2：银行、3：企业。MSRC 发起节点代码NStr

13、ing 4 或 9 企业：组织机构代码 MDES 接收节点代码NString 6 外汇局：默认 100000 MSRCAPP 发送端应用代码String 1,100 发送端应用名称，由报文的发起方自行控制ODESAPP 接收端应用代码String 1,100 接收端应用名称，例如货物贸易外汇监测系统为 TMISMSENDTIME 发送时间 DateTime报文发送时间 M第 9 页COMMON_ORG_CODE机构代码 String 1,40 企业：组织机构代码 MCOMMON_USER_CODE用户代码 String 1,40 用户代码 MPASSWORD 密码 String 1,50 密码

14、（明文密码需经MD5（32 位，小写）加密）MSERVICEPATH 访问服务信息String 5,100 服务名称+“.”+ 方法名称MMSGNO 报文参考号 String 1,33 企业：组织机构代码+年月日+8 位唯一代码M5.1.1.2.2 报文体公共参数信息XML 节点 TAG：MSG-BODY-PARAMETERS 说明：此节点是业务公共参数位置,主要用于非分页查询和写操作时传参，参数的详细定义见本文档报文的定义部分。数据集信息XML 节点 TAG ：MSG-BODY-DATASTORES-DS1标识符 数据项名称 类型 长度 数据项描述强制/可选PAGESIZE 每页条数 NSt

15、ring 1,10 最大不能超过 1000 条 MPAGENUMBER 页码 NString 1,10 当前是多少页 M说明：对于分页查询，以上内容是必输，如果不输入 PAGESIZE 值默认是 1000；对于非分页查询和写操作，以上内容无需存在。XML 节点 TAG ：MSG-BODY-DATASTORES-DS-PARAMETERS 说明：PARAMETERS 下是业务参数，此节点下的参数为非必输参数，此节点下的参数为非必输参数，此节点为分页查询和写操作入参位置。第 10 页XML 节点 TAG ：MSG-BODY-DATASTORES-DS-ROWSET标识符 数据项名称 类型 长度 数

16、据项描述强制/可选ROW 数据集 GBString 数据集，可循环出现 O说明：ROW可以重复出现，详细定义见本文档对报文的定义部分。5.1.1.2.3 报文尾XML 节点 TAG ：MSG- TAIL标识符 数据项名称 类型 长度 数据项描述强制/可选SIGNATURE 数字签名 String 0,300 暂不使用 OCHECKSUM 预留字段 String 0,300 暂不使用 O5.1.2 回执报文格式 5.1.2.1 报文格式通讯基本信息公共参数信息业务数据集合报文尾报文体业务参数信息 业务数据信息 （ 0 , N ）分页信息报文头请求状态信息说明：由一个报文头、一个回执信息、报文尾构成。5.1.2.2 数据项5.1.2.2.1 报文头XML 节点 TAG：MSG-HEAD标识符 字段名称 类型 长度 备注 强制/可选VER 报文版本号 NString 1,4 当前为 2014 MSRC 发起节点代码NString 6 外汇局：默认 100000 M