Jump to Content
Guides
API Reference
Changelog
v2.0
Log In
API Reference
Log In
v2.0
API Reference
Visão Geral sobre o Pagamento
All
Pages
Start typing to search…
JUMP TO
ZApay API
Autenticação
Webhook
Webhook
Listar Webhooks
get
Cadastrar Url Para Receber Webhooks
post
Exibir Detalhes De Um Webhook
get
Atualizar Um Webhook
put
Excluir Um Webhook
del
Listar Histórico De Eventos De Um Webhook
get
Forçar Reenvio De Um Evento
post
Recuperar Detalhes De Um Evento
get
ZAPI
Consulta de Débitos Veiculares
Solicitação De Consulta
post
Solicitação De Consulta Em Lote
post
Verificação De Status Da Pesquisa Em Lote De Veículos
get
Consulta Resultado Da Pesquisa Em Lote De Veículos
get
Eventos de Webhook
Token de Cartão de Pagamento
Criar Token de Cartão de Pagamento
post
Monitoramento
Obtém o último resultado da assinatura de monitoramento
get
Ecommerce
Busca um pedido.
get
Busca um lote de recibos.
get
CRLV
Eventos de Webhook
Busca os estados habilitados para a emissão do CRLV.
get
Busca o status da emissão do CRLV.
get
Atualiza dados da solicitação de emissão do CRLV.
patch
Iniciar processo de emissão do CRLV
post
Adicionar débito ao protocolo.
post
PAGAMENTOS
Visão Geral sobre o Pagamento
Pedidos
Criar Pedido de Pagamento
post
Buscar Pedido de Pagamento
get
Validar Opções de Pagamento
post
Fechar Pedido de Pagamento
patch
Bifrost
Buscar pedidos realizados
get
Recorrência
Faturas
Criar uma nova fatura
post
Listar todas as faturas
get
Obter detalhes de uma fatura
get
Cancelar uma fatura
del
Editar metadados de uma fatura
patch
Planos
Criar um novo plano
post
Listar todos os planos
get
Obter detalhes de um plano específico
get
Atualizar um plano
put
Deletar um plano
del
Editar metadados de um plano
patch
Assinaturas
Criar assinatura a partir de um Plano
post
Listar todas as assinaturas
get
Obter detalhes de uma assinatura específica
get
Cancelar assinatura
del
Editar data de faturamento da assinatura
patch
Editar cartão da assinatura
patch
Editar metadados da assinatura
patch
Incluir item em uma assinatura
post
Listar items de uma assinatura
get
Editar item de uma assinatura
put
Remover item de uma assinatura
del
ALERTA DE DÉBITOS
Visão Geral sobre o Alerta de Débitos
Pontos da CNH
Buscar pontos da CNH
post
AutoRadar
Eventos de Webhook
Listar Assinaturas
get
Criar Assinatura
post
Atualiza Veículo
patch
Cancelar Assinatura
post
Desativar Assinatura
post
Ativar Assinatura
post
Criar Várias Assinaturas
post
Desativar Várias Assinaturas
post
Monitoramento
Monitoramento
Cria um novo plano de monitoramento
post
Cria uma nova assinatura de monitoramento
post
Lista planos de monitoramento
get
Cria várias assinaturas de monitoramento
post
Adiciona contrato a uma assinatura de monitoramento
post
Lista as assinaturas de monitoramento
get
Obtém uma assinatura de monitoramento
get
Atualiza dados da assinatura
put
Busca restrições de um veículo
get
Cancela uma assinatura de monitoramento
put
Desativa uma assinatura de monitoramento
put
Ativa uma assinatura de monitoramento
put
Desativa várias assinaturas de monitoramento
put
Atualiza dados cadastrais do veículo
put
Desativa um contrato
put
Cria uma nova assinatura de monitoramento para o alerta de multas
post
Ativa um contrato desativado
put
Obtém uma assinatura de monitoramento pelo external_id
get
Cancela uma assinatura de monitoramento pelo external_id
put
Cancela um contrato de uma assinatura de monitoramento pelo external_id
put
Webhook dos resultados de monitoramento
post
Webhook de confirma de criação de assinatura
post
Habilita um contrato desativado de uma assinatura de monitoramento pelo external_id
put
Webhook de falha na criação de assinatura
post
Webhook de confirmação de desativação de assinatura
post
Webhook de falha na desativação de assinatura
post
Powered by
Visão Geral sobre o Pagamento
Ask AI
