Webhooks

Uma forma de realizar comunicação entre sistemas, de forma assíncrona e passiva, onde o requisitante não precisa aguardar, na mesma chamada que fez, os dados solicitados ou o resultado de uma operação. Assim você recebe uma chamada assim que um evento acontece como, por exemplo: solicitou uma cotação e então recebeu os dados dessa cotação via webhook.

Vantagens

  1. Operação em tempo real
  2. Economia (não é necessário realizar polling)
  3. Agilidade na comunicação de sistemas

Como registrar?

Para que sejam configurados os endereços, durante o processo de Onboarding, devem ser informados:

  • Endereço (URL)
  • Forma de autenticação:
    • API Key — caso seja essa a escolhida, deve ser informado o método/verbo HTTP para autenticar.
    • OAuth 2.0
  • Payload:
    • Padrão MOVA
    • Customizado

Webhooks disponíveis

Cotação (6 webhooks)

Webhook
Aprovada
Reprovada
Pendente
Cancelada
Documento Aprovado
Documento Reprovado

Pagamento (6 webhooks)

Webhook
Parcela Atualizada
Parcela Baixada (Pagamento)
Parcela Baixada (Renegociação)
Parcela Atrasada
Contrato Consolidado (Renegociação)
Erro de Processamento

Proposta (18 webhooks)

Webhook
Aprovada
Reprovada
Cancelada
Em assinatura
Confirmar contrato
Em liquidação
Liquidada
Desembolso automático
Erro de desembolso automático
Desembolso automático em lote
Erro de desembolso automático em lote
Quitada
Trava Fumaça — CIP
Contrato Rejeitado — Núclea/CIP
Trava Geral — CERC
Contrato Recusado — CERC
Contrato Atualizado — CERC
Contrato Recusado Atualizado — CERC

Especificação

Carregando documentação...