...
Regras para definir obrigatoriedade do envio do campo
Índice | Campo é Regulatório por alguma IN? | Campo é requerido pela documentação no Swagger? | Cenário de Negócio | Deve-se enviar a informação do campo? |
|---|---|---|---|---|
1 | Obrigatório | Obrigatório | Sim | |
2 | Obrigatório | Condicional | Sensibilizado pelo critério de condicionalidade | Sim |
3 | Obrigatório | Condicional | Não sensibilizado pelo critério de condicionalidade | Não |
4 | Obrigatório | Opcional | Dado faz sentido no contexto | Sim |
5 | Obrigatório | Opcional | Dado não faz sentido no contexto | Não |
6 | Opcional | Obrigatório | Sim | |
7 | Opcional | Condicional | Sensibilizado pelo critério de condicionalidade | A critério da instituição |
8 | Opcional | Condicional | Não sensibilizado pelo critério de condicionalidade | Não |
9 | Opcional | Opcional | Dado faz sentido no contexto | A critério da instituição |
10 | Opcional | Opcional | Dado não faz sentido no contexto | Não |
Utilização de Nulos, NA e outros valores fictícios
No Open Finance Brasil é vetado o uso de nulos, de String vazias, “NA” ou valores que não se adequam ao domínio em questão. As "transmissoras" e "detentoras de conta" devem utilizar os padrões estabelecidos para obrigatoriedade de campos.
Ainda se prevê um período de transição entre versões da Fase 1 e 4A para o uso de Atributos Vazios / Nulos. Fase 1 e 4A Um atributo omitido (ou seja, um atributo que não está presente no payload) será considerado equivalente a um atributo que esteja presente com o valor null. Uma string vazia (“”) não será considerada equivalente a null. O valor booleano false não será considerado equivalente a null. Os atributos booleanos opcionais, por definição, possuirão três valores possíveis: verdadeiro (true), falso (false) e indeterminado (null). Na situação onde o campo a ser informado no payload seja obrigatório e a Instituição, seja consumidora no envio ou transmissora no retorno, não a possuir, deve-se implementar o valor padronizado: “NA” - Não se Aplica, com exceção dos campos declarados como ENUM que deverão ser sempre preenchidos com os valores válidos para o ENUM correspondente. |
|---|
Instrução para instituições que não possuem dados para um campo definidos como obrigatório (por regulação / tecnicamente)
...
Entretanto, tecnicamente, contas do tipo pré-pagas não possuem agência e por isso o campo Branch se torna condicionado ao cenário em que a conta não é pré-paga.
– Legenda: "Exemplo de documentação da mandatoriedade no dicionário de dados.
Dados meramente ilustrativos.
Dicionário de Dados
O dicionário de dados das APIs os dados de obrigatoriedade regulatória e técnica são refletidos respectivamente nas colunas “Mandatoriedade Regulatória” e “Mandatoriedade Técnica”.
Xpath | Nome | Tipo de dado | Mandatoriedade Regulatória | Mandatoriedade Técnica |
|---|---|---|---|---|
/data | data | Lista | Obrigatório | Obrigatório |
/data/accountId | accountId | Texto | Obrigatório | Obrigatório |
/data/type | type | Texto | Obrigatório | Obrigatório |
/data/compeCode | compeCode | Texto | Obrigatório | Obrigatório |
/data/branchCode | branchCode | Texto | Obrigatório | Obrigatório |
/data/number | number | Texto | Obrigatório | Obrigatório |
/data/address | address | Objeto | Opcional | Opcional |
Exemplo de documentação da mandatoriedade no dicionário de dados. Dados meramente ilustrativos.