Notificações e eventos

As operações da API de Banking-as-a-service da Zoop funcionam de maneira totalmente integrada ao serviço Eventos e Webhooks da plataforma principal da zoop. Sempre que ocorre uma alteração em um dos recursos do seu marketplace um evento é gerado por essa ocorrência e enviado para os webhooks cadastrados.

Para acessar a documentação do serviço de eventos e webhooks e conhecer mais sobre como registrar e receber eventos da plataforma da zoop acesse a Documentação de Eventos e Webhooks

Os eventos à serem disparados são gerados de acordo com as alterações dos seus recursos dentro da Zoop, seja via integrações de APIs, via Dashboard ou até mesmo via fluxos internos da nossa plataforma. Os eventos são categorizados utilizando recursos e ações. Cada recurso permite um certo conjunto de eventos.

Lista de eventos

Credenciamento
Conta
Cartão
Pagamentos
Transferências
TED
PIX
Credenciamento

Evento

Descrição

accreditation.holder.created

Enviado quando um holder é criado

accreditation.holder.updated

Enviado quando um holder é atualizado

accreditation.holder.cancelled

Enviado quando um holder é cancelado

accreditation.holder.approval_request

Enviado quando o usuário requisita a aprovação do cadastro

accreditation.holder.approved

Enviado quando o cadastro do holder é aprovado

accreditation.holder.denied

Enviado quando o cadastro do holder é negado

accreditation.partner.created

Enviado quando um partner é criado

accreditation.partner.updated

Enviado quando um partner é atualizado

accreditation.partner.deleted

Enviado quando um partner é excluído

accreditation.associate.created

Enviado quando um associate é criado

accreditation.associate.updated

Enviado quando um associate é atualizado

accreditation.associate.deleted

Enviado quando um associate é excluído

accreditation.holder.phone.created

Enviado quando um telefone para um holder é criado

accreditation.partner.phone.created

Enviado quando um telefone para um partner é criado

accreditation.associate.phone.created

Enviado quando um telefone para um associate é criado

accreditation.holder.phone.updated

Enviado quando um telefone para um holder é atualizado

accreditation.partner.phone.updated

Enviado quando um telefone para um partner é atualizado

accreditation.associate.phone.updated

Enviado quando um telefone para um associate é atualizado

accreditation.holder.phone.deleted

Enviado quando um telefone para um holder é excluído

accreditation.partner.phone.deleted

Enviado quando um telefone para um partner é excluído

accreditation.associate.phone.deleted

Enviado quando um telefone para um associate é excluído

accreditation.holder.address.created

Enviado quando um endereço para um holder é criado

accreditation.partner.address.created

Enviado quando um endereço para um partner é criado

accreditation.associate.address.created

Enviado quando um endereço para um associate é criado

accreditation.holder.address.updated

Enviado quando um endereço para um holder é atualizado

accreditation.partner.address.updated

Enviado quando um endereço para um partner é atualizado

accreditation.associate.address.updated

Enviado quando um endereço para um associate é atualizado

accreditation.holder.address.deleted

Enviado quando um endereço para um holder é excluído

accreditation.partner.address.deleted

Enviado quando um endereço para um partner é excluído

accreditation.associate.address.deleted

Enviado quando um endereço para um associate é excluído

accreditation.holder.document.created

Enviado quando um documento para um holder é criado

accreditation.partner.document.created

Enviado quando um documento para um partner é criado

accreditation.associate.document.created

Enviado quando um documento para um associate é criado

accreditation.holder.document.deleted

Enviado quando um documento para um holder é excluído

accreditation.partner.document.deleted

Enviado quando um documento para um partner é excluído

accreditation.associate.document.deleted

Enviado quando um documento para um associate é excluído

payment_account.holder.disabled

Enviado quando um usuário é desabilitado e fica impossibilitado de operar

Conta

Evento

Descrição

payment_account.created

Enviado quando há a criação de nova conta de pagamentos

payment_account.disabled

Enviado quando uma conta é desabilitada e fica impossibilitada de operar

Cartão

Evento

Descrição

pre_paid_card.created

Enviado no momento do pedido do cartão

pre_paid_card.cancelled

Enviado no momento do cancelamento do cartão

pre_paid_card.updated

Enviado no momento de qualquer atualização nos dados do cartão( Bloqueio, desbloqueio e etc )

pre_paid_card.denied

Enviado no momento que um pedido de cartão é negado

pre_paid_card.operation.success

Enviado quando uma operação com cartão pré-pago é aprovada ou revertida (refund) com sucesso

pre_paid_card.operation.fail

Enviado quando uma operação com cartão falha por algum motivo

pre_paid_card.operation.denied

Enviado quando uma operação é negada por algum motivo

Pagamentos

Evento

Descrição

payment_account.operation.created

Enviado quando há a criação de uma nova operação de conta

payment_account.payment.created

Enviado quando há um pagamento de conta realizado

payment_account.payment.confirmed

Enviado quando há um pagamento de conta confirmado

payment_account.payment.failed

Enviado quando há um pagamento de conta negado ou rejeitado pelo banco emissor

Transferências

Evento

Descrição

payment_account.p2p_transfer.created

Enviado quando há a criação de uma nova transferência entre contas

TED

Evento

Descrição

received_transfer.operation.error

Enviado quando há um erro no recebimento de TED

received_transfer.operation.paid

Enviado quando um recebimento de TED é pago

received_transfer.operation.refunded

Enviado quando um recebimento de TED é estornado confirmado

received_transfer.operation.received

Enviado quando um recebimento de TED

send_transfer.operation.authorized

Enviado quando a API recebe uma requisição de envio de TED

send_transfer.operation.paid

Enviado quando a TED é confirmada

send_transfer.operation.refunded

Enviado quando a TED é estornada

send_transfer.operation.error

Enviado em caso de erro na solicitação da TED

PIX

Evento

Descrição

pix.entry.created

Enviado quando uma chave PIX é criada

pix.entry.confirmed

Enviado quando a criação de uma chave PIX e confirmada

pix.entry.deleted

Enviado quando uma chave PIX é excluída

pix.claim.created

Enviado quando uma reinvindicação de chave PIX é criada

pix.claim.cancelled

Enviado quando uma reinvindicação de chave PIX é cancelada

pix.credit.created

Enviado quando um recebimento de pix é criado. Neste momento ainda não há crédito na conta do recebedor

pix.credit.failed

Enviado quando um recebimento de pix falha

pix.credit.succeeded

Enviado quando um recebimento de pix é finalizado com sucesso tendo a conta do recebedor sido creditada com sucesso

pix.debit.created

Enviado quando um pagamento pix é criado. Neste momento há nenhuma sensibilização de saldo

pix.debit.executed

Enviado quando um pagamento pix é executado junto ao Bacen retendo o saldo necessário para a transação

pix.debit.suceedded

Enviado quando um pagamento pix é finalizado com sucesso e está valido entre todos os participantes do ecossistema Pix

pix.debit.cancelled

Enviado quando um pagamento pix é cancelado sem ter sido executado

pix.debit.failed

Enviado quando um pagamento pix é cancelado antes de completar o processo de confirmação da liquidação de pagamento para o recebedor da operação

pix.refund.succeeded

Enviado quando um estorno de PIX é bem sucedido

pix.refund.executed

Enviado quando um estorno de PIX é executado