Integrações de cobrança

Configura os gateways que registram boleto, PIX e cartão pela internet (Efí, Iugu, GalaxPay, PagSeguro, Sicredi e Asaas): as credenciais, o certificado, o endereço de aviso e as opções que valem para todos. Bancos com remessa e retorno (CNAB) não precisam de integração.

Os números nas fotos correspondem aos itens logo abaixo de cada uma. Passe o mouse num item para destacar a marcação.

Os gateways Configurar um gateway Avisos e chamadas

Os gateways

12345678910

Financeiro › Integrações de cobrança. Na foto, nenhum gateway está configurado.

1. Contas bancárias abre as Contas bancárias.
2. Avisos e chamadas abre os registros das integrações (veja Avisos e chamadas).
3. Gateway e situação: Configurado, Incompleto (só parte das credenciais gravada) ou Não configurado. Quando houve falhas nas últimas 24 horas, a contagem aparece ao lado.
4. O que o gateway oferece (boleto, PIX, cartão), quantas contas usam o gateway e quando chegou o último aviso.
5. Configurar abre a configuração do gateway (veja Configurar um gateway).
6. Opções gerais: valem para todos os gateways.
7. Pagamento com cartão pelo link da fatura: o gateway que recebe o cartão, ou Não oferecer. O assinante abre o link e paga no checkout do gateway; a baixa é automática.
8. Consultar nos gateways os boletos e PIX não pagos, a cada 30 minutos, para garantir a baixa mesmo se um aviso se perder. E Retorno: cobrar na próxima mensalidade a multa e os juros não pagos, que vem marcado ao processar cada retorno (dá para mudar na hora).
9. Salvar opções grava as opções gerais.
10. Como funciona: um resumo de como as integrações trabalham.

Configurar um gateway

123456

Configurar Efí, ainda sem nenhuma credencial gravada.

1. Gateway e situação, com o que ele faz no sistema.
2. Ambiente e credenciais: o ambiente (produção ou homologação, para testes) e as chaves que o gateway fornece. Depois de gravada, a credencial secreta nunca volta para a tela: o campo diz só que ela está gravada, e em branco ela continua valendo. Marcada, a opção Apagar o valor gravado remove a credencial ao salvar.
3. Certificado da API PIX (só na Efí): o arquivo .p12 e a senha do arquivo, se houver. Sem o certificado, o PIX da Efí não funciona.
4. Endereço de aviso (webhook): o endereço para onde o gateway manda os avisos de pagamento, com o botão de copiar. Ele aparece depois de configurar as credenciais. Na Efí, no Asaas, na GalaxPay e no Sicredi, o botão Cadastrar com o nome do gateway (na foto, Cadastrar na Efí) cadastra o endereço lá. Na Iugu e no PagSeguro, o endereço vai junto em cada cobrança e não precisa ser cadastrado.
5. Testar conexão confere as credenciais com o gateway. Fica apagado até o gateway estar configurado e enquanto houver mudança sem salvar.
6. Salvar grava o ambiente e as credenciais. Fechar fecha sem salvar.

A chave secreta do endereço de aviso nasce quando você salva um gateway já configurado. Se o gateway foi configurado antes disso, o quadro mostra Endereço ainda não gerado e o botão Gerar endereço, ao lado do Cadastrar: ele cria a chave, e o endereço passa a aparecer. No gateway sem configurar, esse botão não aparece e o quadro diz Disponível depois de configurar as credenciais, como na foto.

No fim do quadro ficam as contas que usam o gateway (com Nova conta, que abre o cadastro de conta já com este gateway), a última chamada à API e o último aviso recebido. No Asaas, o quadro também traz o passo a passo para cadastrar o endereço à mão no painel do Asaas.

Passo a passo

1. Clique em Configurar no gateway.
2. Escolha o ambiente e cole as credenciais que o gateway forneceu.
3. Na Efí, envie o certificado .p12 da API PIX.
4. Clique em Salvar e depois em Testar conexão.
5. Cadastre o endereço de aviso com o botão do gateway, quando houver.
6. Em Contas bancárias, cadastre a conta do tipo deste gateway.

Nota

O endereço de aviso tem uma chave secreta: não o publique. O pagamento que chega pelo aviso é sempre conferido na API do gateway antes da baixa. Credenciais e certificado ficam cifrados. Esta tela só aparece para quem tem a permissão de configurar as integrações de cobrança; por padrão, o Administrador.

Avisos e chamadas

1234

Integrações de cobrança › Avisos e chamadas. Na foto, a lista está vazia: nenhum gateway mandou aviso.

1. Integrações volta para as Integrações de cobrança.
2. Abas: Avisos recebidos (o que os gateways enviaram) e Chamadas às APIs (o que o sistema pediu a eles), cada uma com a contagem.
3. Busca por evento ou referência. Na aba de chamadas, por operação ou endereço.
4. Filtros por gateway e situação. Nos avisos: na fila, processado, ignorado ou erro. Nas chamadas: sucesso ou falhou.

Cada aviso mostra quando chegou, o gateway, o evento com a referência, a cobrança (o número abre os detalhes da cobrança), a situação com a mensagem e a origem. Clique na linha do aviso para ver o conteúdo que o gateway mandou. Cada chamada mostra quando foi feita, o gateway, a operação, o resultado com o erro, o código HTTP com a duração e o link para a cobrança.

O topo da tela conta os avisos com erro e as chamadas com falha nas últimas 24 horas.

Telas relacionadas

• Contas bancárias
• Boletos e PIX