Como registrar DNS

Nesta sessão propomos esclarecer os passos para o registro do certificado DNS.

Pré-requisitos

Ferramenta para teste em API (pode ser Postman ou a sua ferramenta Link: https://www.postman.com/downloads/)>;
Chaves de autenticação com permissão para as APIs PIX (ClientId e Secret) criadas;
Certificado TLS 1.2 da rota que receberá o webhook (atualmente não suportamos outra versão de TLS); e
Uma rota exposta na internet para receber seu webhook (para testes rápidos sugerimos utilizar o portal Webhook.site - Test, process and transform emails and HTTP requests )

Gerando o certificado TLS 1.2

Um exemplo de como gerar o arquivo certificado SSL 1.2 utilizando o navegador Edge:

Autenticação

Certifique-se que você já tem um clientId e secret gerado para utilizar nossas api PIX. Acesse Primeiros Passos caso ainda não tenha.

Em posse de suas credencias, autentique-se no nosso ambiente: POST auth/oauth/v2/token

Use esse access token para utilizar qualquer rota do PIX, por exemplo:

Configurando seu webhook

PUT pix/direto/forintegration/v1/webhook/bs2

Verifique se a configuração funcionou na rota

GET pix/direto/forintegration/v1/webhook/bs2

Incluindo seu certificado SSL 1.2

Com a sua rota configurada, será necessário realizar a inclusão do seu certificado para que nosso gateway consiga
conversar com seu servidor de maneira segura.
Para incluir:
PUT pix/direto/forintegration/v1/webhook/bs2/certificado

Seu webhook acaba de ser configurado corretamente!
Para testar, basta realizar um pagamento ou pedir para que alguém faça um pagamento para você.

Dúvidas frequentes

Erro de “Invalid Apikey” é retornado ao consumir as apis, o que pode ser?

Verifique:

Você se autenticou com chave no ambiente de HML e está usando a API de PRD ou vice-versa;
Seu access token expirou;
Você não está utilizando o access token gerado pela rota oauth.

Recebo “Erro interno” ao incluir certificado o que fazer?

Algum serviço de HML pode estar em manutenção. Reporte ao suporte ou tentar novamente.

Ou seu certificado pode ter sido gerado fora das configurações especificadas.

Verifique se o certificado foi gerado conforme o exemplo (ver Gerando o certificado TLS 1.2);
Verifique se o certificado está sendo importado como arquivo “*.cer”.

Configurei corretamente, porém ainda não recebemos o evento de webhook

Verifique:

Campo “somenteTxId” parametrizado como true. Essa configuração está passando por uma manutenção, sendo assim, parametrize essa propriedade como false;
Você pode ter incluído um certificado diferente da versão SSL 1.2. Confira se a sua certificadora está emitindo certificados versão SSL 1.2 e reimporte-o;
Você pode ter parametrizado uma conta diferente da sua, então analise a rota de obter configurações e certifique-se de que a conta configurada é realmente aquela que você deseja receber o webhook.

Recebíamos webhook mas paramos de receber

Verifique:

O seu certificado SSL 1.2 pode ter expirado. Reimporte o certificado mais recente;
O seu certificado SSL 1.2 pode ter sido atualizado pela certificadora. Reimporte o certificado mais recente; ou
Algum de nossos serviços BS2 podem estar passando por atualização ou manutenção. Comunique ao BS2 através dos canais de suporte ou comercial.