...
a. Caso, no pedido da criação do consentimento, a transmissora valide a ausência de parâmetros PJ e presença de permissions CUSTUMERS CUSTOMERS BUSINESS deve retornar HTTP Status Code 422 com a mensagem “INFORMACOES_PJ_NAO_INFORMADAS”;
b. Caso, no pedido da criação do consentimento, a transmissora valide a presença de parâmetros PJ e presença de permissions CUSTUMERS CUSTOMERS PERSONAL deve retornar HTTP Status Code 422 com a mensagem “PERMISSOES_PJ_INCORRETAS”;
c. Caso recebam uma solicitação de consentimento com permissões de dados cadastrais PF e PJ em conjunto, retornar HTTP Status Code 422 com a mensagem “PERMISSAO_PF_PJ_EM_CONJUNTO”;
d. Caso a Instituição Receptora envie permissões divergentes ao agrupamento especificado na tabela abaixo, retornar HTTP Status Code 422 com a mensagem “COMBINACOES_DE_PERMISSOES_INCORRETA”. Caso a Instituição Receptora envie permissões divergentes ao agrupamento especificado na tabela abaixo, retornar HTTP Status Code 422 com a mensagem “COMBINACAO_PERMISSOES_INCORRETA”.
e. Caso a Instituição Receptora envie data de expiração maior que um ano ou uma data referente ao passado, deve-se retornar HTTP Status Code 422.
Caso seja identificado um cliente PJ na jornada de criação de consentimento, deve-se exibir apenas marcas que suportem públicos PJ ou ambos (PF e PJ) para escolha. As marcas que contemplam público PJ podem ser selecionadas no diretório nos casos em que a flag de seleção de público está preenchida com a opção “Suporta Contas PJ”;
Caso seja identificado um cliente PF na jornada de criação de consentimento, deve-se exibir apenas marcas que suportem públicos PF ou ambos (PF e PJ) para escolha. As marcas que contemplam público PF podem ser selecionadas no diretório nos casos em que a flag de seleção de público está preenchida com a opção “Suporta Contas PF”.
A tabela abaixo indica, para cada produto, os agrupamentos de permissões válidos e como é realizado a seleção de recursos, por identificador ou por modalidade. Produtos cuja seleção de recurso seja por identificador devem ter o agrupamento de permissões removidos quando a instituição transmissora não oferecer o produto. Já produtos cuja seleção de recurso seja por agrupamento de recurso ou agrupamento de produtos deve ter as permissões mantidas mesmo quando a instituição transmissora não comercializar o produto solicitado.
CATEGORIA DE DADOS | AGRUPAMENTO | PERMISSIONS | SELEÇÃO DE RECURSO |
|---|---|---|---|
Cadastro | Dados Cadastrais PF | CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ | Por recurso |
RESOURCES_READ | |||
Cadastro | Informações complementares PF | CUSTOMERS_PERSONAL_ADITTIONALINFO_READ | Por recurso |
RESOURCES_READ | |||
Cadastro | Dados Cadastrais PJ | CUSTOMERS_BUSINESS_IDENTIFICATIONS_READ | Por recurso |
RESOURCES_READ | |||
Cadastro | Informações complementares PJ | CUSTOMERS_BUSINESS_ADITTIONALINFO_READ | Por recurso |
RESOURCES_READ | |||
Contas | Saldos | ACCOUNTS_READ | Por recurso |
ACCOUNTS_BALANCES_READ | |||
RESOURCES_READ | |||
Contas | Limites | ACCOUNTS_READ | Por recurso |
ACCOUNTS_OVERDRAFT_LIMITS_READ | |||
RESOURCES_READ | |||
Contas | Extratos | ACCOUNTS_READ | Por recurso |
ACCOUNTS_TRANSACTIONS_READ | |||
RESOURCES_READ | |||
Cartão de Crédito | Limites | CREDIT_CARDS_ACCOUNTS_READ | Por recurso |
CREDIT_CARDS_ACCOUNTS_LIMITS_READ | |||
RESOURCES_READ | |||
Cartão de Crédito | Transações | CREDIT_CARDS_ACCOUNTS_READ | Por recurso |
CREDIT_CARDS_ACCOUNTS_TRANSACTIONS_READ | |||
RESOURCES_READ | |||
Cartão de Crédito | Faturas | CREDIT_CARDS_ACCOUNTS_READ | Por recurso |
CREDIT_CARDS_ACCOUNTS_BILLS_READ | |||
CREDIT_CARDS_ACCOUNTS_BILLS_TRANSACTIONS_READ | |||
RESOURCES_READ | |||
Operações de Crédito | Dados do Contrato | LOANS_READ | Por agrupamento de produtos |
LOANS_WARRANTIES_READ | |||
LOANS_SCHEDULED_INSTALMENTS_READ | |||
LOANS_PAYMENTS_READ | |||
FINANCINGS_READ | |||
FINANCINGS_WARRANTIES_READ | |||
FINANCINGS_SCHEDULED_INSTALMENTS_READ | |||
FINANCINGS_PAYMENTS_READ | |||
UNARRANGED_ACCOUNTS_OVERDRAFT_READ | |||
UNARRANGED_ACCOUNTS_OVERDRAFT_WARRANTIES_READ | |||
UNARRANGED_ACCOUNTS_OVERDRAFT_SCHEDULED_INSTALMENTS_RE | |||
UNARRANGED_ACCOUNTS_OVERDRAFT_PAYMENTS_READ | |||
INVOICE_FINANCINGS_READ | |||
INVOICE_FINANCINGS_WARRANTIES_READ | |||
INVOICE_FINANCINGS_SCHEDULED_INSTALMENTS_READ | |||
INVOICE_FINANCINGS_PAYMENTS_READ | |||
RESOURCES_READ | |||
Investimento | Dados da Operação | BANK_FIXED_INCOMES_READ | Por agrupamento de produtos |
CREDIT_FIXED_INCOMES_READ | |||
FUNDS_READ | |||
VARIABLE_INCOMES_READ | |||
TREASURE_TITLES_READ | |||
RESOURCES_READ | |||
Câmbio | Listar | EXCHANGES_READ | Por agrupamento de recursos |
RESOURCES_READ | |||
Detalhes da Operação | EXCHANGES_READ | ||
RESOURCES_READ | |||
Eventos | EXCHANGES_READ | ||
RESOURCES_READ |
Cenários de caso de erro
Foram mapeados alguns erros esperados durante o fluxo do usuário no ecossistema. Existem orientações específicas já tratadas no Guia de Experiência do Usuário. Aqui, trataremos a visão mais técnica do que pode ser feito em caso de erro:
...
Mudanças para as transmissoras de dados somente para produtos cuja seleção é agrupada por produtos (Operações de Crédito e Investimentos) ou por recursos (Câmbio)
Regra | Como é | Como fica |
|---|---|---|
URL de well-know | Deve incluir apenas os escopos dos produtos trabalha | Deve incluir todos os escopos válidos do Open Finance |
Criação do Consentimento | Deve remover as permissões correspondentes aos produtos que não trabalha | Deve manter todas as permissões dos agrupamentos solicitados, mesmo dos produtos que não trabalha |
Criação do access-token | Deve remover os escopos dos produtos que não trabalha | Deve manter os escopos solicitados, mesmo dos produtos que não trabalha |
APIs e endpoints | Deve implementar apenas as APIs e endpoints dos produtos que trabalha¹ | Deve implementar apenas as APIs e endpoints dos produtos que trabalha¹ |
Comunicação | Deixar claro que novos recursos serão compartilhados quando contratados | Deixar claro que novos recursos e produtos poderão serão compartilhados quando contratados |
1 Válido para todos os produtos, e não somente Operações de Crédito, Investimentos e Câmbio.
Mudanças para as receptoras de dados somente para produtos cuja seleção é agrupada por produtos (Operações de Crédito e Investimentos) ou por recursos (Câmbio)
Regra | Como é | Como fica |
|---|---|---|
Comunicação | Deixar claro que novos recursos serão compartilhados quando contratados | Deixar claro que novos recursos e produtos poderão serão compartilhados quando contratados |
Consumo de APIs e Endpoints | Pode se basear nas permissões do consentimento para saber quais endpoints consumir | Deve se basear na API Recursos |
Impactos e regras de transição
...
Mapeamento de mensagens retornadas pela API Consentimento
Endpoint | Método | HTTP Status | Cenário | Código de Mensagem |
|---|
Endpoint
Método
Cenário
Código de Mensagem
/consents | POST | 201 | Criação do consentimento efetuada com sucesso (payload de retorno conforme a especificação) |
|
422 | Se após a remoção de um agrupamento de produtos não restarem permissões funcionais | SEM_PERMISSOES_FUNCIONAIS_RESTANTES | ||
A transmissora valide a ausência de parâmetros PJ e presença de permissions |
CUSTOMERS BUSSINESS | INFORMACOES_PJ_NAO_INFORMADAS |
A transmissora valide a presença de parâmetros PJ e presença de permissions |
CUSTOMERS PERSONAL | PERMISSOES_PJ_INCORRETAS |
Solicitação de consentimento com permissões de dados cadastrais PF e PJ em conjunto |
PERMISSAO_PF_PJ_EM_CONJUNTO | |||
Instituição Receptora envie permissões divergentes ao agrupamento de especificado na tabela | COMBINACAO_PERMISSOES_INCORRETA | ||
DELETE | 422 | Consentimento já se encontra no status REJECTED | CONSENTIMENTO_ |
EM_STATUS_REJEITADO | ||||
/consents/{consentID}/extends | POST | 201 | Renovação do consentimento finalizada com sucesso (payload de retorno conforme a especificação) |
|
422 | Necessário a aprovação de múltipla alçada | DEPENDE_MULTIPLA_ALCADA | ||
Estado inválido do consentimento | ESTADO_CONSENTIMENTO_INVALIDO | |||
Nova data para expiração de consentimento é inválida | DATA_EXPIRACAO_INVALIDA |