Sobre os Webhooks

Você poderá identificar os eventos de duplicatas enviados pela Monkey e consultar o payload detalhado de cada notificação.

Sua API deve respeitar o princípio de idempotência, pois em casos raros o webhook poderá ser entregue mais de uma vez.

Timeout e idempotência

Ao enviar um webhook, aguardamos até 10 segundos para estabelecer a conexão e 60 segundos pela resposta da sua API. Caso esse prazo seja excedido ou a resposta tenha um status HTTP diferente de 2xx, a entrega será considerada uma falha.

Como um mesmo evento pode ser entregue mais de uma vez, sua API deve garantir a idempotência do processamento. Recomendamos responder com 2xx o mais rápido possível, processar operações demoradas de forma assíncrona e utilizar o identificador único do evento para evitar duplicidades.

Como interpretar uma notificação

Cada webhook informa uma mudança relevante no ciclo de vida de uma duplicata. Use eventType para identificar o nome técnico do evento e type para classificar a ocorrência quando esse campo estiver presente.

Os objetos em _links contêm URLs para consultar os recursos relacionados ao evento. A documentação de cada evento descreve os campos disponíveis no payload e os links que podem ser consultados.

Eventos disponíveis

Duplicata vinculada a uma nota

Tipo: MATCHED

Tipo do evento: TradeInstrumentMatchedEvent

Receba uma notificação quando uma duplicata for vinculada a uma nota fiscal.

Duplicata com divergências e vinculada a uma nota fiscal

Tipo: MISMATCHED

Tipo do evento: TradeInstrumentMismatchedEvent

Receba uma notificação quando o vínculo entre uma duplicata e uma nota fiscal for feito, mas com divergencias.

Duplicata não vinculada a uma nota

Tipo: UNMATCHABLE

Tipo do evento: TradeInstrumentUnmatchableEvent

Receba uma notificação quando uma duplicata não puder ser vinculada a uma nota fiscal.

Manifestação de aceite

Tipo: ACCEPTANCE

Tipo do evento: TradeInstrumentAcceptedEvent

Receba uma notificação quando uma manifestação de aceite for registrada para uma duplicata.

Manifestação de recusa

Tipo: REFUSAL_DUE_TO_AMOUNT_DISCREPANCY

Tipo do evento: TradeInstrumentRefusedEvent

Receba uma notificação quando uma recusa por divergência de valor for registrada para uma duplicata.

Anotação comercial

Tipo: COMMERCIAL_NOTE

Tipo do evento: TradeInstrumentAnnotationIncludedEvent

Receba uma notificação quando uma anotação comercial for registrada para uma duplicata.

Negociação da duplicata

Tipo: não informado no payload

Tipo do evento: TradeInstrumentNegotiatedEvent

Receba uma notificação quando uma negociação de duplicata for registrada, incluindo as partes envolvidas e as notas fiscais negociadas.

Próximos passos

Selecione um evento para consultar o payload completo e a descrição de seus campos.
Use os links em _links para obter detalhes dos recursos relacionados ao evento recebido.