Cadastrar e Gerenciar Webhooks
Nossa API possui o modulo de Gerenciamento de Webhook, com esses serviços você consegue administrar suas rotas de Webhook sem precisar acionar o time da Onnix, esse modulo contempla os seguintes serviços:
- Cadastrar Webhook
- Consultar Webhooks cadastrados
- Atualizar Webhook
- Excluir Webhook
Informamos que, para garantir a estabilidade e previsibilidade das integrações, nunca removeremos campos de um contrato de webhook sem uma comunicação prévia aos clientes. No entanto, novos campos poderão ser adicionados conforme necessário para aprimorar as funcionalidades e o valor dos dados fornecidos. Recomendamos que nossos cliente evite restringir a entrada de webhooks com novos campos, assegurando que o sistema esteja preparado para receber essas atualizações e manter a compatibilidade contínua.
Nosso webhook é uma ferramenta transacional, projetada para notificar eventos específicos em tempo real. Ele não deve ser utilizado como base para a construção de extratos próprios pelo cliente. A fonte oficial e confiável para consulta de extratos é o extrato gerado pela Onnix. O uso indevido do webhook para essa finalidade pode levar a inconsistências nos dados.
Eventos disponíveis.
Pix| Evento | Descrição |
|---|---|
| pix-payment-out | Evento responsável por notificar a confirmação de um cash-out Pix. |
| pix-payment-in | Evento responsável por notificar um recebimento Pix. |
| pix-reversal-out | Evento responsável por notificar a confirmação da devolução de um Pix recebido. |
| pix-reversal-in | Evento responsável por notificar o recebimento de uma devolução de um Pix-out realizado. |
Transferência entre contas (P2P)
| Evento | Descrição |
|---|---|
| internal-transfer-in | Evento responsável por receber informações de um recebimento de uma Transferência Interna |
| internal-transfer-out | Evento responsável por receber informações de um envio de uma Transferência Interna |
TED
| Evento | Descrição |
|---|---|
| spb-transfer-out | Evento responsável por notificar a confirmação de uma TED realizada. |
| spb-transfer-in | Evento responsável por notificar o recebimento de uma TED. |
| spb-reversal-in | Evento responsável por notificar o recebimento de uma devolução de TED realizada. |
Cobranças Avulsas (Geração de boleto)
| Evento | Descrição |
|---|---|
| charge-in | Evento responsável por receber informações do pagamento de uma cobrança |
| charge-create | Evento responsável por receber informações de criação de uma cobrança |
| charge-canceled | Evento responsável por notificar o cancelamento de uma cobrança |
| charge-expired | Evento responsável por notificar a baixa por decurso de prazo. Quando o boleto é emitido e não é pago |
Pagamento de contas
| Evento | Descrição |
|---|---|
| billpayment | Evento responsável por receber informações de um pagamento de boleto realizado com sucesso |
| billpayment-occurrence | Evento responsável por receber informações de um pagamento de Boleto realizado com Erro |
Bloqueios Judiciais
| Evento | Descrição |
|---|---|
| judicial-movement-in | Evento disparado sempre que um valor bloqueado na conta do cliente for liberado |
| judicial-movement-out | Evento disparado sempre que um novo valor for bloqueado na conta do cliente por ordem judicial. |
| account-status | Evento disparado sempre que uma conta for bloqueada ou desbloqueada |
Cadastrar webhooks
- Clique em "Webhook"
- Clique em "Novo Webhook”
- Preencha os dados:
- URL do Webhook: Ex. "https://api.minhaloja.com.br/webhooks/gateway"
- Selecionar Eventos: Selecionar pelo menos um evento que o webhook ira receber
- Descrição: descrever sobre como vai usar (Opcional) Headers Personalizados: Colocar o nome e o valor do header (Opcional)
- Tentativas: Ajustar a quantidade de Tentativas o delay(ms) e Timeout(ms)