Pular para o conteúdo principal

Tipos de eventos do Webhook

Tipos de eventos do Webhook​

O Webhook é um recurso que permite que a Woovi envie notificações para sua aplicação quando um evento ocorre. Por exemplo, quando uma cobrança é paga, a Woovi envia uma notificação para o seu servidor.

Abaixo, você pode ver uma lista de todos os eventos que a Woovi envia para sua aplicação.

Obtenha a lista de eventos via API

Você também pode obter a lista completa de eventos disponíveis programaticamente através da nossa API. Consulte o endpoint GET /api/v1/webhook/events na referência da API.

Eventos de cobrança​

Os eventos de cobrança são enviados quando uma cobrança é paga.

OPENPIX:CHARGE_COMPLETED​

Esse evento é enviado quando uma cobrança é paga.

Ver exemplo de payload →

OPENPIX:CHARGE_EXPIRED​

Esse evento é enviado quando uma cobrança expira.

Ver exemplo de payload →

OPENPIX:CHARGE_CREATED​

Esse evento é enviado quando uma cobrança é criada.

Ver exemplo de payload →

OPENPIX:CHARGE_COMPLETED_NOT_SAME_CUSTOMER_PAYER​

Esse evento é enviado quando uma cobrança é paga com um payer diferente do customer.

Ver exemplo de payload →

Eventos de transação​

Os eventos de transação são enviados quando uma transação é recebida.

OPENPIX:TRANSACTION_RECEIVED​

Esse evento é enviado quando uma transação é recebida, seja ela de uma cobrança ou de um QR code estático.

Ver exemplo de payload →

OPENPIX:TRANSACTION_REFUND_RECEIVED (DEPRECATED)​

Esse evento é enviado quando é realizado o reembolso de uma transação.

Ver exemplo de payload →

PIX_TRANSACTION_REFUND_RECEIVED_CONFIRMED​

Esse evento é enviado quando uma transação de reembolso é recebida e confirmada.

Ver exemplo de payload →

PIX_TRANSACTION_REFUND_RECEIVED_REJECTED​

Esse evento é enviado quando uma transação de reembolso é recebida mas é rejeitada.

Ver exemplo de payload →

PIX_TRANSACTION_REFUND_SENT_CONFIRMED​

Esse evento é enviado quando uma transação de reembolso é enviada e confirmada.

Ver exemplo de payload →

PIX_TRANSACTION_REFUND_SENT_REJECTED​

Esse evento é enviado quando uma transação de reembolso é enviada mas é rejeitada.

Ver exemplo de payload →

Eventos de Pagamento Instantâneo​

OPENPIX:MOVEMENT_CONFIRMED​

Esse evento é enviado quando um pagamento é confirmado.

Ver exemplo de payload →

OPENPIX:MOVEMENT_FAILED​

Esse evento é enviado quando um pagamento confirmado falha.

Ver exemplo de payload →

OPENPIX:MOVEMENT_REMOVED​

Esse evento é enviado quando um pagamento é removido.

Ver exemplo de payload →

Eventos de Movimentos​

OPENPIX:DISPUTE_CREATED​

Esse evento é enviado quando uma disputa é criada

Ver exemplo de payload →

OPENPIX:DISPUTE_ACCEPTED​

Esse evento é enviado quando uma disputa é aceita

Ver exemplo de payload →

OPENPIX:DISPUTE_REJECTED​

Esse evento é enviado quando uma disputa é rejeitada

Ver exemplo de payload →

OPENPIX:DISPUTE_CANCELED​

Esse evento é enviado quando uma disputa é cancelada

Ver exemplo de payload →

Eventos de boleto​

BOLETO_SETTLED​

Esse evento é enviado quando um boleto é liquidado, ou seja quando o valor é creditado na sua conta — o que acontece em até 3 dias úteis após o pagamento, e não no ato dele. O pagamento em si é notificado pelo OPENPIX:CHARGE_COMPLETED.

O corpo repete os blocos charge e boleto do evento de cobrança paga e acrescenta o boleto.settledAt, além do boleto.boletoTransactionID, que é o id usado para consultar a transação na API.

Ver como conciliar →

Eventos de Registro de contas​

ACCOUNT_REGISTER_APPROVED​

Esse evento é enviado quando um registro de subconta é aprovado no compliance.

Ver exemplo de payload →

ACCOUNT_REGISTER_REJECTED​

Esse evento é enviado quando um registro de subconta é reprovado no compliance.

Ver exemplo de payload →

ACCOUNT_REGISTER_PENDING​

Esse evento é enviado quando um registro de subconta está em análise.

Ver exemplo de payload →

ACCOUNT_REGISTER_STEP_UPDATED​

Esse evento é enviado a cada passo do onboarding concluído pelo cliente final — dados da empresa, contrato social, sócios, selfie, BC Protege+, termos. O passo vem no payload, nos campos step, stepScope e stepStatus.

Ver o ciclo de vida completo →

ACCOUNT_REGISTER_IN_REVIEW​

Esse evento é enviado quando o registro entra em análise, seja porque o cliente final enviou o cadastro, seja porque um operador o promoveu de volta para análise.

Ver o ciclo de vida completo →

ACCOUNT_REGISTER_DOCUMENTS_REQUESTED​

Esse evento é enviado quando a análise solicita documentos novos (RFI). O payload lista os documentos pedidos para a empresa e para cada sócio, e quais passos voltaram a ficar pendentes.

Ver o ciclo de vida completo →

ACCOUNT_REGISTER_RFI_RESOLVED​

Esse evento é enviado quando o cliente final envia todos os documentos que haviam sido solicitados e a RFI é fechada.

Ver o ciclo de vida completo →

Eventos de Pix Automatico​

PIX_AUTOMATIC_APPROVED​

Esse evento é enviado quando um pix automatico é aprovado

Ver exemplo de payload →

PIX_AUTOMATIC_REJECTED​

Esse evento é enviado quando um pix automatico é rejeitado

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_CREATED​

Esse evento é enviado quando uma cobrança de pix automatico é criada

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_APPROVED​

Esse evento é enviado quando uma cobrança de pix automatico é aprovada

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_REJECTED​

Esse evento é enviado quando uma cobrança de pix automatico é rejeitada

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_COMPLETED​

Esse evento é enviado quando uma cobrança de pix automatico é paga

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_TRY_REJECTED​

Esse evento é enviado quando uma tentativa de cobrança é rejeitada

Ver exemplo de payload →

PIX_AUTOMATIC_COBR_TRY_REQUESTED​

Esse evento é enviado quando uma tentativa de cobrança é realizada

Ver exemplo de payload →