Documentação do Webhook de Infração
Visão Geral
Nosso sistema de webhook envia notificações em tempo real sobre infrações detectadas em transações. Quando uma infração é identificada, uma requisição POST é enviada para a URL configurada com informações detalhadas da ocorrência.
Payload do Webhook
O webhook envia um payload JSON contendo os detalhes da infração e da transação relacionada.
Exemplo de Payload
Descrição dos Campos
transactionId (string): Identificador único da transação no formato UUID
transactionStatus (string): Status atual da transação. Valores possíveis:
MED: Transação solicitada MED
transactionType (string): Tipo da transação, neste caso “CASH_IN”
value (string): Valor da transação
externalId (string): ID de referência externa fornecido pelo cliente
medStatus (string): Status do MED. Valores possíveis:
ACKNOWLEDGED: Quando a solicitação do MED é recebida
CANCELLED: Quando o MED é cancelado e o valor estornado para conta
DEBITED: Quando a defesa do MED não é aceita e o valor enviado para o cliente.
Resolução da disputa (após envio da defesa)
Quando o parceiro responde à solicitação de MED via API de Disputa de MED, o resultado final do PSP é entregue por este mesmo webhook. O payload inclui o externalId original e o e2e_id da transação.
Exemplo de Payload
Valores de medStatus após a defesa
Boas Práticas
O Webhook deve retornar Status Code 200
Para que a transação tenha seu fluxo finalizado com Sucesso é de extrema importancia que seja retornado 200 na resposta!
Consulta de Comprovante
Endpoint
Parâmetros do Path
transactionId (string): Identificador único da transação no formato UUID
Exemplo de Requisição
Resposta de Sucesso
Descrição dos Campos da Resposta
status (string): Status da requisição
data (object): Objeto contendo os dados do comprovante
receipt (string): Conteúdo do comprovante em formato base64
mimeType (string): Tipo do arquivo do comprovante (application/pdf)
Observações
- O campo
receipt contém o arquivo PDF codificado em base64
- Para visualizar o comprovante, é necessário decodificar o conteúdo base64 para PDF