Webhook completo

A integração com Webhook tem duas etapas: (1) você desenvolve uma API própria que recebe os eventos, e (2) contrata o Webhook informando a URL dessa API.

Requisitos do seu endpoint receptor

  • HTTPS com certificado não autoassinado; TLS 1.2.
  • Responder HTTP 200 em até 10 segundos — senão o evento é marcado como "NÃO ENTREGUE".
  • Recomendado: receber, enfileirar e processar de forma assíncrona (recomendação de arquitetura, não obrigação formal da API).

Contratar Webhook POST /cobranca/boleto/v1/webhook/contrato/ · body com cooperativa, posto, codBeneficiario, eventos, url, urlStatus, contratoStatus, e opcionais nomeResponsavel, email, telefone, enviarIdTituloEmpresa, header, token.

Consultar contratos GET /cobranca/boleto/v1/webhook/contratos/ · query: cooperativa, posto, beneficiario.

Alterar contrato PUT /cobranca/boleto/v1/webhook/contrato/{id} · reutiliza os campos da contratação.

Status possíveis (contrato e URL): ATIVO, INATIVO, BLOQUEADO.

Ambiente: todas as operações de Webhook são somente Produção. Marque os servidores de cada operação como Produção para o Swagger não montar URLs de Sandbox inexistentes.

Segurança: a API não define assinatura criptográfica padrão. Use header/token para proteger seu endpoint e valide a liquidação pela API de consulta antes de processar financeiramente.



Did this page help you?