Perguntas frequentes

Posso consultar chaves Pix?

Conforme a Resolução BCB nº 1, de 12 de agosto de 2020, na Seção II — Do acesso, existem regras específicas sobre quem pode acessar as informações do Diretório de Identificadores de Contas Transacionais (DICT).

De acordo com a normativa, o acesso às informações do DICT é permitido apenas a participantes diretos e indiretos do sistema. O Banco Central define claramente quem pode acessar esse ambiente, e qualquer acesso fora dessas condições não é permitido.

Portanto, aplicações que não se enquadram como participantes diretos ou indiretos não possuem acesso a essas informações.

Como posso identificar a origem dos disparos de webhook?

Os webhooks são enviados a partir de IPs dinâmicos, o que significa que os endereços IP podem variar a cada envio.

Para garantir a identificação e segurança das notificações, recomenda-se a configuração de um header personalizado no webhook.

Exemplo de configuração

{
  "uri": "{your_webhook_url}",
  "enabled": true,
  "headers": {
    "headerName": "{your_header_name}"
  }
}

Com essa configuração, cada webhook enviado incluirá o header definido, permitindo validar a origem da mensagem.

Configurando certificado mTLS

Você pode utilizar o Postman para realizar as requisições apresentadas nesta documentação. A collection disponibilizada contém todos os endpoints, facilitando o processo de testes e integração.

Configurando o Postman para importar certificados

Acesse as configurações do Postman

Vá até a aba Certificates

Clique em Add certificate...

Em seguida, informe a URL do ambiente de Homologação que você recebeu e escolha uma das opções:

Opção 1 — Arquivos CRT e KEY

Em CRT file, selecione o arquivo .crt

Em KEY file, selecione o arquivo .key

Opção 2 — Arquivo PFX

Em PFX file, selecione o arquivo .pfx

No campo Passphrase, informe a senha do certificado enviada por e-mail

Como gerar minhas credenciais?

Acesse o portal Finance

No menu lateral, clique em Configurações

Acesse:

API QRCodes, ou

API Contas

Nessas seções, é possível criar e gerenciar suas credenciais de acesso.

O webhook da API de QRCodes possui status?

A API de QRCodes possui um comportamento diferente da API de Contas em relação aos webhooks.

A API de Contas trabalha com status para acompanhar eventos

A API de QRCodes não utiliza status

No caso da API de QRCodes, o webhook retorna apenas um payload contendo dados do pagador e informações da cobrança. O envio ocorre somente quando a cobrança é efetivamente paga.

Alternativa

É possível utilizar o webhook de recebimentos da API de Contas para complementar esse fluxo.

Nesse cenário:

Todos os recebimentos serão notificados via webhook

Para identificar a origem do evento, utilize o campo txid:

Situação	Interpretação
`txid` preenchido	Refere-se a uma cobrança
`txid = null`	Refere-se a um recebimento tradicional

Perguntas Frequentes

Perguntas frequentes#

Posso consultar chaves Pix?#

Como posso identificar a origem dos disparos de webhook?#

Exemplo de configuração#

Configurando certificado mTLS#

Configurando o Postman para importar certificados#

Opção 1 — Arquivos CRT e KEY#

Opção 2 — Arquivo PFX#

Como gerar minhas credenciais?#

O webhook da API de QRCodes possui status?#

Alternativa#