Pré requisitos para integração

• Ter um contrato de parceria ativo com a Zapay. Caso você ainda não tenha, verifique mais informações em Quero ser um parceiro Zapay
• Possuir suas credenciais de acesso as API’s da Zapay. Para o passo a passo, consulte o tópico Preparação de ambientes e Autenticação previamente.
• Ter familiaridade com API’s no padrão REST e arquiteturas assíncronas.
• Ter configurado um webhook para receber o resultado das solicitações da pesquisa de débitos

Configure seu webhook

Antes de seguir você precisará cadastrar um endpoint webhook para receber os resultados do seu pedido de pagamento, clique aqui e para saber como configurar o seu endpoint webhook.

📘

Sobre o webhook

Nossa solução é orientada a eventos. Além de trabalharmos com lógica de agregação (objeto atual com o ultimo status) temos todo o ciclo de vida do objeto, desde sua criação até a finalização, de forma detalhada.

Para cada mudança no objeto, disponibilizamos um evento via webhook, contendo data e hora da requisição, detalhes do evento, status de resposta do endpoint e um identificador único para cada evento.

Agora que você já tem seu webhook configurado, você estará apto a realizar suas consultas de débitos veiculares e receber o resultado da consulta de forma assíncrona no endpoint cadastrado.