Jump to Content
Home
Documentação
API
Changelog
v1.2.0
Documentação
API
Changelog
Suporte
FAQs
Log In
API
Documentação
API
Changelog
Suporte
FAQs
Log In
Moon (Dark Mode)
Sun (Light Mode)
Brick Bank v1
Home
Documentação
API
Changelog
End User Management Session
Search
All
Pages
Start typing to search…
JUMP TO
Brick Bank - Autenticação
Token
Criação do Token de Acesso
post
BRICK BANK - PAGAMENTOS V4
Iniciadora de Pagamentos
Iniciação de Pagamento
post
Pix
Gerar pagamento via Proxy
post
Consultar pagamento via Proxy
get
Cancelar pagamento via Proxy
patch
Callback
post
Detentora de Contas
Redirecionamento App2App
post
Login
post
Aprovação do consentimento
post
Cancelamento do consentimento
post
Aprovação de múltiplas alçadas
post
Rejeição de múltiplas alçadas
post
Brick Bank - Jornada sem Redirecionamento
Iniciadora de Pagamentos
Solicitação de vínculo
post
Consulta de vínculo
get
Callback
post
Obter parâmetros de registro
post
Registra credenciais
post
Detentora de Contas
Login
post
Aprovação do vínculo
post
BRICK BANK - PAGAMENTOS AUTOMÁTICOS V1
Iniciadora de Pagamentos
Iniciação de Pagamento
post
Pix
Cria uma transação de pagamento.
post
Busca informações de uma transação de pagamento.
get
Cancelamento de solicitação de pagamento automático.
patch
Busca informações de transações de pagamentos associadas a um consentimento.
get
Callback
post
Busca de consentimento
get
Rejeição ou revogação do consentimento
patch
Detentora de Contas
Login
post
Aprovação do consentimento
post
Cancelamento do consentimento
post
BRICK BANK - COMPARTILHAMENTO DE DADOS V3
Receptora de Dados
Solicitação de consentimento
post
Callback
post
Renovação do consentimento
post
Transmissora de Dados
Redirecionamento App2App
post
Login
post
Aprovação do consentimento
post
Reprovação do consentimento
post
BRICK BANK - REPORT DE JORNADA
Report de Jornada
/api/journey/v1/consents/{consentId}/report
post
BRICK BANK - GESTÃO DE CONSENTIMENTO
Transmissora de Dados
Listar consentimentos de dados transmitidos
get
Buscar consentimento transmitido por ID
get
Revogar consentimento transmitido por ID
patch
Atualizar o metadado de um consentimento transmitido
patch
Receptora de Dados
Listar consentimentos de dados recebidos
get
Buscar consentimento recebido por ID
get
Revogar consentimento recebido por ID
patch
Atualizar o metadado de um consentimento recebido
patch
Fluxo de atualização do consentimento
put
Fluxo de renovação do consentimento
patch
Detentora de Contas
Listar consentimentos de dados transmitidos
get
Buscar consentimento transmitido por ID
get
Revogar consentimento transmitido por ID
patch
Atualizar o metadado de um consentimento transmitido
patch
Iniciadora de Pagamentos
Listar consentimentos de dados recebidos
get
Buscar consentimento recebido por ID
get
Revogar consentimento recebido por ID
patch
Atualizar o metadado de um consentimento recebido
patch
bRICK BANK - RELATÓRIO SEMANAL
Funil de Consentimento
Lista de Consentimentos Transmitidos
get
Lista de Consentimentos Recebidos
get
Estoque Consolidado
Métricas de Requisições Transmitidas
get
Métricas de Requisições Recebidas
get
Estoque Segregado
Total de Consentimentos Transmitidos
get
Total de Consentimentos Recebidos
get
Métricas de Transmissão de Dados
Métricas de Requisições Transmitidas
get
BRICK BANK - CHECK CUSTOMER
Verificação de usuário
Check Customer
post
Brick Insurance - Compartilhamento de Dados v2
Token
Criação do Token de Acesso
post
Receptora de Dados
Solicitação de Consentimento
post
Autenticação do Transmissor de Dados
post
Solicitação do Token de Acesso do Consentimento
post
Transmissora de Dados
Autenticação e validação do consentimento
post
Aprovação do Consentimento
post
Brick Insurance - Endosso
Iniciador de Serviço
Iniciação do Endosso
post
Callback do Iniciador do Endosso
post
Criar endosso via Proxy
post
Receptora
Login no Receptor
post
Aprovação do Consentimento no Receptor
post
Cancelamento do Consentimento do Receptor
post
Brick Insurance - Aviso de Sinistro
Iniciador de Serviço
Iniciação de Aviso de Sinistro
post
Callback do Iniciador do Aviso de Sinistro
post
Criar aviso de sinistro via Proxy
post
Receptora
Login no Receptor
post
Aprovação do Consentimento no Receptor
post
Cancelamento do Consentimento do Receptor
post
Brick Insurance - Funil de Consentimento
Falha da Autenticação
Reportar evento user-authentication-failed
post
OPEN KEYS® API Accounts
Accounts
Obtém a lista de contas consentidas pelo cliente.
get
Obtém os dados de identificação da conta identificada por accountId.
get
Obtém os saldos da conta identificada por accountId.
get
Obtém a lista de transações da conta identificada por accountId.
get
Obtém a lista de transações recentes (últimos 7 dias) da conta identificada por accountId.
get
Obtém os limites da conta identificada por accountId.
get
Unarranged Accounts Overdraft
Obtém a lista de contratos de adiantamento a depositantes consentidos pelo cliente.
get
Obtém os dados do contrato de adiantamento a depositantes identificado por contractId
get
Obtém a lista de garantias vinculadas ao contrato de adiantamento a depositantes identificado por contractId
get
Obtém os dados do cronograma de parcelas do contrato de adiantamento a depositantes identificado por contractId
get
Obtém os dados de pagamentos do contrato de adiantamento a depositantes identificado por contractId
get
Loans
Conjunto de informações de contratos de empréstimo mantidos pelo cliente na instituição transmissora e para os quais ele tenha fornecido consentimento
get
Obtém os dados do contrato de empréstimo identificado por contractId
get
Obtém a lista de garantias vinculadas ao contrato de empréstimo identificado por contractId
get
Obtém os dados do cronograma de parcelas do contrato de empréstimo identificado por contractId
get
Obtém os dados de pagamentos do contrato de empréstimo identificado por contractId
get
Financings
Obtém os dados dos contratos de financiamentos
get
Obtém os dados do contrato de financiamento identificado por contractId
get
Obtém a lista de garantias vinculadas ao contrato de financiamento identificado por contractId
get
Obtém os dados do cronograma de parcelas do contrato de financiamento identificado por contractId
get
Obtém os dados de pagamentos do contrato de financiamento identificado por contractId
get
Invoice Financings
Obtém a lista de contratos de antecipação de recebíveis consentidos pelo cliente.
get
Obtém os dados do contrato de antecipação de recebíveis identificado por contractId
get
Obtém a lista de garantias vinculadas ao contrato de antecipação de recebíveis identificado por contractId
get
Obtém os dados do cronograma de parcelas do contrato de antecipação de recebíveis identificado por contractId
get
Obtém os dados de pagamentos do contrato de antecipação de recebíveis identificado por contractId
get
OPEN KEYS® API Credit-cards-accounts
Credit Card
Conjunto de informações das Contas de pagamento pós paga
get
Obtém os dados de identificação da conta identificada por creditCardAccountId.
get
Obtém a lista de faturas da conta identificada por creditCardAccountId.
get
Obtém a lista de transações da conta identificada por creditCardAccountId e billId.
get
Obtém os limites da conta identificada por creditCardAccountId.
get
Obtém a lista de transações da conta identificada por creditCardAccountId.
get
Obtém a lista de transações recentes (últimos 7 dias) da conta identificada por creditCardAccountId.
get
API Customers - Open Finance Brasil
Customers
Obtém os registros de identificação da pessoa natural.
get
Obtém os registros de qualificação da pessoa natural.
get
Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa natural.
get
Obtém os registros de identificação da pessoa jurídica.
get
Obtém os registros de qualificação da pessoa jurídica.
get
Obtém os registros de relacionamentos com a instituição financeira e de representantes da pessoa jurídica.
get
OPEN KEYS® API Variable Incomes
Product List
Obtém a lista de operações de Renda Variável mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.
get
Product Identification
Obtém os dados da operação de Renda Variável identificada por investmentId.
get
Balances
Obtém a posição da operação de Renda Variável identificada por investmentId.
get
Transactions
Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Variável identificada por investmentId.
get
Transactions Current
Obtém as movimentações recentes da operação de Renda Variável identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
get
Broker Note Details
Obtém as informações da nota de negociação identificado nas movimentações de compra e venda de ativos em bolsa. O brokerNoteId é enviado nos movimentos de compra ou venda de ativos e deve ser passada como parâmetro de entrada no endpoint “Nota de Negociação”.Como conteúdo do campo brokerNoteId é esperado que a transmissora gere um identificar único, imutável, para cada número (natural) de nota de negociação.
get
OPEN KEYS® API Treasure Titles
Product List
Obtém a lista de operações de Títulos do Tesouro Direto mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.
get
Product Identification
Obtém os dados da operação de Títulos do Tesouro Direto identificada por investmentId.
get
Balances
Obtém a posição da operação de Títulos do Tesouro Direto identificada por investmentId.
get
Transactions
Obtém as movimentações da operação (últimos 12 meses) de Títulos do Tesouro Direto identificada por investmentId.
get
Transactions Current
Obtém as movimentações recentes da operação de Títulos do Tesouro Direto identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
get
OPEN KEYS® ITP v2
APIs
Enrollments v2 - Journey Session
Cria uma sessão de jornada de vínculo.
post
Lista as sessões de uma jornada de vínculo.
get
Busca por uma sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
get
Busca por uma sessão de uma jornada.
get
Payments v4 - Journey Session
Cria uma sessão de jornada ITP.
post
Lista as sessões de uma jornada.
get
Atualiza a sessão de uma jornada.
put
Busca por uma sessão de uma jornada.
get
Atualiza a sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
put
Busca por uma sessão de uma jornada, usando como referência o id externo enviado na criação da sessão.
get
Participantes
Lista as detentoras participantes do ITP.
get
Lista as organizações participantes do ITP.
get
Obtém os detalhes de uma detentora participante do ITP.
get
Obtém os detalhes de uma organização participante do ITP.
get
End User Management Session
Cria uma sessão de gerenciamento de usuário final com URL.
post
Journey
Lista as jornadas disponíveis.
get
Obtém os detalhes de uma jornada.
get
OPEN KEYS® API Funds
Product List
Obtém a lista de operações de Fundos de Investimento mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.
get
Product Identification
Obtém os dados da operação de Fundos de Investimento identificada por investmentId.
get
Balances
Obtém a posição da operação de Fundos de Investimento identificada por investmentId.
get
Transactions
Obtém as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId.
get
Transactions Current
Obtém as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
get
OPEN KEYS® API Bank Fixed Incomes
Product List
Obtém a lista de operações de Renda Fixa Bancária mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.
get
Product Identification
Obtém os dados da operação de Renda Fixa Bancária identificada por investmentId.
get
Balances
Obtém a posição da operação de Renda Fixa Bancária identificada por investmentId.
get
Transactions
Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId.
get
Transactions Current
Obtém as movimentações recentes da operação de Renda Fixa Bancária identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
get
OPEN KEYS® API Credit Fixed Incomes
Product List
Obtém a lista de operações de Renda Fixa Crédito mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.
get
Product Identification
Obtém os dados da operação de Renda Fixa Crédito identificada por investmentId.
get
Balances
Obtém a posição da operação de Renda Fixa Crédito identificada por investmentId.
get
Transactions
Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Crédito identificada por investmentId.
get
Transactions Current
Obtém as movimentações recentes da operação de Renda Fixa Crédito identificada por investmentId. O período a ser considerado para apresentação de movimentações será de até 7 dias - 7 dias anteriores da consulta, incluindo o dia da consulta (D-6).
get
Finansystech Open Finance Management - Funil de Consentimento
Funil de Consentimento - Falha da Autenticação
Reportar a falha user-authentication-failed em um fluxo do consentimento
post
Powered by
End User Management Session
Operações para gestão da sessão do usuário final.
