Skip to main content
A revenda informa a URL de callback dos eventos. Dá para alterar essa URL nas configurações da empresa no MyCredit, quando a empresa é uma revenda. Quando uma empresa associada recebe um PIX, ou quando esse PIX é estornado, o MyCredit envia o evento para a URL da revenda. A revenda é quem opera o sistema que precisa do aviso. A empresa emissora não configura um callback próprio. A consulta GET /api/pix/{idFaturaPag} continua válida. Ela é a confirmação se um evento não chegar.

Quando a URL é usada

O MyCredit só envia se:
  • a empresa do cadastro está marcada como Revenda;
  • a URL está preenchida;
  • o PIX é da própria revenda ou de uma empresa associada a ela.
Sem URL, nada é enviado. A cobrança continua consultável pelo GET.

Eventos

O corpo é JSON. O mesmo id se repete em todas as tentativas daquele evento. Use esse id para ignorar uma entrega duplicada. timestamp é o instante do evento, em UTC.
Cabeçalhos:
  • Content-Type: application/json
  • User-Agent: MyCredit-Webhook
  • X-MyCredit-Evento: pix.pago ou pix.estornado
  • X-MyCredit-Entrega: o mesmo valor de id
Responda 2xx em até 15 segundos para confirmar o recebimento. O corpo da resposta é ignorado.

Se o evento não chegar

A primeira tentativa sai assim que o pagamento ou o estorno é confirmado. Se a URL não responder 2xx, a tentativa seguinte acontece 10 minutos depois. São no máximo 9 tentativas. A primeira é imediata e as outras oito ficam espaçadas de 10 minutos, cerca de 80 minutos no total. Depois disso o evento expira e não é mais enviado. Enquanto a URL estiver errada, corrigir o cadastro vale para as tentativas que ainda faltam. Um evento já expirado não é reenviado. Consulte o GET /api/pix/{idFaturaPag} para fechar o status. Timeout, HTTP 4xx e HTTP 5xx entram na mesma fila de nova tentativa. Redirecionamento não é seguido: informe a URL final.
A URL precisa ser HTTPS. No sandbox também aceitamos HTTP, desde que o host não seja interno. Não há assinatura do corpo nesta versão: use uma URL difícil de adivinhar.