Jump to Content
Sobre o Dev Portal
Nossos Cases de Sucesso
Status page
Home
Documentação
Referência da API
Fórum
Sobre o Dev Portal
Nossos Cases de Sucesso
Status page
Log In
Referência da API
Log In
Home
Documentação
Referência da API
Fórum
Documentação Interativa
All
Pages
Start typing to search…
JUMP TO
VINDI HUB
Introdução à API de Venda Recorrente
Quais são os códigos de retorno HTTP da API
Boas Práticas Webhook
Criando uma chave de acesso
Utilizando a SDK-PHP
Primeiros Passos
Segurança e Autenticação
IPs utilizados na Vindi para enviar webhooks
Rate Limit
Especificações Técnicas
Bibliotecas
Buscas e Filtros
Webhooks Configurações
Paginação
Webhooks Formatos e métodos de envio
Webhooks
Webhooks Retentativas
Documentação Interativa
Webhooks Conteúdo da Requisição e Eventos
Versionamento e Manutenção
Webhooks Segurança e Testes
Ambientes para Testes
Payload dos webhooks
Endpoints da API Venda Recorrente
ENDPOINTS VINDI HUB
customers
Cadastra um novo cliente.
post
Retorna um cliente específico através do ID.
get
Atualiza um cliente existente através do ID.
put
Arquiva um cliente específico através do ID.
del
Retorna uma lista de clientes.
get
Reverte o arquivamento de um cliente.
post
plans
Cadastra um novo plano.
post
Retorna um plano específico através do ID.
get
Atualiza um plano existente.
put
Retorna uma lista de planos.
get
Retorna os itens do plano através de seu ID.
get
products
Cadastra um novo produto.
post
Retorna um produto específico através do ID.
get
Atualiza um produto existente.
put
Retorna uma lista de produtos.
get
payment_methods
Retorna um método de pagamento específico através do ID.
get
Lista todos os métodos de pagamento disponíveis.
get
discounts
Cria um desconto em uma assinatura existente.
post
Retorna uma desconto específico através do ID.
get
Cancela um desconto através do ID.
del
subscriptions
Cria uma nova assinatura.
post
Reativa uma assinatura cancelada através do ID.
post
Retorna uma assinatura específica através do ID.
get
Atualiza uma assinatura existente.
put
Cancela uma assinatura através do ID.
del
Renova uma assinatura existente.
post
Retorna uma lista de assinaturas.
get
Retorna os itens de uma assinatura através do seu ID.
get
product_items
Cadastra um novo item em uma assinatura existente.
post
Retorna um item da assinatura específico através do ID.
get
Atualiza um item existente.
put
Remove um item através do ID.
del
periods
Retorna um período específico através do ID.
get
Atualiza um período existente.
put
Emite uma nova fatura baseada em um período.
post
Retorna uma lista de registros de utilização para um período específico.
get
Retorna uma lista de períodos.
get
bills
Cria uma nova fatura avulsa.
post
Retorna uma fatura específica através do ID.
get
Atualiza uma fatura existente.
put
Cancela uma fatura através do ID.
del
Gera notas fiscais de uma fatura através do ID.
post
Antecipa imediatamente a cobrança de uma fatura através do ID.
post
Aprova uma fatura através do ID.
post
Retorna uma lista de faturas.
get
Retorna os itens de fatura através de seu ID.
get
bill_items
Retorna um item específico através do ID.
get
charges
Captura manualmente uma cobrança previamente autorizada.
post
Revisa manualmente uma cobrança suspeita de fraude.
post
Retorna uma cobrança específica através do ID.
get
Atualiza uma cobrança existente.
put
Cancela uma cobrança existente.
del
Estorna uma cobrança existente.
post
Efetua uma nova tentativa em uma cobrança existente.
post
Reemite uma cobrança existente usando outro método de pagamento.
post
Retorna uma lista de cobranças.
get
transactions
Retorna uma transação específica através do ID.
get
Atualiza uma transação existente.
put
Retorna uma lista de transações.
get
Insere uma nova transação manual.
post
Retorna uma lista de transações de recuperação de inadimplência.
get
payment_profiles
Cadastra um novo perfil de pagamento para um cliente existente.
post
Retorna um perfil de pagamento específico através do ID.
get
Atualiza um perfil de pagamento existente através do ID.
put
Inativa um perfil de pagamento existente através do ID.
del
Retorna uma lista de perfis de pagamento.
get
Verifica a validade de um perfil de pagamento existente através do ID.
post
usages
Cria um novo registro de utilização.
post
Remove um período de utilização através do ID.
del
invoices
Emite uma nota fiscal avulsa.
post
Retorna uma nota fiscal específica através do ID.
get
Atualiza uma nota fiscal existente.
put
Cancela uma nota fiscal através do ID.
del
Efetua uma retentativa de envio de nota fiscal existente.
post
Retorna uma lista de notas fiscais.
get
movements
Cria um novo movimento financeiro de ajuste.
post
Remove um movimento financeiro pendente através de um ID.
del
messages
Envia uma nova mensagem.
post
Retorna uma lista de mensagens.
get
Retorna uma mensagem específica através do ID.
get
export_batches
Cria um novo lote de exportação.
post
Aprova um lote de exportação específico através do ID.
post
Retorna uma lista de lotes de exportação.
get
Retorna um lote de exportação específico através do ID.
get
import_batches
Efetua upload de um novo lote de importação.
post
Retorna uma lista de lotes de importação.
get
Retorna um lote de importação específico através do ID.
get
issues
Retorna uma pendência específica através do ID.
get
Retorna uma lista de pendências.
get
Atualiza uma pendência existente através do ID.
put
notifications
Cadastra uma nova notificação.
post
Remove um item da segmentação da notificação.
del
Retorna uma lista de items para segmentação da notificação.
get
Cria um item para segmentação da notificação.
post
Retorna uma notificação através do ID.
get
Atualiza uma notificação.
put
Remove uma notificação.
del
Retorna uma lista de notificações.
get
merchants
Retorna uma empresa específica através do ID.
get
Retorna a empresa atual.
get
Retorna uma lista de empresas.
get
/v1/merchants/{id}
patch
merchant_users
/v1/merchant_users
post
/v1/merchant_users/{id}
get
/v1/merchant_users/{id}
put
/v1/merchant_users/{id}
del
/v1/merchant_users/{id}/reactivate
post
Retorna uma lista de usuários associados à empresa atual.
get
roles
/v1/roles
get
users
/v1/users/current
get
public
Cadastra um novo perfil de pagamento
post
affiliates
/v1/affiliates
post
/v1/affiliates/{id}/verify
put
/v1/affiliates/{id}
get
/v1/affiliates/{id}
put
Retorna uma lista de participantes do split de pagamentos.
get
partner
Retorna uma lista de contas do parceiro.
get
Cadastra uma nova conta do parceiro
post
Powered by
Documentação Interativa
Ask AI
Como usar nossa documentação interativa do portal
