Requisitos não Funcionais

Classificação dos endpoints

Os endpoints das APIs do Open Finance são classificados de acordo com a frequência de atualização dos dados, conforme segue:

Alta frequência
Média frequência
Baixa frequência

Requisitos não funcionais para as APIs de Investimentos

Informações referentes aos dados de nome da api, roles, versão, scope e resource types para as APIs de investimentos.

APIs de Investimentos - Renda Fixa Bancária
Nome da API:	/bank-fixed-incomes/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	bank-fixed-incomes
ROLE receptor:	DADOS	Resource type	BANK_FIXED_INCOME

APIs de Investimentos - Renda Fixa de Crédito
Nome da API:	/credit-fixed-incomes/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	credit-fixed-incomes
ROLE receptor:	DADOS	Resource type	CREDIT_FIXED_INCOME

APIs de Investimentos - Renda Variável
Nome da API:	/variable-incomes/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	variable-incomes
ROLE receptor:	DADOS	Resource type	VARIABLE_INCOME

APIs de Investimentos - Títulos de Tesouro Direto
Nome da API:	/treasure-titles/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	treasure-titles
ROLE receptor:	DADOS	Resource type	TREASURE_TITLE

APIs de Investimentos - Fundos de Investimento
Nome da API:	/funds/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	funds
ROLE receptor:	DADOS	Resource type	FUND

Informações referentes aos dados de segurança, tempestividade de atualizações, frequência, e consumo dos dados para as APIS de investimentos.

API Renda Fixa Bancária - Endpoint: Listar Investimentos
Método	GET	URL base	/bank-fixed-incomes/v1/investments
Segurança
Modelo de autenticação	authorization_code	permissions	BANK_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Bancária - Endpoint: Identificação do Investimento
Método	GET	URL base	/bank-fixed-incomes/v1/investments/{investmentId}
Segurança
Modelo de autenticação	authorization_code	permissions	BANK_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Bancária - Endpoint: Posição do Investimento
Método	GET	URL base	/bank-fixed-incomes/v1/investments/{investmentId}/balances
Segurança
Modelo de autenticação	authorization_code	permissions	BANK_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Bancária - Endpoint: Transações do Investimento
Método	GET	URL base	/bank-fixed-incomes/v1/investments/{investmentId}/transactions
Segurança
Modelo de autenticação	authorization_code	permissions	BANK_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Bancária - Endpoint: Transações do Investimento
Método	GET	URL base	/bank-fixed-incomes/v1/investments/{investmentId}/transactions-current
Segurança
Modelo de autenticação	authorization_code	permissions	BANK_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Crédito - Endpoint: Listar Investimentos
Método	GET	URL base	/credit-fixed-incomes/v1/investments
Segurança
Modelo de autenticação	authorization_code	permissions	CREDIT_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Crédito - Endpoint: Identificação do Investimento
Método	GET	URL base	/credit-fixed-incomes/v1/investments/{investmentId}
Segurança
Modelo de autenticação	authorization_code	permissions	CREDIT_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Crédito - Endpoint: Posição do Investimento
Método	GET	URL base	/credit-fixed-incomes/v1/investments/{investmentId}/balances
Segurança
Modelo de autenticação	authorization_code	permissions	CREDIT_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Crédito - Endpoint: Transações do Investimento
Método	GET	URL base	/credit-fixed-incomes/v1/investments/{investmentId}/transactions
Segurança
Modelo de autenticação	authorization_code	permissions	CREDIT_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Fixa Crédito - Endpoint: Transações do Investimento
Método	GET	URL base	/credit-fixed-incomes/v1/investments/{investmentId}/transactions-current
Segurança
Modelo de autenticação	authorization_code	permissions	CREDIT_FIXED_INCOMES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Listar Investimentos
Método	GET	URL base	/variable-incomes/v1/investments
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Identificação do Investimento
Método	GET	URL base	/variable-incomes/v1/investments/{investmentId}
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Posição do Investimento
Método	GET	URL base	/variable-incomes/v1/investments/{investmentId}/balances
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Transações do Investimento
Método	GET	URL base	/variable-incomes/v1/investments/{investmentId}/transactions
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Transações do Investimento
Método	GET	URL base	/variable-incomes/v1/investments/{investmentId}/transactions-current
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Renda Variável - Endpoint: Informações da nota de negociação
Método	GET	URL base	/variable-incomes/v1/investments/{investmentId}/broker-notes/{brokerNoteId}
Segurança
Modelo de autenticação	authorization_code	permissions	VARIABLE_INCOMES_READ
Atualização dos Dados
Tempestividade		Defasagem em relação ao canal com fechamento do dia anterior (d-1).
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Títulos de Tesouro Direto - Endpoint: Listar Investimentos
Método	GET	URL base	/treasure-titles/v1/investments
Segurança
Modelo de autenticação	authorization_code	permissions	TREASURE_TITLES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Títulos de Tesouro Direto - Endpoint: Identificação do Investimento
Método	GET	URL base	/treasure-titles/v1/investments/{investmentId}
Segurança
Modelo de autenticação	authorization_code	permissions	TREASURE_TITLES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Títulos de Tesouro Direto - Endpoint: Posição do Investimento
Método	GET	URL base	/treasure-titles/v1/investments/{investmentId}/balances
Segurança
Modelo de autenticação	authorization_code	permissions	TREASURE_TITLES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM.
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Títulos de Tesouro Direto - Endpoint: Transações do Investimento
Método	GET	URL base	/treasure-titles/v1/investments/{investmentId}/transactions
Segurança
Modelo de autenticação	authorization_code	permissions	TREASURE_TITLES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Títulos de Tesouro Direto - Endpoint: Transações do Investimento
Método	GET	URL base	/treasure-titles/v1/investments/{investmentId}/transactions-current
Segurança
Modelo de autenticação	authorization_code	permissions	TREASURE_TITLES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM.
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Fundos de Investimento - Endpoint: Listar Investimentos
Método	GET	URL base	/funds/v1/investments
Segurança
Modelo de autenticação	authorization_code	permissions	FUNDS_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de MÉDIA frequência de atualização (1.000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Fundos de Investimento - Endpoint: Identificação do Investimento
Método	GET	URL base	/funds/v1/investments/{investmentId}
Segurança
Modelo de autenticação	authorization_code	permissions	FUNDS_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de credito de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Fundos de Investimento - Endpoint: Posição do Investimento
Método	GET	URL base	/funds/v1/investments/{investmentId}/balances
Segurança
Modelo de autenticação	authorization_code	permissions	FUNDS_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM.
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Fundos de Investimento - Endpoint: Transações do Investimento
Método	GET	URL base	/funds/v1/investments/{investmentId}/transactions
Segurança
Modelo de autenticação	authorization_code	permissions	FUNDS_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Fundos de Investimento - Endpoint: Transações do Investimento
Método	GET	URL base	/funds/v1/investments/{investmentId}/transactions-current
Segurança
Modelo de autenticação	authorization_code	permissions	FUNDS_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA-ALTA
Consumo dos Dados
Limites Operacionais		Consultas podem ser realizadas 120x ao mês.
SLA		2.000ms (2s).
Limite de Tráfego TPM		1.500 TPM.
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

Requisitos não funcionais para a API de Câmbio

Informações referentes aos dados de nome da api, roles, versão, scope e resource types para a API de Câmbio.

API de Câmbio - Contratos de Câmbio
Nome da API:	/exchanges/	Versão	1.0.0
ROLE transmissor:	DADOS	scope	exchanges
ROLE receptor:	DADOS	Resource type	EXCHANGE

Informações referentes aos dados de segurança, tempestividade de atualizações, frequência, e consumo dos dados para a API de Câmbio.

API Câmbio - Endpoint: Listar Operações
Método	GET	URL base	/exchanges/v1/operations
Segurança
Modelo de autenticação	authorization_code	permissions	EXCHANGES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (1000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Câmbio - Endpoint: Detalhes da Operação
Método	GET	URL base	/exchanges/v1/operations/{operationId}
Segurança
Modelo de autenticação	authorization_code	permissions	EXCHANGES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		BAIXA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (4x ao mês).
SLA		4.000ms (4s).
Limite de Tráfego TPM		Conforme definição atual para APIs de Dados Cadastrais e Transacionais de BAIXA frequência de atualização (500 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).

API Câmbio - Endpoint: Eventos
Método	GET	URL base	/exchanges/v1/operations/{operationId}/events
Segurança
Modelo de autenticação	authorization_code	permissions	EXCHANGES_READ
Atualização dos Dados
Tempestividade		Igual aos demais canais bancários + 60 min.
Frequência de atualização dos dados		MÉDIA
Consumo dos Dados
Limites Operacionais		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (30x ao mês).
SLA		2.000ms (2s).
Limite de Tráfego TPM		Conforme definição atual para APIs de operação de crédito de MÉDIA frequência de atualização (1000 TPM).
Limite de Tráfego TPS		Conforme definição atual (300 TPS).