跳到主要内容

标准规范

为便于集成并保证信息完整性，整个 API 遵循以下定义的标准。

货币金额​

示例：

10000
12345
98741
1223
1
0

API 假定所有发送的货币金额均为巴西雷亚尔。金额必须以整数形式发送，代表分（centavos）。

带时区的日期和时间​

部分示例：

2019-10-15T22:35:12.232-03:00
2018-05-01T13:32:11.297+00:00
2019-05-01T00:00:00.000+00:00

按 ISO 8601 格式表示。在此情况下，时区紧跟在时间之后，必须代表该数据有效的本地时区。

用于验证的掩码如下：

YYYY-MM-ddThh:mm:ss.sss±hh:mm

不带时区的日期和时间​

部分示例：

2019-10-15T22:35:12
2018-05-01T13:32:11
2019-05-01T00:00:00

按 ISO 8601 格式表示。与时区无关的数据应使用 UTC，以字母 Z 表示该数据为 UTC 时间。因此，将验证以下格式：

YYYY-MM-ddThh:mm:ss.sssZ

日期​

部分示例

2019-10-15
2019-01-01
2017-03-20

对于仅接收日期（不含时间）的字段，应使用以下格式发送：

YYYY-MM-dd

文件编号​

由于文件编号差异很大，许多文件编号包含非数字字符，因此所有文件编号均定义为字符串类型。将其定义为字符串的另一个好处是避免前置零丢失。本页面中规定的文件编号具有明确的掩码并将进行验证。其他文件编号，如 RG，由于缺乏标准化，将不进行验证。

CPF​

符合定义掩码的有效 CPF 示例：

123.456.789-12
321.987.543-23
111.283.333-00

不符合定义掩码的无效 CPF 示例：

8.577.477-8
08.104.627/0001-23
123.456.789-1
23.456.789-01

CPF 始终定义为字符串，并将根据以下掩码进行验证：

###.###.###-##

CNPJ​

符合定义掩码的有效 CNPJ 示例：

08.104.627/0001-02
01.079.210/0114-67
32.402.502/0001-35

不符合定义掩码的无效 CNPJ 示例：

8.577.477-8
123.456.789-12
321.987.543-23
32.402.502/0001-3
032.402.502/0001-3

CNPJ 始终定义为字符串，并将根据以下掩码进行验证：

##.###.###/####-##

IP​

符合定义掩码的有效 IP 示例：

201.81.161.86
201.081.161.86
201.81.161.086
201.81.0.1

无效 IP 示例：

201.81..86
358.81.161.86
201.81.161

IP 地址必须始终以 IPv4 格式发送，前置零可以发送也可以不发送，需遵循以下掩码：

###.###.###.###