Vindi
Subscription billing and recurring payments platform.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 127 actions:
| Action | Purpose | Parameters |
|---|---|---|
| put_v1_customers_by_id | Utilize este método para atualizar um cliente existente. Atualizando números de telefone A lista de números de telefone associada ao cliente é representada pelo array phones. - Para atualizar um objeto existente no array phones, simplesmente indique seu ID e os novos atributos. - Para criar um novo objeto, informe apenas os atributos sem o ID. - Para remover um objeto existente, inclua o atributo '_destroy': '1', sem esquecer de informar o ID. Além disso é possível omitir o parâmetro ph | id (string) |
| delete_v1_customers_by_id | Esta operação moverá o cliente para a área de Arquivados da plataforma. O cliente poderá continuar recebendo novas assinaturas via API, sofrer alterações e terá seu histórico preservado. Todas as assinaturas e faturas pendentes serão canceladas automaticamente. | id (string) |
| get_v1_customers_by_id | Retorna um cliente específico através do ID. | id (string) |
| post_v1_customers | Utilize esta função para criar novos clientes na plataforma. Cliente é uma das entidades básicas do sistema. Ele representa a pessoa física ou jurídica que possui uma ou mais assinaturas. Código da API Quando utilizado, o campo code deve ser único em todo escopo da empresa. Recomendamos o uso de um código auto-incrementável do seu próprio banco de dados. Desaconselhamos a utilização de qualquer dado que seja informado pelo cliente, como e-mail ou número do documento. | No parameters |
| get_v1_customers | Utilize este método para listar os clientes associados à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codename/code, codestatus/code, codecode/code, codeemail/code, coderegistry_code/code, codecreated_at/code e codeupdated_at/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| post_v1_customers_by_id_unarchive | Reverte o arquivamento de um cliente. | id (string) |
| put_v1_plans_by_id | Verifique documentação dos atributos no método GET plans/id. Atualizando produtos relacionados A lista de produtos relacionados à um plano é representado pelo array plan_items. - Para atualizar um objeto existente no array plan_items, simplesmente indique seu ID e os novos atributos. - Para criar um novo objeto, informe apenas os atributos sem o ID. - Para remover um objeto existente, inclua o atributo '_destroy': '1', sem esquecer de informar o ID. Além disso é possível omitir o parâme | id (string) |
| get_v1_plans_by_id | Utilize esta função para obter um plano cadastrado na plataforma. Planos são utilizados para definir a base das assinaturas. Uma nova assinatura herdará a maioria dos atributos do plano respectivo no momento de sua criação. Se um plano for alterado, assinaturas associadas não serão atualizadas automaticamente. Duração do plano A duração do plano é definida a partir da combinação de 3 atributos: interval, interval_count e billing_cycles. Com esses atributos é possível gerar qualquer combin | id (string) |
| post_v1_plans | Verifique documentação dos atributos no método GET plans/id. | No parameters |
| get_v1_plans | Utilize este método para listar os planos associados à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codeinstallments/code, codename/code, codeinterval_count/code, codeinterval/code, codebilling_cycles/code, codecode/code, codestatus/code, codebilling_trigger_day/code, codebilling_trigger_type/code, | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_plans_by_id_plan_items | Utilize este método para listar os itens associados a um produto. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination. | id (string) page (string) per_page (string) |
| put_v1_products_by_id | Verifique documentação dos atributos no método GET products/id. | id (string) |
| get_v1_products_by_id | Produtos definem os itens associados a uma assinatura ou fatura. Precificação A plataforma Vindi suporta vários tipos diferentes de cálculos de precificação para os produtos. Consulte este artigohttp://atendimento.vindi.com.br/hc/pt-br/articles/203303380 para mais informações sobre os métodos de cálculo. | id (string) |
| post_v1_products | Verifique documentação dos atributos no método GET products/id. | No parameters |
| get_v1_products | Utilize este método para listar os produtos associados à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codename/code, codecode/code, codestatus/code, codeinvoice/code, codeunit/code, codepricing_schema_id/code, codecreated_at/code, codeupdated_at/code, codeschema_type/code e codeprice/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_payment_methods_by_id | Retorna um método de pagamento específico através do ID. | id (string) |
| get_v1_payment_methods | Métodos de pagamento representam as opções de pagamento disponíveis para seus clientes. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codename/code e codecode/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| delete_v1_discounts_by_id | Cancela um desconto através do ID. | id (string) |
| get_v1_discounts_by_id | Um desconto pode ser aplicado à um item específico de uma assinatura product_item e possui duração configurável cycles. Utilize este método para obter detalhes de um desconto específico. Duração A duração de um desconto pode ser definida através do atributo cycles que representa o número de ciclos de recorrência onde o desconto será aplicado. É possível, por exemplo, configurar um desconto apenas para a próxima fatura, ou então conceder um desconto permanente. Neste último caso, o atributo | id (string) |
| post_v1_discounts | Cria um desconto em uma assinatura existente. | No parameters |
| post_v1_subscriptions_by_id_reactivate | Utilize esta função para reativar assinaturas canceladas. Leia mais sobre este assunto na documentação sobre reativação de assinaturashttp://atendimento.vindi.com.br/hc/pt-br/articles/204893474. | id (string) |
| delete_v1_subscriptions_by_id | Cancela uma assinatura através do ID. | id (string) cancel_bills (string) comments (string) |
| put_v1_subscriptions_by_id | Utilize este método para alterar os atributos de uma assinatura existente. Reagendamento da data de cobrança A data de cobrança da assinatura pode ser atualizada através dos parâmetros billing_trigger_type e billing_trigger_day. Após a atualização, a plataforma irá retornar a próxima data de cobrança calculada no atributo next_billing_at. Se esta data for igual ou anterior ao dia corrente, você poderá gerar uma fatura manualmente usando o método POST /periods/id/bill. A plataforma não irá | id (string) |
| get_v1_subscriptions_by_id | A assinatura é uma das entidades principais da plataforma e representa a relação entre um plano e um cliente. É a partir dela que faturas, cobranças e períodos são gerados. Períodos Toda assinatura possui obrigatoriamente um ou mais períodos de recorrência. Verifique a documentação do método GET subscriptions/id/periods para mais detalhes. Os períodos são gerados automaticamente pela plataforma. Status |Status|Descrição| |------|---------| |active| Assinatura ativa. O atributo curre | id (string) |
| post_v1_subscriptions_by_id_renew | O processo de renovação de assinaturas é automático. Utilize esse método para adiantar a renovação de uma assinatura. | id (string) |
| post_v1_subscriptions | Este método irá criar uma assinatura e obrigatoriamente retornar o objeto subscription. Se os parâmetros do plano indicarem uma cobrança imediata, o retorno da mesma requisição também irá conter os detalhes da fatura emitida, representada pelo objeto bill. Dentro deste objeto você poderá encontrar informações mais detalhadas sobre o processamento da transação last_transaction. Exemplo de requisição 'plan_id': 12, 'customer_id': 142, 'payment_method_code': 'credit_card', | No parameters |
| get_v1_subscriptions | Utilize este método para listar as assinaturas associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codestatus/code, codeid/code, codecode/code, codeinstallments/code, codecustomer_id/code, codeinterval/code, codeinterval_count/code, codebilling_trigger_day/code, codebilling_trigger_type/code, codebilling_c | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_subscriptions_by_id_product_items | Utilize este método para listar os itens associados a uma assinatura. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination. | id (string) page (string) per_page (string) |
| delete_v1_product_items_by_id | Remove um item através do ID. | id (string) |
| put_v1_product_items_by_id | É possível atualizar um item em uma assinatura existente, porém isso não causará nenhum reflexo imediato nas faturas já emitidas. Alterações em um item serão aplicadas apenas na próxima fatura gerada, porém de qualquer forma é possível cancelar e reemitir uma fatura já gerada. Precificação Informe o parâmetro pricing_schema apenas se quiser alterar a precificação atual do item. Consulte este artigohttp://atendimento.vindi.com.br/hc/pt-br/articles/203303380 para mais informações sobre o cál | id (string) |
| get_v1_product_items_by_id | Uma assinatura subscription é composta de um ou mais product_items, que representam os itens da assinatura que serão usados para criar as faturas bill de cada período period. | id (string) |
| post_v1_product_items | Novos itens serão aplicados apenas em novas faturas. Se desejar incluir o novo item em uma fatura existente você deverá cancelar a fatura em questão e efetuar a reemissão. Precificação Informe o parâmetro pricing_schema apenas se quiser customizar a precificação para o novo item. Consulte este artigohttp://atendimento.vindi.com.br/hc/pt-br/articles/203303380 para mais informações sobre o cálculo da precificação. | No parameters |
| put_v1_periods_by_id | Atualiza um período existente. Data de término A duração de um período pode ser atualizada modificando sua data de término. Esta atualização é possível apenas no último período de uma assinatura. Períodos subsequentes desta assinatura serão calculados conforme a nova data, respeitando o intervalo original. Data de cobrança Através deste método também é possível atualizar a data de cobrança de um período, porém a plataforma não irá realizar cobranças retroativas automaticamente. Caso | id (string) |
| get_v1_periods_by_id | Uma assinatura deve possuir obrigatoriamente um ou mais períodos, que são gerados automaticamente conforme a configuração de cobrança e periodicidade da assinatura. Em uma assinatura baseada em um plano mensal, cada período terá a duração de aproximadamente 30 dias. Registros de utilização Todo período deverá possuir um ou mais registros de utilização. A fatura do período será gerada a partir destes registros de utilização. Para produtos configurados com preço fixo ou preço por quantidade | id (string) |
| post_v1_periods_by_id_bill | Há 2 casos onde pode ser necessário gerar uma nova fatura manualmente a partir de um período: 1. Gerar uma fatura que não foi emitida automaticamente por falta de informações de registro de uso; 2. Gerar uma fatura adicional para um período. A plataforma Vindi tenta gerar automaticamente uma nova fatura na data especificada no atributo billing_at do período utilizando todos os registros de utilização não faturados até então. A nova fatura é gerada apenas se todos os itens ativos da assinatura | id (string) |
| get_v1_periods_by_id_usages | Utilize este método para listar os registros de utilização associados ao período desejado. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination. | id (string) page (string) per_page (string) |
| get_v1_periods | Utilize este método para listar os períodos associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codebilling_at/code, codesubscription_id/code, codestart_at/code, codeend_at/code, codecycle/code, codeduration/code, codecreated_at/code e codeupdated_at/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| delete_v1_bills_by_id | Cancela uma fatura através do ID. | id (string) comments (string) |
| put_v1_bills_by_id | Utilize este método para alterar os atributos de uma fatura existente. Reagendamento da cobrança agendada Através do atributo billing_at é possível atualizar a data da cobrança uma fatura agendada status=scheduled para qualquer outra data no futuro. Esteja ciente que este método não permite o reagendamento para hoje. Se desejar antecipar imediatamente a cobrança uma fatura agendada, utilize o método POST /bills/id/charge. | id (string) |
| get_v1_bills_by_id | A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente final. Faturas podem ser classificadas em dois tipos: 1. Faturas provenientes de assinaturas: São as faturas geradas a partir de assinaturas e seus respectivos períodos. 2. Faturas avulsas: Faturas que não possuem qualquer relação com uma assinatura. Faturas provenientes de assinaturas Podem ser geradas de duas formas diferentes: 1. Automaticamente no dia programado para cobrança através do a | id (string) |
| post_v1_bills_by_id_invoice | Utilize esta operação para gerar notas fiscais a partir de uma fatura existente. Para isso é necessário que exista uma integração do tipo nota fiscal ativada e a fatura ainda não possua nenhuma nota fiscal gerada. Múltiplas notas fiscais poderão ser geradas caso você esteja usando configurações com esta finalidade, como por exemplo, a nota fiscal fracionadahttps://atendimento.vindi.com.br/hc/pt-br/articles/115003695667-Nota-fiscal-fracionada. Caso seja necessário emitir notas fiscais avulsas c | id (string) |
| post_v1_bills_by_id_charge | Utilize este método para antecipar imediatamente a cobrança de uma fatura agendada status=scheduled ou então para cobrar um saldo devedor. Uma nova cobrança será emitida automaticamente. | id (string) |
| post_v1_bills_by_id_approve | Ao aprovar a fatura, a cobrança será gerada e processada dependendo do método de pagamento escolhido. Apenas faturas com o status review podem ser aprovadas. | id (string) |
| post_v1_bills | Faturas avulsas são independentes de assinaturas e podem ser usadas para cobrar qualquer tipo de valor não recorrente. Todas as faturas seguirão as configurações de retentativa e notificações previamente configuradas na plataforma. Exemplo A maioria dos parâmetros deste método são opcionais. O exemplo abaixo efetua a emissão de uma fatura avulsa usando apenas os atributos obrigatórios: 'customer_id': 28, 'payment_method_code': 'bank_slip', 'bill_items': 'product_id' | No parameters |
| get_v1_bills | Utilize este método para listar as faturas associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codecode/code, codeinstallments/code, codeperiod_id/code, codesubscription_id/code, codecustomer_id/code, codeamount/code, codestatus/code, codepayment_method_id/code, codeseen_at/code, codedue_at/c | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_bills_by_id_bill_items | Utilize este método para listar os itens associados a uma fatura. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination. | id (string) page (string) per_page (string) |
| get_v1_bill_items_by_id | Além das informações básicas sobre o item da fatura, através deste método é possível obter todos os registros de utilização associados ao item. | id (string) |
| post_v1_charges_by_id_capture | Este método permite executar a captura de uma cobrança previamente autorizada através da criação de uma nova transação de captura. É importante verificar se o gateway utilizado está configurado para aceitar capturas manuais. Verifique também o prazo máximo de captura permitido pela adquirente utilizada. | id (string) |
| post_v1_charges_by_id_fraud_review | Utilize este método para aprovar ou rejeitar uma cobrança suspeita de fraude status=fraud_review. O comportamento desta operação irá depender da configuração da integração antifraude: Análise antes da autorização Neste caso a análise ocorre antes da comunicação com a adquirente. - Aprovar approve: A aprovação de uma suspeita de fraude irá disparar a tentativa de aprovação da transação junto à adquirente. Lembre-se que esta transação pode ser aprovada ou aprovada pela adquirente. - Rejeit | id (string) |
| delete_v1_charges_by_id | Utilize este método para efetuar o cancelamento de uma cobrança aguardando pagamento. Após a operação de cancelamento, a cobrança assumirá status=canceled. | id (string) comments (string) ignore_transaction_errors (string) |
| put_v1_charges_by_id | Utilize este método para atualizar cobranças existentes. Alterar método de pagamento Não é possível alterar o método de pagamento de uma cobrança existente. Para realizar esta operação, reemita a cobrança informando um novo método de pagamento usando o endpoint POST /charges/id/reissue. | id (string) |
| get_v1_charges_by_id | Cobranças representam o valor cobrado do cliente, o método de pagamento utilizado e o número de tentativas restantes. Impressão de boleto Utilize o atributo print_url para visualizar a url do boleto bancário. É possível definir a data de visualização do boleto informando o parâmetro seen_at via query string, seguindo o formato ISO 8601. Por exemplo seen_at=2017-06-30. Esta opção permite antecipar a impressão de uma cobrança usando uma data no futuro, pré-calculando a multa e os juros caso | id (string) |
| post_v1_charges_by_id_refund | Utilize este método para efetuar o estorno ou cancelamento de uma cobrança já efetuada com sucesso. É importante observar que não é possível reverter um estorno realizado com sucesso. Após a operação de estorno, a cobrança assumirá status=canceled. O cancelamento da fatura associda é opcional e pode ser informado através da opção cancel_bill no corpo da requisição. Estorno total e parcial A operação de estorno pode ser realizada na totalidade do valor original ou parcialmente, caso seja | id (string) |
| post_v1_charges_by_id_charge | A plataforma Vindi efetua retentativas automáticas de cobranças no intervalo configurado em cada método de pagamento. Você pode consultar a data da próxima tentativa no atributo next_attempt de cada cobrança. Ainda assim poderão haver casos onde seja necessário efetuar uma tentativa extraordinária, com ou sem um novo perfil de pagamento. Apenas cobranças no cartão de crédito e débito em conta poderão sofrer retentativas através deste método. Retentativa com o perfil existente Se desejar r | id (string) |
| post_v1_charges_by_id_reissue | Para alterar o método de pagamento de uma cobrança existente é necessário efetuar o processo de reemisão. Através deste serviço, a cobrança informada será cancelada e uma nova cobrança será gerada usando os atributos enviados. Parcelamento Caso a reemissão envolva parcelamento, atente-se ao número máximo de parcelas do método de pagamento desejado. | id (string) |
| get_v1_charges | Utilize este método para listar as cobranças associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codecustomer_id/code, codebill_id/code, codeamount/code, codepayment_method_id/code, codedue_at/code, codepaid_at/code, codeinstallments/code, codeattempt_count/code, codenext_attempt/code, codesta | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| put_v1_transactions_by_id | Utilize este método para atualizar o atributo 'Nosso número' gateway_transaction_id em transações pendentes emitidas usando boleto bancário. Esta atualização é possível apenas caso o método de pagamento em questão não utilize a sequência autoincrementável da transação. | id (string) |
| get_v1_transactions_by_id | Transações representam a comunicação com instituições financeiras. | id (string) |
| post_v1_transactions | Este método deve ser utilizado apenas para efetuar a baixa manual de cobranças pagas através de métodos que não são controlados pela plataforma Vindi, como por exemplo, dinheiro em espécie ou depósito em conta. Quando você utiliza a criação manual de transações, a plataforma Vindi considera que o valor em questão foi de fato recebido. Por este motivo, não use este método para conceder descontos, créditos ou abonos. Cálculo de multa e juros Caso a configuração do método de pagamento origi | No parameters |
| get_v1_transactions | Utilize este método para listar as transações associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codecustomer_id/code, codecharge_id/code, codegateway_id/code, codeconnector/code, codepayment_method_id/code, codetransaction_type/code, codeamount/code, codeinstallments/code, codestatus/code, c | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_transactions_recoveries | Retorna uma lista de transações com recuperação de inadimplencia de um merchant dentro de um período específico | start_on (string) required end_on (string) required name (string) required |
| put_v1_payment_profiles_by_id | Atualiza um perfil de pagamento existente através do ID. | id (string) |
| delete_v1_payment_profiles_by_id | Inativa um perfil de pagamento existente através do ID. | id (string) remove_permanently (string) |
| get_v1_payment_profiles_by_id | Retorna um perfil de pagamento específico através do ID. | id (string) |
| post_v1_payment_profiles | O perfil de pagamento representa um cartão de crédito ou uma conta bancária armazenada na plataforma Vindi. Leia mais na documentaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/204406204-Perfil-de-pagamento. Exemplo de requisição para cartão de crédito 'holder_name': 'José da Silva', 'card_expiration': '12/2018', 'card_number': '5167454851671773', 'card_cvv': '123', 'payment_method_code': 'credit_card', 'payment_company_code': 'mastercard', 'customer_id': 51 E | No parameters |
| get_v1_payment_profiles | Utilize este método para listar perfis de pagamento associados à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Exemplo Para verificar se determinado cliente possui um cartão de crédito ativo, utilize os seguintes filtros no parâmetro query: customer_id=id do cliente status=active type=PaymentProfile::CreditCard Atributos par | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| post_v1_payment_profiles_by_id_verify | Este método permite verificar se um perfil de pagamento existente é válido na entidade emissora. Apenas o método de pagamento cartão de crédito suporta esta operação. Utilize esta função para validar um perfil de pagamento antes da criação de uma assinatura que não possua cobrança imediata. Este método é desnecessário para assinaturas com cobrança imediata. Funcionamento Preferencialmente a plataforma Vindi irá executar o método de validação fornecido nativamente pelas adquirentes. Caso e | id (string) |
| delete_v1_usages_by_id | Somente é possível remover um registro de utilização que não está associado a uma fatura. Se o período já estiver faturado, será necessário cancelar a fatura antes de removê-lo. | id (string) |
| post_v1_usages | Para criar um novo registro de utilização em um período é necessário informar um dos produtos contidos na assinatura. Isso pode ser feito através do atributo product_id ID do produto ou product_item_id ID do item da assinatura. Ao remover um registro com sucesso, o próprio será retornado no corpo da resposta. | No parameters |
| delete_v1_invoices_by_id | Cancela uma nota fiscal através do ID. | id (string) |
| put_v1_invoices_by_id | Atualiza uma nota fiscal existente. | id (string) |
| get_v1_invoices_by_id | Retorna uma nota fiscal específica através do ID. | id (string) |
| post_v1_invoices_by_id_retry | Utilize esta função para reenviar notas fiscais que já foram geradas. Verifique o status da nota fiscal antes de utilizar este método e evite uma exportação duplicada indesejada. | id (string) |
| post_v1_invoices | Para emitir notas fiscais você obrigatoriamente deve possuir uma integração habilitada com esta função. | No parameters |
| get_v1_invoices | Utilize este método para listar as notas fiscais associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codecustomer_id/code, codebill_id/code, codeintegration_id/code, codestatus/code, codeintegration_invoice_id/code, codeintegration_reference/code, codeissued_at/code, codecreated_at/code e code | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| delete_v1_movements_by_id | Remove um movimento financeiro pendente através de um ID. | id (string) |
| post_v1_movements | Utilize este método para criar um movimento financeiro de ajuste crédito. | No parameters |
| post_v1_messages | Este método permite enviar manualmente mensagens a partir de notificações existentes. Esteja ciente que as notificações desempenham sua função automaticamente e que este método deve ser usado apenas para reenviar mensagens que não chegaram ao destino por erros de cadastro ou recebimento. | No parameters |
| get_v1_messages | Utilize este método para listar as mensagens enviadas através da sua conta na plataforma Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codenotification_type/code, codenotification_id/code, codeseen_at/code, codecustomer_id/code, codecharge_id/code, codecreated_at/code e codedelivered_at/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_messages_by_id | Retorna uma mensagem específica através do ID. | id (string) |
| post_v1_export_batches_by_id_approve | Aprova um lote de exportação específico através do ID. | id (string) |
| get_v1_export_batches | Retorna uma lista de lotes de exportação. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| post_v1_export_batches | Cria um novo lote de exportação. | No parameters |
| get_v1_export_batches_by_id | Retorna um lote de exportação específico através do ID. | id (string) |
| post_v1_import_batches | Utilize este método para efetuar o upload de um arquivo de retorno de boleto bancário ou débito em conta. Content-Type Este é o único método da API Vindi que deve ser usado no modo multiparthttp://www.w3.org/Protocols/rfc1341/7_2_Multipart.html com o cabeçalho Content-Type: multipart/form-data. Consulte a documentação da sua biblioteca REST e não se esqueça de informar o código do método de pagamento através do parâmetro payment_method_code. Também informe o parâmetro payment_company_code | No parameters |
| get_v1_import_batches | Utilize este método para listar os lotes de importação associados à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codepayment_method_id/code, codebatch_file_size/code, codebatch_file_name/code, codebatch_fingerprint/code, codecreated_at/code e codeupdated_at/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_import_batches_by_id | Retorna um lote de importação específico através do ID. | id (string) |
| put_v1_issues_by_id | Atualiza uma pendência existente através do ID. | id (string) |
| get_v1_issues_by_id | Retorna uma pendência específica através do ID. | id (string) |
| get_v1_issues | Utilize este método para listar as pendências associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codestatus/code, codeitem_id/code, codeitem_type/code, codeissue_type/code, codecustomer_id/code, codecreated_at/code e codeupdated_at/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| delete_v1_notifications_by_id_notification_items_by_notification_item_id | Remove um item da segmentação da notificação. | id (string) notification_item_id (string) |
| post_v1_notifications_by_id_notification_items | Cria um item para segmentação da notificação. | id (string) |
| get_v1_notifications_by_id_notification_items | Lista de itens para segmentação da notificação. Recomendamos que mantenha esta lista vazia ao menos que precise necessariamente restringir o envio da notificação para um ou mais planos ou métodos de pagamento. | id (string) page (string) per_page (string) |
| delete_v1_notifications_by_id | Remove uma notificação. | id (string) |
| put_v1_notifications_by_id | Atualiza uma notificação. | id (string) |
| get_v1_notifications_by_id | Retorna uma notificação através do ID. | id (string) |
| post_v1_notifications | Cadastra uma nova notificação. | No parameters |
| get_v1_notifications | Utilize este método para listar as notificações associadas à sua conta na Vindi. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| patch_v1_merchants_by_id | No description available | id (string) |
| get_v1_merchants_by_id | Retorna uma empresa específica através do ID. | id (string) |
| get_v1_merchants_current | Retorna a empresa atual. | No parameters |
| get_v1_merchants | Retorna uma lista de empresas. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| delete_v1_merchant_users_by_id | Remove um usuário associado. | id (string) |
| put_v1_merchant_users_by_id | Atualiza um usuário associado. | id (string) |
| get_v1_merchant_users_by_id | Retorna um usuário associado através do ID. | id (string) |
| post_v1_merchant_users_by_id_reactivate | Reativa um usuário desativado por inatividade. | id (string) |
| post_v1_merchant_users | Cadastra um novo usuário associado. | No parameters |
| get_v1_merchant_users | Utilize este método para listar os Usuários de um determinado merchant. Leia a documentação sobre paginaçãohttp://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttp://atendimento.vindi.com.br/hc/pt-br/articles/204163150. Atributos para busca codeid/code, codeemail/code e codestatus/code. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_roles | Retorna uma lista de perfis de acesso. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| get_v1_users_current | Retorna o usuário atual. | No parameters |
| put_v1_affiliates_by_id_archive | Não é possível arquivar um participante com assinaturas ativas | id (string) |
| put_v1_affiliates_by_id_verify | Executa nova verificação de participante | id (string) |
| put_v1_affiliates_by_id | Não é possível inativar um participante com assinaturas ativas | id (string) |
| get_v1_affiliates_by_id | Retorna um participante do split de pagamentos específico através do ID. | id (string) |
| get_v1_affiliates | Retorna uma lista de participantes do split de pagamentos. | page (string) per_page (string) query (string) sort_by (string) sort_order (string) |
| post_v1_affiliates | Cadastra um novo participante do split de pagamento | No parameters |
| post_v1_partner_gateways | Campos obrigatórios das credenciais por adquirente: • Stone: SAK e-commerce Chave de filiação = merchant • Stone V2: username e password • Cielo V3: merchant_id, merchant_key • Bin: user, password, pem_password, cert e key • E Rede Rest: pv e password • Getnet: login, password, merchant, terminal_id • Getnet V2: client_id e client_secret • Safra Pay: ec e terminal • Pagar Me: Chave API = api_key • Adyen: username, password e merchant_account • Yapay: token_account, merchant_code e Re | No parameters |
| post_v1_partner_accounts | A API de parceiros é ideal para parcerias de contas guarda-chuva ou canaishttps://blog.vindi.com.br/programa-de-parcerias/. Com essa integração, nossos parceiros terão autonomia para criar suas próprias contas SaaS e se conectar à subadquirente da Vindi, via API. Os novos endpoints fazem parte de uma rota de serviços de autoatendimento, permitindo a criação e o credenciamento de subcontas de contas guarda-chuva por meio da API. Com isso, o processo de criação de conta na Vindi Recorrência e na V | No parameters |
| get_v1_partner_accounts | Utilize este método para listar as contas associadas ao parceiro. Leia a documentação sobre paginaçãohttps://atendimento.vindi.com.br/hc/pt-br/articles/203020644 pagination e filtros de buscahttps://atendimento.vindi.com.br/hc/pt-br/articles/204163150. | page (string) per_page (string) |
| get_v1_partner_accounts_by_id | Utilize este método para listar as contas associadas ao parceiro. | id (string) |
| post_v1_billing | O endpoint de billing permite criar produtos, clientes, perfis de pagamento e faturas avulsas em uma única chamada, simplificando o processo de cobrança. Todas as faturas seguirão as configurações de retentativa e notificações previamente configuradas na plataforma. Exemplo O exemplo abaixo efetua a criação de uma fatura avulsa usando apenas os atributos obrigatórios: 'payment_method_code': 'credit_card', 'customer': 'name': 'João Silva', 'email': 'joao@exemplo.com', | No parameters |
| post_v1_three_d_secure_sessions_validate | Validação do desafio 3DS | No parameters |
| post_v1_three_d_secure_sessions_enroll | Verifica elegibilidade e inicia autenticação | No parameters |
| post_v1_three_d_secure_sessions_setup | Inicializa sessão 3DS | No parameters |
| post_v1_public_payment_profiles | Este método permite o cadastro de perfis de pagamento através de uma API específica para chamadas Javascript no browser do seu cliente. Com esta função você reduz o escopo PCI do seu projeto pois os dados do cartão de crédito não irão trafegador em seus servidores. Os parâmetros são praticamente os mesmos do método POST /payment_profiles. Para mais informações sobre o cadastro assíncrono via Javascript, consulte este artigo. | No parameters |
| post_v1_public_wallets_apple_pay | Validação do merchant para Apple Pay | No parameters |
| post_v1_public_wallets_click_to_pay | Este endpoint recebe os dados do pagamento criptografado do Click to pay e retorna um gateway_token. | No parameters |