Vitrin Digital — Manual da Plataforma

Guia para donos de organizações que utilizam a Vitrin Digital para processar pagamentos.


1. Acessando o Painel

Acesse https://vitrin.digital/login com o email e senha cadastrados no signup.

Após o login, você será redirecionado ao Dashboard com o resumo da sua operação.


1.5. Suas chaves de API

Ao criar sua conta, você recebe 2 chaves:

ChavePrefixoQuando funcionaConecta a
Produçãovd_live_*Após aprovação pela equipe Vitrin + contratos assinadosPagamentos reais (dinheiro real)
Sandbox (teste)vd_test_*Imediatamente — mesmo antes da aprovaçãoSimulação (sem dinheiro real)

Sandbox: teste antes de operar

Enquanto aguarda a aprovação do seu cadastro, você pode usar a chave vd_test_* pra integrar e testar a API:

  • Criar clientes, gerar cobranças (Pix, boleto, cartão), configurar webhooks
  • Funciona como a produção, mas sem mover dinheiro real
  • Ideal pra validar a integração e ter tudo pronto antes de ir pro ar

O que não existe em sandbox: link de pagamento (seção 7.5) e pedido com link (seção 7). A página do link cobraria de verdade, então os dois só funcionam com a chave de produção.

Onde encontrar suas chaves

  • No momento do cadastro: ambas as chaves são exibidas na resposta. Anote a vd_live_* — ela é mostrada apenas uma vez.
  • No dashboard: acesse Configurações (/dashboard/settings/) pra consultar.
  • Rotacionar: se uma chave for comprometida, regenere em Configurações (requer PIN).

Fluxo de ativação

  1. Cadastro — você preenche dados pessoais/empresa, endereço, conta bancária de repasse e PIN. Status "Aguardando revisão". Sua chave vd_test_* já funciona.
  2. Envie documentos — aba Onboarding. RG/CNH e Contrato Social (se CNPJ).
  3. Equipe Vitrin revisa — aprova ou solicita ajustes por email.
  4. Ativação — status "Ativa". Sua chave vd_live_* é enviada por email (uma única vez). Assine os contratos comerciais em /dashboard/contract.
  5. Checklist pós-aprovação — um widget aparece no Overview com 4 passos pra você operar: conta bancária ✓ (vem do signup), webhook, primeiro plano/produto, primeira cobrança.
  6. Operação — cobre via vd_live_*.

Dica pra vibecoders: cole o conteúdo de https://vitrin.digital/llms-full.txt no seu LLM favorito (Claude, Cursor, etc.) e peça pra ele fazer a integração. Mais detalhes em https://vitrin.digital/docs/llm.

SDKs oficiais

Se o seu (ou o do seu time) backend é Node ou Python, instale o SDK oficial em vez de chamar a API com fetch/requests cru — vem com retry, erros tipados e validação de webhook prontos.

  • Node.js: npm install @vitrindigital/node (npmjs)
  • Python: pip install vitrin (pypi)

Exemplos completos no guia de integração ou nos READMEs em sdk/node/ e sdk/python/.


2. Dashboard (Overview)

A página inicial mostra:

  • MRR — Receita recorrente mensal (soma dos planos ativos)
  • Assinaturas ativas — Quantos clientes assinam planos
  • Volume do período — Total cobrado no período selecionado (7d / 30d / 90d)
  • Churn — Taxa de cancelamento de assinaturas
  • Mix de pagamento — Distribuição entre Pix, Cartão e Boleto
  • Transações recentes — Últimas cobranças com status

Banners de status

Dependendo do estado da sua conta, banners informativos aparecem no topo do dashboard:

  • Aguardando revisão (azul) — "Seu cadastro está em análise". Inclui orientação pra usar a vd_test_* pra integrar enquanto aguarda, com links pra documentação.
  • Onboarding (amarelo) — conta aprovada pela equipe Vitrin, aguardando a verificação dos documentos. Envie os documentos pela aba Onboarding.
  • Cadastro não aprovado (vermelho) — seu cadastro não foi aprovado. Contate contato@vitrin.digital.

Os banners desaparecem automaticamente quando sua conta é ativada.


3. Transações

Lista todas as cobranças da sua organização com filtros:

  • Status: Pendente, Confirmado, Recebido, Vencido, Reembolsado, Chargeback
  • Tipo: Pix, Cartão, Boleto
  • Data: De / Até

Ações disponíveis

  • Clicar na transação → Modal com detalhes completos (valores, taxas, dados Pix/boleto)
  • Reembolsar → Reembolso parcial ou total (requer PIN)
  • Cancelar → Cancela cobranças pendentes
  • Dossiê de defesa → Gera relatório completo com evidências para contestar chargebacks

4. Assinaturas

Gerencie assinaturas recorrentes vinculando clientes a planos. Esta seção é o coração da operação pra negócios baseados em mensalidade — cobrança recorrente sem fricção pro cliente, controle de inadimplência e visibilidade do MRR.

4.1. Lista, filtros e busca

Na página Recorrência → Assinaturas você vê todas as assinaturas da sua org com:

  • Cliente + ID (cópia rápida)
  • Plano
  • Valor cobrado por ciclo + badge:
    • personalizado (teal) — assinatura usa preço diferente do plano (ver 4.3)
    • do plano (cinza) — usa o preço padrão do plano
  • Tipo (Pix Auto, Cartão, Boleto, Carnê; Pix só em assinaturas antigas)
  • Status (Ativa, Inadimplente, Pendente, Aguardando aprovação, Rejeitada, Cancelada, Expirada)
  • Criado

Filtros disponíveis na toolbar acima da lista:

  • Busca — nome, email ou CPF/CNPJ do cliente (350ms de debounce)
  • Situação — filtra por status
  • Plano — só assinaturas do plano selecionado
  • Preços — Todos / Personalizados / Do plano

Combine filtros para auditar contratos B2B Enterprise, identificar inadimplência por plano específico, ou bater carteira de bolsistas.

Clique em qualquer linha para abrir o painel de detalhes (ver 4.4).

4.2. Criar uma assinatura individual

Botão "Nova assinatura" abre o formulário:

  1. Cliente — busca pelos clientes já cadastrados na sua org
  2. Plano — busca pelos planos ativos
  3. Preço personalizado (opcional) — ver seção 4.3
  4. Forma de pagamento — Pix Auto, Cartão, Boleto ou Carnê (boletos). Só aparecem os métodos liberados pela Vitrin para a sua conta e ativos em Conta → Configurações → Métodos de pagamento — lá, os não liberados aparecem esmaecidos com o selo Não liberado; para usá-los, fale com o suporte. Boleto é o boleto mensal: um boleto por ciclo. Em contas em que ele chega por e-mail, o cliente precisa ter e-mail cadastrado. Carnê emite todos os boletos de uma vez (4.9). Assinatura no Pix comum não está disponível (exceto na conta global): para Pix, use Pix Automático. Em contas onde o período de teste não está disponível no cartão ou boleto mensal, o painel avisa e, se o plano tem período de teste, só aparece o Carnê. O que muda em cada forma de pagamento está em 4.10.
  5. Token do cartão (opcional, só Cartão) — se você já tem o token tokenizado, cola aqui; senão, deixa vazio e o Link de ativação aparece após criar

Se o cliente paga com cartão sem token, o Link de ativação aparece pra você copiar ou enviar por WhatsApp ou e-mail — o cliente ativa a assinatura inserindo o cartão. Enquanto ela espera o cartão, o link também fica no detalhe da assinatura (botão "Enviar link de ativação").

4.3. Preço personalizado por contrato

Esta funcionalidade é o que permite um mesmo plano cobrar valores diferentes por contrato, sem precisar criar dezenas de planos.

Ative o toggle "Preço personalizado para este contrato" no formulário de nova assinatura. Você verá:

  • Preço padrão do plano (referência)
  • Campo valor cobrado por ciclo — substitui o preço do plano só pra esta assinatura
  • Aviso âmbar: "Para mudar o valor depois, use Alterar valor no detalhe da assinatura (não vale para carnê)" (workflow descrito em 4.5)

Quando usar:

  • B2B Enterprise — cada cliente fechou um valor diferente
  • Bolsa escolar / desconto fidelidade — mesmo plano, preço reduzido
  • Condomínio — valor por unidade (fração ideal)
  • Loja maçônica / clube — mensalidade base + FAM por idade do membro
  • Doação recorrente / dízimo — apoiador define o valor que vai dar

💡 Pra valor que muda toda cobrança (consumo medido, mensalidade + extras variáveis), use PIX Automático — explicado na seção dedicada do manual. Subscription com preço personalizado é pra valor estável (revisão raramente, ex: anual).

Exemplo: mensalidade com valor por faixa (associação, clube, loja maçônica)

O passo a passo completo, com aprovação das inscrições e importação da carteira, está no caso de uso Associação ou clube com mensalidade por faixa e aprovação (seção 20). Para uma loja em que cada cliente paga um valor diferente, veja Clube de assinatura com valor por cliente, na mesma seção.

4.4. Detalhe da assinatura

Clicar numa linha abre o painel com:

  • Valor por ciclo — destaque do valor cobrado, com discriminação:
    • Plano padrão — quanto o plano cobra de quem não tem override
    • Sobrescrito — o valor personalizado, quando há (badge teal)
  • Forma de pagamento, próxima cobrança, datas — mais ID Vitrin (com cópia rápida) e, quando a assinatura tiver, ID de referência
  • Cancelar assinatura — interrompe a recorrência
  • Alterar valor — workflow descrito em 4.5
  • Novo valor a partir de DD/MM — quando há mudança de valor agendada, com o botão Cancelar mudança (ver 4.5). Quando a mudança é a volta ao valor normal depois do cupom, em assinaturas antigas (motivo "Fim do desconto do cupom"), não há botão de cancelar (ver 6.2, Cupom em planos)
  • Enviar link de ativação — só em assinatura no cartão que espera o cliente cadastrar o cartão (ver 4.2 e 4.5)

4.5. Alterar valor de uma assinatura ativa

Use o botão "Alterar valor" no detalhe da assinatura. Vale para assinaturas Ativa, Pendente ou Inadimplente, mas não para carnê (ver 4.9). O modal pede o novo valor e um motivo opcional, que fica no histórico. Deixar o valor vazio remove o preço personalizado e volta ao valor do plano.

Cartão e Boleto (e Pix comum, em assinaturas antigas): o novo valor vale a partir da próxima cobrança. O modal mostra a data: "O novo valor vale a partir da próxima cobrança (DD/MM)". Até lá nada muda, e o cliente nunca paga duas vezes pelo mesmo período.

  • O detalhe da assinatura mostra "Novo valor a partir de DD/MM", com o valor e o motivo.
  • Mudou de ideia? Use "Cancelar mudança" no detalhe, antes da data.
  • Se o detalhe disser que nossa equipe está conferindo a mudança, a assinatura segue no valor atual até a conclusão. Não peça de novo.
  • Pedir outro valor antes da data substitui o pedido anterior.
  • Se a cobrança daquela data já tiver saído no valor antigo, o novo valor passa a valer na cobrança seguinte, e o detalhe mostra a data nova.

No dia da cobrança:

  • Boleto (e Pix comum, em assinaturas antigas): a cobrança já sai no valor novo, e o cliente não precisa fazer nada. No boleto, o boleto no valor novo chega ao e-mail dele como os anteriores.
  • Cartão: o cliente precisa cadastrar o cartão de novo para a cobrança no valor novo sair.
    1. Você recebe um e-mail com o link de ativação. O detalhe da assinatura mostra o botão "Enviar link de ativação", com Copiar, Enviar por WhatsApp e Enviar por e-mail (abre o seu programa de e-mail já preenchido com a mensagem e o link).
    2. Envie o link ao cliente. A assinatura fica Pendente e nada é cobrado até ele cadastrar o cartão.
    3. Quando ele cadastra, a cobrança no valor novo sai na hora e a assinatura volta a Ativa. As seguintes seguem o ciclo do plano a partir dessa data.

💡 No cartão, avise o cliente antes da data de que vai chegar um link para cadastrar o cartão com o valor novo. Isso evita que ele estranhe a mensagem.

Pix Automático: o valor muda na própria assinatura, na hora. A autorização que o cliente deu no app do banco continua valendo. A próxima cobrança já sai com o valor novo, e o cliente não precisa fazer nada.

Assinatura Pendente (nada cobrado ainda): o valor muda na hora. No cartão, aparece logo o link de ativação para enviar ao cliente, e nada é cobrado até ele cadastrar o cartão.

Em todos os casos o ID interno (Vitrin) da assinatura é preservado: histórico, relatórios e integrações continuam apontando para a mesma assinatura. Se aparecer um aviso de que a assinatura anterior não foi encerrada, ou se o detalhe mostrar a mudança em revisão, fale com o suporte para o cliente não ser cobrado em dobro.

Quando usar:

  • Reajuste IGPM anual de aluguel
  • Mudança de tier de cliente B2B
  • Alteração da cota FAM por mudança de idade
  • Aplicação de desconto de retenção

4.6. Importar assinaturas em massa (CSV)

Pra onboarding de uma carteira inteira (loja maçônica com 200 membros, escola com 80 alunos, condomínio com 60 unidades), use "Importar CSV" no header da página.

Passo 1. Baixe o template — colunas:

ColunaObrigatória?Descrição
cpf_cnpjsimIdentifica/cria o Customer (upsert)
namesimNome do cliente
emailsimEmail único do cliente
phonenãoTelefone do cliente
plan_slugsimSlug do plano (visível na lista de planos)
billing_typesimCREDIT_CARD (cartão) ou BOLETO (boleto mensal); na conta global, PIX no lugar de BOLETO. Fora da conta global, Pix comum não cria assinatura; para Pix Automático ou carnê, use "Nova assinatura" (4.2)
amount_overridenãoPreço personalizado (vazio = preço do plano)

Passo 2. Preencha o CSV. Limite 500 linhas por lote.

Passo 3. Volte e clique "Importar CSV" → arquivo. A pré-visualização mostra 50 linhas; confirme.

Resultado mostra:

  • ✅ Criadas — assinaturas novas
  • ➖ Já existiam — pulou porque o cliente já tem assinatura ativa pra esse plano (não duplica)
  • ❌ Erros — tabela com linha + CPF + motivo (ex: plano não encontrado, billing_type inválido)

Na importação no cartão, cada assinatura nasce esperando o cartão: o Link de ativação fica no detalhe dela (botão "Enviar link de ativação") para você enviar ao cliente. No boleto, o boleto de cada ciclo vai para o email da linha.

Plano com período de teste, em contas onde o teste não está disponível no cartão ou boleto mensal, não entra pela importação (a linha volta como erro): a assinatura desse plano só pode ser feita no carnê, em "Nova assinatura".

Cada linha é processada independente — uma falhar não derruba as outras.

4.7. Exportar assinaturas (CSV)

Botão "Exportar" baixa um CSV com a listagem atual (respeita os filtros aplicados). Colunas:

subscription_id, customer_cpf_cnpj, customer_name, customer_email, plan_slug, plan_name, plan_price, amount_override, effective_amount, billing_type, status, created_at, canceled_at, provider_subscription_id.

Util pra reconciliação contábil, importação em ERP, e auditoria externa.

4.8. Cancelar uma assinatura

Botão Cancelar no card da lista ou no detalhe abre confirmação. Após confirmar:

  • Status passa pra canceled localmente
  • A próxima cobrança recorrente não acontece
  • Histórico de transações antigas continua íntegro
  • Em assinatura em carnê, as parcelas em aberto são canceladas (ver 4.9)

4.9. Assinatura em carnê

No carnê, em vez de uma cobrança por mês, a Vitrin emite de uma vez todos os boletos do período (de 1 a 12, um por ciclo do plano) e os entrega num PDF com a marca da sua loja. Cada boleto é uma parcela com vencimento próprio. O assinante paga uma por vez, pelo app do banco, e pode pagar adiantado.

Quando oferecer carnê:

  • O assinante não tem cartão ou não quer deixá-lo salvo.
  • O assinante prefere boleto e gosta de ter todos em mãos: imprimir, agendar no banco, pagar o ano adiantado.
  • Ele esquece de pagar o boleto que chega todo mês. Com o carnê, os boletos seguintes já estão com ele.
  • O plano tem período de teste e a sua conta é uma daquelas em que o teste não está disponível no cartão ou boleto mensal: o carnê é a forma que o respeita (o 1º vencimento cai no fim do teste).

Para um boleto por mês, enviado ao e-mail do assinante, use a forma Boleto (4.10).

O carnê aparece como opção quando Boleto está habilitado em Configurações. Ele não existe para contas LLC (conta global).

Criar uma assinatura em carnê

  1. Em Recorrência → Assinaturas, clique em "Nova assinatura".
  2. Escolha o cliente e o plano e, se quiser, o preço personalizado (4.3).
  3. Em Forma de pagamento, escolha "Carnê (boletos)".
  4. Preencha:
    • Parcelas: de 1 a 12. O padrão é 12.
    • 1º vencimento: o padrão é daqui a 3 dias, ou o fim do trial, se o plano tiver trial maior que isso. As outras parcelas vencem um ciclo do plano depois da anterior, sempre no mesmo dia. Com 1º vencimento em 31/01, as próximas vencem em 28/02 e 31/03.
    • Enviar o carnê por e-mail ao assinante: vem desligado. Ligado, o assinante recebe o carnê por e-mail agora e a cada renovação.
  5. Confirme. O painel do carnê abre com o aviso "Assinatura criada em carnê. Envie o carnê ao assinante."

A assinatura fica Pendente até a 1ª parcela ser paga e então vira Ativa. Se algum boleto for recusado na emissão, nenhum fica valendo: os já emitidos são cancelados e a assinatura não é criada.

💡 Se o plano tem trial, o 1º vencimento padrão já cai no fim dele: ao escolher o plano, o campo é preenchido com essa data. O preço de trial não vale no carnê: toda parcela tem o valor da assinatura.

Trocar uma assinatura existente para carnê

Serve para o assinante que hoje paga no cartão ou no boleto mensal.

  1. Clique na assinatura para abrir o detalhe.
  2. No bloco "Passe a cobrar por boletos com vencimento futuro", clique em "Trocar para carnê". O botão só aparece em assinatura Ativa ou Inadimplente, e não aparece em Pix Automático nem em assinatura que já está em carnê.
  3. Escolha as parcelas e se quer enviar por e-mail.
  4. 1º vencimento (opcional):
    • Em branco: a 1ª parcela vence na próxima cobrança da assinatura, e o mês já pago não é cobrado de novo. A dica abaixo do campo mostra essa data, e "Usar o padrão" limpa o campo.
    • Data antes do fim do período já pago: a troca é recusada, com a data até onde o período vai.
  5. Clique em "Trocar para carnê". O painel abre com o aviso "Assinatura trocada para carnê. A cobrança anterior foi encerrada."

O que muda e o que não muda:

  • Continuam iguais: o cliente, o plano, o valor, o histórico e o id da assinatura. Só a forma de pagamento muda.
  • A cobrança anterior é encerrada. O cartão não é mais cobrado e não sai boleto mensal novo.
  • Boleto do mês já emitido: se o assinante pagar depois da troca um boleto mensal que já tinha sido emitido, o pagamento é reconhecido normalmente na assinatura.
  • Inadimplente volta a Ativa. O atraso era da cobrança anterior; a partir da troca, quem decide são as parcelas. Se uma parcela vencer sem pagamento, a assinatura fica Inadimplente de novo e a contagem de aviso e cancelamento (ver abaixo) começa ali. Nenhum aviso nem cancelamento sai antes de uma parcela vencer.
  • Se algo falhar no meio, os boletos emitidos são cancelados e a assinatura fica exatamente como estava.

Pix Automático não troca para carnê. Encerrar o débito automático encerra a assinatura inteira. Nesse caso, cancele a assinatura e crie outra em carnê.

Alterar valor (4.5) não existe em assinatura em carnê, porque as parcelas já foram emitidas com o valor. Para mudar o valor, cancele e crie outra.

O painel do carnê

Abra pelo botão "Carnê" na linha da assinatura, ou por "Abrir carnê" no detalhe. O painel mostra:

  • Resumo: plano, cliente, situação do carnê (Ativo, Concluído ou Cancelado), "12× R$ 150,00" e o 1º vencimento.
  • PDF:
    • "Abrir PDF" abre o carnê numa aba nova.
    • O Link do PDF tem o botão "Copiar", para colar onde quiser.
  • Envio:
    • "Enviar por WhatsApp" abre o WhatsApp com a mensagem pronta, já no número do cliente quando ele tem celular cadastrado: "Olá, Maria! Segue o carnê de Plano Pro (12 parcelas de R$ 150,00): <link do PDF>".
    • "Enviar por e-mail" manda o carnê ao e-mail do cliente. Depois do envio, o botão vira "Enviar de novo". O limite é de 3 envios por hora por carnê e 30 por hora na conta. Cliente sem e-mail mostra "Assinante sem e-mail cadastrado.".
    • Com o carnê concluído ou cancelado, os dois envios ficam desligados.
  • Parcelas: número, valor, vencimento e situação de cada uma (Em aberto, Vencida, Paga, Cancelada). A parcela em aberto mostra a linha digitável e o botão "Copiar linha", para mandar só aquele boleto. Quando o boleto tem Pix, aparece também "Copiar Pix" (no celular, o botão "Pix"): copia o Pix copia e cola da parcela, que o assinante cola no app do banco. Pagar pelo Pix quita a parcela do mesmo jeito.
  • Carnês anteriores: depois de uma renovação, o painel mostra o carnê atual e lista os anteriores. Ao abrir um anterior, aparece "Você está vendo um carnê anterior." e o botão "Ver o atual".

O que o assinante recebe

Nada chega com o nome da Vitrin: tudo sai com a marca da sua loja.

  • O PDF do carnê:
    • logo ou nome da sua loja, na cor do seu checkout;
    • um canhoto por parcela em aberto, com valor, vencimento, linha digitável e código de barras (lido pelo app do banco);
    • em cada canhoto, "Pague com Pix": um QR Code que o assinante lê com o app do banco para pagar a parcela por Pix, quando o boleto tem Pix;
    • as parcelas já pagas aparecem só numa linha no topo.
  • O e-mail (se você ligou o envio ou clicou em "Enviar por e-mail"):
    • assunto "Seu carnê — <sua loja>";
    • a lista das parcelas em aberto, com valor e vencimento;
    • o botão "Baixar o carnê (PDF)".
    • Na renovação, o assunto é "Seu novo carnê — <sua loja>".
  • A mensagem de WhatsApp, se você mandar pelo painel.

O PDF é gerado na hora em que o assinante abre o link, então mostra sempre a situação atual das parcelas.

Renovação, inadimplência e cancelamento

Renovação automática. Faltando 30 dias para o vencimento da última parcela, a Vitrin emite sozinha o próximo carnê, se a assinatura estiver Ativa. O carnê novo:

  • tem o mesmo número de parcelas e começa no mês seguinte à última;
  • chega por e-mail ao assinante, se o envio estiver ligado;
  • gera um e-mail para você, "Carnê renovado".

Exemplo: carnê de janeiro a dezembro de 2027 renova em 10/11/2027, com parcelas de janeiro a dezembro de 2028.

  • Inadimplente não renova: o carnê novo sai quando a assinatura voltar a Ativa.
  • Falha na renovação: a Vitrin tenta de novo todo dia. Na 3ª falha, você recebe o e-mail "Falha na renovação do carnê" para conferir a assinatura.
  • Boleto desabilitado na conta: sem Boleto habilitado, o carnê não renova. Você recebe uma vez o e-mail "Carnê não renovado: boleto desabilitado" (e o webhook CARNE_RENEWAL_BLOCKED, se integra por API). As parcelas já emitidas continuam valendo, mas a assinatura deixa de ser cobrada depois da última parcela, a menos que o Boleto seja reativado ou a assinatura passe para outro meio de pagamento. Com o Boleto reativado antes do fim do carnê, a renovação volta a acontecer sozinha.

Vencimento e inadimplência. O boleto pago no dia do vencimento pode levar alguns dias para compensar. Por isso, cada parcela tem 4 dias de carência. Exemplo com uma parcela que vence em 10/11 e não é paga:

DataO que acontece
10/11A parcela vence
11/11 a 14/11Carência: nada muda
15/11 (5º dia)A parcela fica Vencida e a assinatura Inadimplente
22/11 (7 dias inadimplente)Aviso de inadimplência na sua integração (webhook)
15/12 (30 dias inadimplente)A assinatura é cancelada e as parcelas em aberto também

O boleto continua pagável depois do vencimento, com multa de 2% e juros de 0,4% sobre o valor, impressos no boleto no campo "(+) Juros / Multa". Se o assinante pagar, a parcela vira Paga e a assinatura volta a Ativa, desde que não haja outra parcela vencida.

Boleto cancelado fora da Vitrin. Se uma parcela for cancelada ou baixada fora do painel da Vitrin, ela aparece como Cancelada no painel. Como não foi paga e não pode mais ser, ela conta como vencida depois dos mesmos 4 dias de carência: a assinatura fica Inadimplente e segue a tabela acima. Para regularizar, cancele a assinatura e crie outra.

Pagamento ou baixa confirmados depois. Às vezes o pagamento ou a baixa de um boleto vencido (avulso ou parcela) só é confirmado alguns dias depois. A Vitrin confere esses boletos todo dia: o pago vira Pago, com a data real do pagamento, e o baixado vira Cancelado. Nesse caso, sua integração recebe o aviso de sempre no momento da conferência, e não na hora do pagamento ou da baixa.

Uma parcela não se cancela sozinha pela tela de transações: para cancelar parcelas, cancele a assinatura (4.8).

Cancelamento. Ao cancelar a assinatura (4.8), ou quando ela é cancelada por inadimplência:

  • as parcelas em aberto são canceladas no banco e não podem mais ser pagas;
  • as já pagas continuam pagas;
  • o link do PDF deixa de funcionar.

Perguntas comuns

O assinante pode pagar adiantado? Pode. A parcela paga antes do vencimento vale normalmente: a assinatura fica Ativa e o período pago avança até o fim do mês daquela parcela. Pagar fora de ordem também funciona: se ele pagar a 3ª antes da 2ª, a 2ª continua em aberto e vence na data dela.

Uma parcela paga sumiu do PDF. É erro? Não. O PDF só traz canhoto de parcela em aberto: um canhoto de parcela quitada, com código de barras, convida a pagar de novo. As parcelas pagas aparecem numa linha no topo do PDF e, no painel, com a situação Paga.

O assinante perdeu o boleto. Como mando a 2ª via? O carnê não tem "2ª via" separada: o mesmo link do PDF sempre traz os boletos em aberto atualizados. Você pode:

  • mandar o link de novo por "Enviar por WhatsApp", "Enviar por e-mail" ou "Copiar";
  • copiar a linha digitável de uma parcela só, com "Copiar linha", ou o Pix dela, com "Copiar Pix".

Parcela vencida continua no PDF (marcada "Vencida") e pode ser paga com multa e juros.

Quanto custa? Cada parcela é um boleto. A taxa é a de boleto da sua conta, cobrada em cada parcela paga, sem taxa extra pelo carnê. Com o repasse da taxa ligado para Boleto (13, Repassar taxa ao cliente), cada parcela já sai com a taxa embutida.

4.10. Como funciona em cada forma de pagamento

A assinatura se comporta de um jeito diferente em cada forma de pagamento. Use a tabela para escolher o meio e para explicar ao cliente o que vai acontecer.

CartãoBoletoPix AutomáticoCarnê
Requisito do cliente—Em contas em que o boleto mensal chega por e-mail: e-mail cadastrado é exigido — sem ele, a criação ou a aprovação da assinatura é recusada——
1ª cobrançaNo checkout, sai na hora no cartão digitado. Criada pelo painel sem token, sai quando o cliente cadastra o cartão pelo Link de ativação (4.2)O 1º boleto é gerado quando a assinatura é criadaVem junto com o QR Code de autorização: o cliente escaneia uma vez no app do banco e paga a 1ª1ª parcela do carnê, que já sai com todas as outras (4.9)
Cobranças seguintesSaem sozinhas no cartão, na data de cada cicloUm boleto novo a cada cicloDebitadas sozinhas na data, sem o cliente abrir o appJá estão com o cliente: são as outras parcelas do carnê
Alterar valor (4.5)Vale a partir da próxima cobrança. Na data, você recebe por e-mail o link de ativação e envia ao cliente, que cadastra o cartão de novoVale a partir da próxima cobrança. O cliente não faz nada: o boleto seguinte já chega no valor novoVale na hora, na própria assinatura; a autorização continua valendoNão existe: cancele e crie outra assinatura
Cupom (6.2)Com Pix Automático na conta, não vale: o checkout avisa e cobra o valor normal; sem Pix Automático, o campo do cupom não aparece no link do planoCom Pix Automático na conta, não vale: o checkout avisa e cobra o valor normal; sem Pix Automático, o campo do cupom não aparece no link do planoSó na 1ª cobrança. As seguintes já saem no valor normalNão se aplica: o carnê é criado pelo painel, sem cupom
Período de teste (5)Em contas onde o teste não é respeitado no cartão: a 1ª cobrança sai logo depois que o cliente cadastra o cartão, e o plano com teste não aceita cartão nessas contasEm contas onde o teste não é respeitado no boleto mensal: o 1º boleto sai na criação, e o plano com teste não aceita boleto nessas contasEm contas onde o teste não é respeitado no Pix Automático: a 1ª cobrança vem com a autorização, e o plano com teste não aceita Pix Automático nessas contasVale: o 1º vencimento padrão cai no fim do teste. É a forma que sempre respeita, em qualquer conta que tenha carnê

Boleto ou carnê? Os dois servem a quem prefere boleto:

  • Boleto: um boleto por ciclo, enviado ao e-mail do cliente. Confira que o cadastro dele tem e-mail. Cada cobrança também aparece em Visão geral → Transações.
  • Carnê: todos os boletos de uma vez, num PDF com a marca da sua loja, que você envia pelo painel (WhatsApp ou e-mail). O valor não muda depois de emitido.

Pix comum. Fora da conta global, assinatura no Pix comum não está disponível: ela exigiria que o cliente pagasse um Pix novo a cada ciclo. Para Pix recorrente, use o Pix Automático: o cliente autoriza uma vez e cada cobrança é debitada sozinha. O link do plano não oferece Pix comum, e a criação pelo painel, pela API ou pela importação (fora da conta global) responde com essa orientação.

Mudança de valor agendada. No Cartão e no Boleto, o detalhe da assinatura mostra "Novo valor a partir de DD/MM" até a data. Para desistir, use "Cancelar mudança" antes dela.

Pix Automático: o que o cliente precisa ter

O cadastro do cliente precisa ter CPF/CNPJ, nome e endereço completo (CEP, endereço, número, cidade e UF). Sem eles, a assinatura não é criada. O Pix Automático também precisa estar liberado para a sua conta (4.2, item 4).

4.11. Aprovação manual de inscrições

Quando o plano tem "Exige aprovação manual" ligado (seção 5), quem assina pelo checkout público não é cobrado na hora. O checkout mostra "Solicitação enviada", e a assinatura aparece em Recorrência → Assinaturas como Aguardando aprovação (use o filtro Situação para achar as pendentes). A Vitrin não avisa o cliente: combine com ele o próximo passo.

  • Aprovar: a cobrança começa como numa assinatura nova daquela forma de pagamento (4.10):
    • Cartão: aparece o Link de ativação para você enviar ao cliente;
    • Pix Automático: aparece o QR Code de autorização para você enviar. Se o Pix Automático deixou de estar liberado para a sua conta, a aprovação é recusada e a inscrição continua aguardando;
    • Boleto: o 1º boleto é gerado e enviado ao e-mail do cliente;
    • Pix comum (inscrição antiga): a aprovação é recusada, porque o Pix comum não cria assinatura, e a inscrição continua aguardando. Rejeite e crie a assinatura em "Nova assinatura" com outra forma, combinando com o cliente;
    • Plano que ganhou período de teste depois da inscrição, em conta onde o teste não está disponível nessa forma de pagamento: a aprovação é recusada da mesma maneira.
  • Rejeitar: a inscrição vira Rejeitada e nada é cobrado. O motivo é opcional e fica só no histórico.

Se o cliente usou cupom (só no Pix Automático), o desconto é aplicado quando você aprova.


5. Planos

Defina os planos que seus clientes podem assinar.

Campos básicos

  • Nome, preço, ciclo — semanal, quinzenal, mensal, bimestral, trimestral, semestral, anual
  • Descrição — texto curto exibido no checkout
  • Ativo/Inativo — desative sem excluir
  • Features — tags descritivas do que o plano inclui
  • Capa — URL de imagem exibida na página pública do checkout

Trial e cobranças avançadas

Acessível pelo bloco "Trial e cobranças avançadas" ao criar/editar:

CampoFunção
Dias de testePeríodo de teste gratuito (ex.: 7). 0 desativa. Em contas onde o período de teste não está disponível no cartão ou boleto mensal, o painel avisa e a assinatura com teste é feita no carnê, pelo painel ou pela API, com o 1º boleto no fim do teste (4.9 e 4.10). Nessas contas, o link do plano com teste mostra ao cliente que a assinatura não está disponível por ali e que ele deve falar com a loja.
Máximo de ciclosCancela a assinatura após N cobranças. 0 = renovação indeterminada.
Link de entregaPara onde o cliente vai depois de pagar (ver "Link de entrega" na seção 6).
Pagador define o valorO checkout público pede ao cliente o valor da mensalidade, que vira o preço personalizado da assinatura dele (4.3). Configure Mínimo aceito e Máximo aceito (opcionais). Para sugerir um valor, acrescente ?suggested= ao link do plano. Útil para dízimo, doação recorrente e mensalidade por faixa.
Exige aprovação manualInscrições feitas pelo checkout público ficam Aguardando aprovação e só começam a cobrar quando você aprova (4.11). Útil para clube, escola ou associação em que nem todo cadastro vira membro.
Adesão e trial pagoNão são suportados: o plano só aceita trial gratuito e não tem taxa de adesão. Planos antigos que tinham esses valores preenchidos seguem cobrando só a mensalidade, e o checkout não os exibe.
URL da capaImagem 1200×600 recomendada para o checkout público.

Compartilhar checkout

Cada plano gera um link público. No card do plano clique em "Copiar link" — formato https://vitrin.digital/c/<sua-org>/<slug-do-plano>. Compartilhe esse link e o cliente assina sem precisar de conta.


6. Produtos

Para vendas avulsas (não recorrentes), com 5 tipos:

TipoQuando usar
Pagamento únicoCurso, ebook, evento — um valor fixo
PacoteN unidades por um preço (ex.: 5 eventos por R$ 1.297)
CréditosSaldo consumível (créditos para uma plataforma sua)
ContribuiçãoDoação, gorjeta, "pague quanto quiser" — pagador define o valor
ComboBundle de outros produtos com preço promocional

Modo de preço

Independente do tipo (exceto Contribuição, que sempre usa "pagador escolhe"):

  • Preço fixo — você define, o cliente paga exatamente isso.
  • Pagador escolhe o valor — cliente digita no checkout. Use para apoio voluntário em qualquer tipo. Configure valor mínimo (piso aceito) e valor máximo (teto opcional). O preço informado vira sugestão pré-preenchida.

Exemplo: produto "Apoie meu canal" tipo Pagamento único + modo Pagador escolhe + mínimo R$ 5 + sugestão R$ 25.

Campo no corpo do formulário do produto. É onde o comprador acessa o que pagou: área de membros, download, grupo. Ele aparece em dois lugares:

  • Botão no comprovante de pagamento que enviamos ao pagador.
  • Redirecionamento na página de checkout assim que o pagamento é aprovado.

Planos têm o mesmo campo, em Catálogo → Planos — use para mandar cada plano à sua própria área.

Se ficar vazio, o item cai no Link de entrega padrão da org (Crescimento → Checkout público). Sem nenhum dos dois, o comprovante sai sem botão.

Vale preencher mesmo que você já provisione por webhook. O redirecionamento do checkout só acontece com a aba aberta — quem paga por Pix ou boleto costuma fechar e voltar horas depois, e aí o comprovante é o único caminho que resta até a compra.

A entrega em si é sua: a Vitrin aponta o caminho, não hospeda o arquivo nem controla o acesso.

Aparência da página de venda

Bloco expansível com campos pra rica conversão:

CampoFunção
Descrição longaTexto rico exibido na página pública (markdown suportado)
URL da capaBanner do produto
URL do vídeoYouTube/Vimeo embed exibido inline
Permitir parcelamentoDesative pra forçar à vista mesmo em cartão
Máximo de parcelasLimite por produto. O cliente vê no máximo o teto da sua conta (até 12x, seção 13): o menor entre os dois vale

Compartilhar checkout

Botão "Copiar link" no card do produto — https://vitrin.digital/c/<sua-org>/<slug-do-produto>. Compartilhe na bio, em campanhas de email, em anúncios.


6.0.1. Combo (bundle de produtos)

Combine vários produtos seus em uma única venda com preço promocional.

Como funciona:

  1. Crie os produtos individuais primeiro (Pagamento único, Pacote, etc.).
  2. Crie um novo produto tipo Combo, definindo o preço total do combo (geralmente menor que a soma individual).
  3. Salve, depois adicione os produtos incluídos no combo (com quantidade por item).
  4. Compartilhe o link do combo. O pagador vê a lista de produtos incluídos com a economia em destaque ("De R$ X por R$ Y").
  5. Após o pagamento, um Order parent registra a receita + N child Orders (unit_price=0, marcados via metadata.bundle_parent_id) para você provisionar entrega individual de cada item via webhook.

Bundle não suporta valor aberto — o preço promocional é fixo e definido pela org.

Aninhamento não permitido — um combo não pode incluir outro combo.


6.1. Order Bumps

Ofertas adicionais que aparecem no checkout do produto principal.

Catálogo → Order Bumps → Novo bump:

CampoFunção
Aparece no checkout deProduto principal cujo checkout exibirá a oferta
Oferta produto adicionalItem complementar que será oferecido
Título da ofertaEx.: "Adicione o ebook complementar"
DescriçãoTexto curto explicando o benefício
Desconto sobre preço original (%)% aplicado em cima do preço do produto adicional

No checkout, o cliente vê uma checkbox com a oferta. Múltiplos bumps podem ser aceitos no mesmo checkout — cada um entra no total. Quando o pagamento é confirmado, o Order parent registra a receita total e cada bump aceito gera um child Order separado (marcado via metadata.parent_order_id), permitindo provisionamento independente via webhook.

Exemplo: cliente comprando "Curso Pro (R$ 297)" recebe a oferta "Adicione o e-book de bônus por R$ 19 (de R$ 47)". Aceitando, paga R$ 316 em uma transação só.


6.2. Cupons

Códigos de desconto aplicáveis no checkout público.

Catálogo → Cupons → Novo cupom:

CampoFunção
CódigoToken digitado pelo cliente (ex.: BLACKFRIDAY). Único por organização, case-insensitive.
TipoPercentual (10%) ou Valor fixo (R$ 50)
Valor do descontoConforme o tipo
ValidadeData limite. Vazio = sem prazo
Limite de usosQuantos clientes podem usar. 0 = ilimitado
Compra mínimaValor mínimo da venda para o cupom valer
Vale paraPlanos e produtos em que o cupom vale. Nenhum marcado = todos os planos e produtos

O contador de usos é atualizado automaticamente a cada uso bem-sucedido. Uma cobrança que falha não gasta o cupom.

Cupom em planos (assinaturas)

Em planos, o desconto vale só na 1ª cobrança da assinatura; as seguintes saem pelo valor normal — o preço do plano ou o valor que o cliente escolheu, no plano de valor livre. O formulário do cupom mostra esse aviso sempre que o cupom pode valer para algum plano.

  • Meio de pagamento: nas assinaturas, o cupom é aceito só no Pix Automático (se estiver ativo na sua conta), não no cartão nem no boleto. Se o cliente escolher cartão, o checkout avisa "Nesta assinatura, o cupom não vale no cartão."; no boleto, "Nesta assinatura, o cupom não vale nesta forma de pagamento." Nos dois casos, cobra o valor normal. Sem Pix Automático na conta, o campo do cupom não aparece no link do plano. O carnê é criado pelo painel, sem cupom.
  • Pix Automático: só a 1ª cobrança sai com desconto, e as seguintes já saem pelo valor normal, sem nada agendado.
  • O que o cliente vê: junto do preço, o checkout mostra "Cupom aplicado: R$ 10,00 de desconto na 1ª cobrança; as seguintes saem por R$ 100,00." O total da 1ª cobrança já vem com o desconto. Os e-mails e recibos não falam do cupom.
  • Um uso por assinatura: o cupom conta um uso quando a assinatura é criada, e não se repete nas renovações.
  • Plano com aprovação manual: o cupom fica guardado na inscrição e o desconto é aplicado quando você aprova.
  • Não vale: em plano com período de teste grátis, e quando o desconto zeraria a 1ª cobrança (ex.: 100%).

Exemplo: plano de R$ 100,00/mês com o cupom BEMVINDO (10%). A 1ª cobrança sai por R$ 90,00; a partir da 2ª, R$ 100,00.


6.3. Programa de Afiliados

Transforme clientes, parceiros e creators em uma rede que vende para você em troca de comissão por venda atribuída. O afiliado se cadastra na Vitrin, pede para promover seu produto, recebe um link único e ganha comissão automática a cada venda que vier desse link.

Acesse em Crescimento → Afiliados.

6.3.1. Ligar o programa

Na página Crescimento → Afiliados (título "Programa de Afiliação"), ligue a chave "Programa ativo" e ajuste:

CampoFunção
Janela de atribuiçãoQuanto tempo (7 a 90 dias) o clique do afiliado conta pra uma venda. Padrão 30 dias. Modelo "last-click": se o cliente clicar em mais de um afiliado, vale o último.
Comissão padrão — primeira venda (%)% aplicada quando o produto/plano não define comissão própria.
Comissão recorrente padrão (%)Pra planos. Em branco, usa a comissão da primeira venda.
Exigir aprovação manualQuando ligado, cada pedido de afiliação fica pending até você aprovar. Recomendado para programas curados.
Listar publicamente no marketplace VitrinQuando ligado, seus produtos aparecem para qualquer afiliado descobrir no marketplace público da Vitrin. Quando desligado, só convidados acessam.

A taxa Vitrin que sua loja paga não muda quando você liga o programa. A comissão do afiliado sai do líquido da sua venda.

6.3.2. Configurar por produto / plano

A comissão pode ser diferente para cada item. Em Crescimento → Afiliados → Configurar por produto, clique em Configurar ao lado do item:

CampoFunção
Afiliação habilitadaLiga ou desliga o item no marketplace.
Comissão% sobre o preço do produto. Em planos, há dois campos: primeira venda + renovação.
Cap de renovações com comissão(Planos) Limita por quantas renovações o afiliado continua ganhando. Em branco = vitalícia enquanto a assinatura existir.
Auto-aprovar afiliadosPedidos pra este item específico viram aprovados sem moderação — útil pra produtos de baixo risco.
Limite de afiliadosQuantos afiliados podem promover este item ao mesmo tempo.

Cartão parcelado: a comissão é calculada sobre o preço do produto, não sobre o que o cliente paga a mais no parcelamento. Juros e o seu adicional de parcelamento (seção 13) nunca entram na base da comissão.

6.3.3. Aprovar afiliados

Em Crescimento → Afiliados → Pedidos de afiliação você vê todos os pedidos por status:

  • Aguardando: você aprova, rejeita ou ajusta a comissão personalizada.
  • Aprovado: o afiliado já consegue criar links no painel dele.
  • Rejeitado: o afiliado vê o motivo (se preenchido).
  • Revogado: você cortou um afiliado que tinha sido aprovado. Comissões já liquidadas não voltam — mas novas vendas dele não geram mais comissão.

Na hora de aprovar, dá pra sobrescrever a comissão só pra este afiliado (parceiros estratégicos, influencers maiores etc) sem mexer no padrão do produto.

6.3.4. Relatório

Em Crescimento → Afiliados → Relatório de comissões você acompanha:

  • Liquidada: comissão que já caiu na carteira dos afiliados.
  • Pendente: comissão registrada mas ainda não liquidada (cobrança em processamento).
  • Estornada: comissões revertidas por chargeback ou refund.
  • Por produto/plano: ranking dos itens que mais geram comissão.
  • Comissões recentes: lista das últimas 200, com loja, item, valor de venda, % aplicada, valor de comissão e status.

6.3.5. Estornos e chargebacks

Se uma venda com comissão for estornada (refund manual ou chargeback do cliente), a Vitrin reverte a comissão proporcionalmente:

  • Refund total → 100% da comissão revertida.
  • Refund parcial (ex: 50%) → 50% da comissão revertida.

Se o afiliado já tinha sacado, o saldo dele fica negativo e é compensado no próximo repasse automático. Você nunca precisa cobrar do afiliado — a Vitrin opera essa conciliação.

6.3.6. Webhook

Toda cobrança atribuída a um afiliado traz um bloco affiliate no webhook que sua loja recebe (configurado em Conta → Configurações → Webhook). O bloco carrega o slug do afiliado, o valor da comissão e o status atual (pending / settled / reversed).

Use isso para:

  • Acionar régua de relacionamento com afiliados que vendem (e-mail de parabéns, ranking interno).
  • Reconciliar receita do programa de afiliação contra seu BI.
  • Notificar afiliados em canais externos (Telegram, Discord).

O formato exato e a lista de campos está no Guia de Integração.

6.3.7. Coprodutores

Coprodutor é diferente de afiliado: é parceiro fixo de um produto específico (ex: editora que dividiu o lançamento, instrutor que co-criou o curso). Não tem janela de atribuição — a divisão sempre vale, em toda venda do produto.

Coprodutores são cadastrados pela Vitrin (entre em contato com o suporte para incluir). Quando cadastrados, você associa cada um a um produto pelo painel ou via API, definindo se a divisão é por percentual (ex: 20% sobre cada venda) ou valor fixo (ex: R$ 5,00 por venda).

Coprodutor é fora do escopo de auto-serviço nessa primeira versão — abra um chamado para configurar.


7. Pedidos

Cada venda de produto gera um pedido. O caminho normal é:

Pendente → Pago → Entregue

Outros status: Reembolsado, Cancelado e Expirado. Filtre a lista por status e por data no topo da tela.

  • O pedido vira Pago sozinho quando o pagamento é confirmado.
  • Use Entregar (no celular, Marcar como entregue) depois de entregar o produto.

Em Vendas → Pedidos, clique em Novo pedido e preencha:

  • Cliente e Produto (obrigatórios);
  • Qtd;
  • Validade do link (opcional);
  • Meios aceitos: nenhum marcado = o cliente escolhe entre todos os métodos habilitados da conta. Pix Automático não entra.

Clique em Criar pedido e link. O pedido nasce Pendente e abre a tela do Link de pagamento, com Copiar, Enviar por WhatsApp e Enviar por e-mail (este só com cliente que tem e-mail). O cliente escolhe como pagar (inclusive cartão parcelado, dentro do teto do produto e da conta), e o pedido vira Pago quando ele paga. Pedido com link não existe em sandbox (seção 1.5).

Na lista, o pedido com link mostra o selo do link e os botões:

  • Link de pagamento: abre o link de novo para copiar ou reenviar;
  • Gerar novo link: aparece quando o link venceu ou foi cancelado. Cria um link novo com os mesmos dados. Se o cliente ainda pagar um Pix ou boleto do link antigo, o pedido é quitado do mesmo jeito;
  • Cancelar pedido: só para pedido Pendente. O link aberto é cancelado junto e deixa de aceitar pagamento.

Um pedido com link vencido continua Pendente até você gerar um link novo ou cancelar o pedido.


Vendas → Links de pagamento — cobre um valor específico sem precisar cadastrar produto: você cria o link e o envia ao cliente.

Não aparece no menu para organizações LLC (conta global) — o link de pagamento avulso não está disponível para esse tipo de conta.

Clique em Novo link e preencha:

  • Valor e Descrição (obrigatórios)
  • Validade — padrão 7 dias, até 90
  • Cliente (opcional) — com cliente escolhido, quem abre o link só confirma o pagamento; sem cliente, o link pede nome/CPF e demais dados como o checkout público, e cadastra o cliente ao pagar
  • Meios de pagamento — nenhum marcado = todos os métodos habilitados na sua conta (Pix Automático nunca entra: cobrança avulsa não é recorrência)
  • Parcelas máximas (cartão) — em branco usa o teto da sua conta
  • URL de retorno (opcional) — em branco, o cliente vê a página de obrigado padrão da Vitrin com sua marca ao concluir o pagamento

Ao criar, e depois pelo botão Enviar de cada link Aberto, abre a tela do link com:

  • Copiar, para colar onde quiser;
  • Enviar por WhatsApp, com a mensagem pronta;
  • Enviar por e-mail: a Vitrin manda ao cliente um e-mail com a marca da sua loja, a descrição, o valor, a validade e o botão para pagar. Só funciona com cliente escolhido no link e com e-mail cadastrado. O limite é de 3 envios por hora por link e 30 por hora na conta.

Uso único

Cada link vale para um pagamento. Depois de pago, ele para de aceitar novos pagamentos — reenviar o mesmo link não gera cobrança dupla. Enquanto o link está Aberto, um Pix ou boleto já gerado continua sendo mostrado para quem reabre a página (não gera um segundo QR/boleto); um cartão recusado pode ser tentado de novo, mas depois de várias recusas seguidas o link passa a aceitar só Pix ou boleto (proteção contra teste de cartões roubados). Se o cliente precisar pagar com cartão, crie um link novo.

  • Link sem cliente: o Pix/boleto já gerado pertence a quem gerou primeiro — outra pessoa que abrir o mesmo link recebe o mesmo QR/boleto. Para cobrar pessoas diferentes, crie um link para cada uma.
  • Pago é definitivo: se o pagamento do link for estornado ou contestado (chargeback) depois, o link continua Pago. Para cobrar de novo, crie um link novo.
  • Chave de teste (sandbox): link de pagamento não existe em sandbox — só com a chave de produção.

Status

StatusSignificado
AbertoAceita pagamento
PagoJá foi pago — vinculado à transação (Ver transação)
CanceladoVocê cancelou antes de ser pago
ExpiradoPassou da validade sem ser pago

Filtre a lista por status no topo da tela. Um link Aberto pode ser cancelado a qualquer momento (Cancelar — deixa de aceitar pagamento); Pago ou já Cancelado não pode ser cancelado de novo.

Em casos raros (ex.: cliente paga o Pix e o boleto do mesmo link por engano), o segundo pagamento é registrado normalmente — não é perdido — e a equipe Vitrin é alertada para orientar o estorno.


8. Clientes

Cadastro dos pagadores com:

Identidade

  • Nome completo (obrigatório)
  • CPF/CNPJ (obrigatório) — quando CNPJ, o campo "Razão social" aparece automaticamente no lugar de "Data de nascimento"
  • Email
  • Telefone
  • Data de nascimento (PF) ou Razão social (PJ)

Endereço com auto-preenchimento por CEP

Ao digitar o CEP e sair do campo, a Vitrin consulta o ViaCEP e preenche automaticamente: endereço, bairro, cidade, UF (e complemento, quando o CEP retorna). Você ajusta número, complemento e qualquer detalhe que faltar.

Campos disponíveis: CEP, Endereço, Número, Complemento, Bairro, Cidade, UF.

Observações internas

Campo livre não exibido ao cliente — use para registrar histórico, preferências, etc.

Custom data

Quando você usa campos customizados no checkout público (seção 14), as respostas do cliente ficam guardadas em Customer.custom_data (JSON, acessível via API).

Sincronizado automaticamente.

Cartão salvo & One-click buy

Cada cliente pode ter um cartão preferido salvo com segurança (tokenizado) para cobranças one-click (recompra, planos avulsos, upgrade de produto sem reabrir o checkout). Salvar um novo cartão substitui o anterior.

Quando ativar

  • Recompra — produtos consumíveis, refis, planos de uso esporádico
  • Recorrência fora de assinatura — você cobra valores diferentes a cada vez (consultoria, atendimento, mensalidade variável)
  • Checkout 1-clique pelo seu próprio site — cliente logado clica "Comprar" e a cobrança sobe sem reabrir formulário de cartão

Para recorrência fixa (valor + cadência iguais todo mês), prefira Assinaturas (seção 4) — elas já cuidam do agendamento.

Como o cliente salva o cartão

No checkout hospedado, aparece automaticamente um checkbox "Salvar este cartão para próximas compras" abaixo do CVV. O cliente marca, paga, e o cartão fica guardado. Quando ele voltar (match por email + CPF), o checkout mostra "Pagar com Visa ••••1234 — 1 clique" no topo.

Se o seu fluxo de checkout for próprio (não usa o hospedado), salve via API — veja docs/INTEGRACAO.md §3.7. O consent.accepted_at e consent.ip são obrigatórios.

Pra cobrar o cliente sem cobrar pela API, gere um link de recompra: em Vendas → Clientes → [cliente] → Cartão salvo (one-click), clique em "Link de recompra 1-clique", escolha produto ou plano, valor opcional (deixa em branco pra usar o preço cadastrado) e número de parcelas.

A Vitrin emite uma URL assinada de 15 minutos, uso único:

https://vitrin.digital/c/loja/produto-x/oneclick?t=eyJhbGciOi...

Mande por email/WhatsApp. O cliente abre, vê o cartão salvo + valor, clica "Pagar — 1 clique" e a cobrança roda sozinha (cria pedido, calcula taxa, dispara webhook, redireciona pro Link de entrega configurado no produto).

Diferenças pra outras formas de cobrar:

Pra quêTTLQuem cobra
Link de gestão (24h)Cliente ver/remover o próprio cartão24h— (visualização)
Link de recompra (15min)Cliente clicar e pagar item específico15min, uso únicoCliente
POST /charges/charge-saved/Você cobra pela API direto (sem interação)—Loja

Quando usar cada um:

  • Recompra agendada com confirmação (refil de assinatura, upgrade de plano) → link de recompra
  • Cobrança totalmente automática sem clique do cliente (subscription renewal, upgrade pago invisível) → charge-saved
  • Cliente perdido / precisa atualizar cartão → link de gestão

No painel, em Vendas → Clientes → [cliente] → Cartão salvo (one-click), clique em "Link de gestão (24h)". A Vitrin emite uma URL com token assinado de 24h:

https://vitrin.digital/customer/cards/eyJhbGciOi...

Envie esse link por email (assinatura de plano, confirmação de compra) ou exiba na sua página de minha-conta. Nessa URL o cliente vê bandeira + últimos 4 e pode remover o próprio cartão sem precisar falar com o suporte.

Cobrança one-click pela API

POST /api/v1/charges/charge-saved/
{ "customer_id": "...", "amount": 99.90 }

Retorna uma Transaction como se você tivesse cobrado pelo /checkout/pay/. Sem digitar cartão, sem CVV, sem formulário.

CVV não é solicitado em cobrança com cartão salvo. Isso é parte do one-click. Para valores altos ou clientes sensíveis a fraude, prefira /checkout/pay/ com cartão fresco + 3DS.

Quando o cartão é removido

  • Cliente final clica em "Remover" no link de gestão
  • Você chama DELETE /api/v1/customers/{id}/saved-card/

Cartão expirado não é removido automaticamente — você recebe 422 card_expired na próxima tentativa de cobrança e deve pedir ao cliente para registrar um novo.

Texto sugerido para sua política de privacidade

Cole o trecho abaixo na sua política (ajustando o nome da loja):

Cartões salvos. Quando você opta por salvar seu cartão para próximas compras, armazenamos com segurança uma referência (token) ao seu cartão — nunca o número completo. Esse token é exclusivo da {NOME DA LOJA} e não pode ser usado por nenhuma outra empresa. Você pode revogar esse consentimento a qualquer momento removendo o cartão na sua página de cliente ou solicitando à {NOME DA LOJA}. Registramos a data, hora e endereço IP do seu aceite para fins de prestação de contas (Art. 8º, §1º LGPD).


9. Antecipação

Receba antes do prazo padrão os recebíveis de cartão.

  • Simular — A tela mostra, por data de recebimento, o valor bruto, o desconto e o líquido, além do disponível para antecipação
  • Selecionar — Marque as datas que quer antecipar; o total selecionado não pode passar do disponível
  • Solicitar — Requer PIN de segurança

Uma solicitação por vez. Depois de solicitar, uma nova antecipação só fica disponível após o crédito da anterior — a tela mostra "Antecipação em processamento" com a data prevista do crédito. Por isso, selecione todos os dias que deseja antecipar numa única solicitação. Se a antecipação anterior não for aprovada, uma nova solicitação é liberada automaticamente.

Horário. A solicitação é aceita em horário comercial, em dias úteis. Fora dele, a tela avisa, e a simulação continua funcionando. A data prevista do crédito aparece na tela ao solicitar.

Efetivação parcial. Às vezes parte dos lançamentos fica indisponível no momento da antecipação. A tela avisa quais dias ficaram de fora e até que horas você pode complementar, uma vez, com esses dias.

Limite. Quanto você pode antecipar depende das condições da sua conta. A tela mostra o disponível para antecipação, já com o limite aplicado e descontado o que você já antecipou. A antecipação é sempre sujeita a análise e aprovação.

A antecipação pode ser desabilitada pelo administrador da plataforma.


10. Pix Automático

Cobre seus clientes de forma recorrente via Pix, sem precisar de cartão. O cliente autoriza uma única vez via QR Code no app bancário e a partir daí você gera as cobranças mensais (ou na frequência escolhida) sem nova interação dele.

Disponibilidade: o Pix Automático precisa estar habilitado pelo administrador da plataforma e ativado por você em Conta → Configurações → Métodos de pagamento. Sua conta de pagamentos também precisa estar com a aprovação geral concluída.

Como funciona

  1. Você cria uma autorização informando cliente, frequência (semanal, mensal, trimestral, semestral ou anual) e o valor da primeira cobrança.
  2. A Vitrin gera um QR Code de aceite que você compartilha com o cliente.
  3. O cliente escaneia no app bancário e autoriza a primeira cobrança + as recorrências.
  4. A autorização passa de Aguardando aceite para Ativa.
  5. Você gera cada cobrança recorrente em Nova cobrança dentro da autorização. Cada cobrança precisa respeitar o prazo do Banco Central: vencimento entre 2 e 10 dias úteis no futuro.
  6. O cliente é debitado automaticamente na data combinada — sem precisar abrir o app.

Criando uma autorização

Recorrência → Pix Automático → Nova autorização

CampoObrigatórioObservação
ClienteSimCliente já cadastrado
Identificador externoSimSeu código de contrato (até 35 caracteres)
FrequênciaSimSemanal / Mensal / Trimestral / Semestral / Anual
InícioSimQuando começa a vigência
TérminoNãoVazio = prazo indeterminado
Valor fixoNãoTrava o valor para todas as cobranças. Vazio = valor variável
DescriçãoNãoAté 35 caracteres
Valor da primeira cobrançaSimCobrança vinculada ao QR Code de aceite

Após criar, a Vitrin mostra o QR Code e o copia-e-cola para você compartilhar com o cliente.

Status da autorização

StatusSignificado
🟡 Aguardando aceiteCliente ainda não escaneou o QR Code
🟢 AtivaCliente aceitou — você pode gerar cobranças
⚪ CanceladaCancelada por você ou pelo cliente
🔴 RecusadaO banco do cliente recusou
⚪ ExpiradaCliente não escaneou no prazo

Gerando cobranças recorrentes

Para autorizações Ativas, clique no ícone + e informe:

  • Valor (bloqueado se a autorização tem valor fixo)
  • Vencimento — entre 2 e 10 dias úteis no futuro
  • Descrição opcional

A cobrança aparece em Transações com tipo Pix Automático. Quando o débito é efetuado, o status muda para Recebido automaticamente via webhook.

Status da cobrança (instrução)

StatusSignificado
AguardandoCriada na Vitrin, ainda não enviada ao SPI
AgendadaAgendada no SPI, aguardando data de débito
ConcluídaPagamento realizado
CanceladaCancelada antes do débito
RecusadaSaldo insuficiente, divergência ou outro motivo

Cancelando uma autorização

Clique no ícone X ao lado da autorização. Requer PIN. Após cancelada, novas cobranças não podem ser geradas, mas as cobranças já agendadas seguem o ciclo normal.

Atualizar status

Se quiser forçar uma atualização do status (sem aguardar webhook), abra os detalhes da autorização e clique em Atualizar status.


11. Transferências

Transfira seu saldo disponível para contas externas.

Saldo

TipoSignificado
DisponívelPronto para saque
A liberarAguardando compensação — a tela mostra o prazo de cada método
TotalDisponível + A liberar

Formas de transferência

  • Pix via chave — CPF, CNPJ, email, telefone ou chave aleatória
  • Dados bancários — Banco, agência, conta (Pix ou TED automático)

Ambas requerem confirmação de dados + PIN de segurança.

Taxa de saque

Uma taxa fixa é cobrada por saque. A tela de Transferências mostra a taxa da sua conta e o valor que chega ao destino antes de você confirmar.

Extrato

A aba Extrato mostra todas as movimentações financeiras com saldo corrente.

Calendário de saques

O painel Recebíveis mostra a projeção do que vai cair na sua conta nos próximos dias, com o prazo de cada método de pagamento. É uma estimativa.

Para o valor exato que vai aparecer no seu extrato bancário hoje (e nos próximos dias úteis), use o card Depositado no painel principal: é o repasse efetivo, já com fins de semana, feriados e repasses recusados. Ele pode ser diferente da projeção de Recebíveis.

Por que o nome no meu extrato bancário não é a Vitrin?

Quando você recebe o repasse na sua conta bancária, o descritor do Pix vai mostrar o nome da instituição de pagamento autorizada pelo Banco Central que executou a transferência — não o da Vitrin nem o da sua loja. Isso é exigência regulatória do SPI/BACEN (o ordenador da transferência precisa se identificar), aplicada a qualquer intermediador de pagamentos no Brasil, e não é configurável.

Tudo fora desse caso continua white-label: seu cliente final vê o nome da sua loja no checkout, no e-mail de confirmação, no webhook que o seu sistema recebe. O nome da instituição de pagamento só aparece no extrato bancário do repasse que cai pra você.


12. Simulador

Simule taxas, valor líquido e prazos antes de cobrar:

  1. Insira o valor da venda
  2. Escolha o método (Pix, Boleto, Cartão)

O simulador mostra em tempo real:

  • Quanto você recebe líquido (valor da venda menos a taxa) e quando — a tela mostra o prazo de cada método
  • Quanto você recebe com antecipação, quando a antecipação estiver liberada na sua conta
  • Detalhamento da taxa (percentual + fixa)
  • Comparativo visual em barras

13. Configurações

Métodos de Pagamento

Ative ou desative Pix, Pix Automático, Cartão de Crédito e Boleto conforme sua necessidade. Os métodos disponíveis dependem do que o admin Vitrin liberou para a sua organização — métodos não liberados aparecem esmaecidos com a tag Não liberado. Para solicitar liberação, contate o suporte.

Sob cada toggle a Vitrin lista os campos que aquele método obriga no checkout (ex.: Boleto exige CEP, Endereço, Número, Cidade, UF). Você não precisa configurar isso à mão — esses campos aparecem automaticamente no checkout público quando o pagador escolhe o método. Veja a seção 14 → "Campos do checkout" para detalhes.

Parcelamento

  • Máximo de parcelas — de 1x a 12x (dentro do que a Vitrin liberar para a sua conta). Vale como teto para produtos, links e pedidos.
  • Parcela mínima — Valor mínimo de cada parcela

Adicional de parcelamento

Aparece quando a Vitrin libera o adicional para a sua conta (peça ao suporte), o Cartão está ativo e o máximo de parcelas passa de 1x. É um acréscimo cobrado do cliente no parcelamento, que fica para você. Defina um percentual para cada faixa liberada, até o limite que aparece embaixo do campo:

  • 2 a 6 parcelas (%)
  • 7 a 12 parcelas (%)

0 desliga o acréscimo na faixa. O cliente vê o valor da parcela e o total já com o acréscimo, no checkout e no link de pagamento. A comissão de afiliados e coprodutores não incide sobre ele (seção 6.3).

Repassar taxa ao cliente

Por padrão a taxa da Vitrin sai do seu valor líquido (veja a seção 12 → Simulador). A Vitrin pode liberar, para a sua organização, a opção de repassar essa taxa ao cliente final em vez de descontá-la do seu recebido — nesse caso o cliente paga o preço mais a taxa, e você recebe o valor cheio que anunciou.

Essa seção só aparece em Conta → Configurações depois que a Vitrin libera a opção para a sua conta; contate o suporte para solicitar. Uma vez liberada, você liga o repasse por meio de pagamento — um toggle para cada um de Cartão, Pix (a mesma chave cobre o Pix Automático) e Boleto — só aparecem os métodos que já estão habilitados para a sua org.

Pontos importantes:

  • Vale para cobranças e assinaturas novas a partir do momento em que você liga o toggle; nada muda retroativamente.
  • Assinaturas existentes não mudam quando você liga ou desliga o repasse depois — o estado é fixado no momento em que cada assinatura foi criada.
  • Se a Vitrin revogar a liberação, todos os métodos voltam a ficar desligados (você precisa religar depois de uma nova liberação — não volta sozinho).
  • Não afeta comissão de afiliados/coprodutores nem o seu adicional de parcelamento, que continuam calculados sobre o preço do produto/plano.
  • Organizações do tipo LLC (conta global, cobrança em USD) não têm essa opção.
  • Pix Automático: o repasse vale para assinaturas de Pix Automático criadas a partir de um plano (no painel ou no checkout do plano). Autorizações e cobranças de Pix Automático avulsas criadas pela API com valor fixo não recebem o repasse — o valor informado é o valor debitado.

Confirmação do banco no cartão (3DS)

Com o 3DS ligado, antes de pagar com cartão o comprador confirma a compra com o banco dele — por um código no SMS ou no app do banco. Na maioria das compras a confirmação é automática e o comprador nem vê o passo.

O que você ganha:

  • Segurança: o banco confirma que é o comprador quem está pagando. Em compra autenticada, a contestação por fraude ("não reconheço esta compra") costuma ficar com o banco emissor; as demais (produto não entregue, desacordo, duplicidade) seguem com você.
  • Antecipação: se a antecipação estiver liberada na sua conta, a venda com 3DS confirmado tem condições melhores de antecipação do que a venda sem 3DS, conforme as condições da sua conta. A antecipação é sempre sujeita a análise e aprovação. A tela de Configurações mostra os seus números.
  • O antifraude, se estiver ligado, continua valendo nas vendas com 3DS.

Como ligar: Conta → Configurações → Confirmação do banco no cartão (3DS). A opção só aparece quando o 3DS está disponível para a sua conta — o seu Anexo Comercial precisa permitir o 3DS, e contas LLC não têm a opção (veja "Não aparece" abaixo). O padrão é desligado. Não pede PIN.

Onde vale: no checkout público (/c/...), nos links de pagamento (/p/...) e nas cobranças de cartão pela API (a sua integração recebe a política e segue a mesma regra — ver INTEGRACAO.md).

Se o banco não confirmar: com o 3DS ligado por você, a venda segue sem a confirmação — cartão não inscrito, bandeira sem 3DS, banco fora do ar ou comprador que desiste do código não fazem você perder a venda. Essas vendas só não ganham os benefícios acima.

Quando a opção aparece diferente:

  • Travada em "Obrigatório na sua conta": o seu Anexo Comercial exige 3DS. Sem a confirmação do banco, o pagamento com cartão é recusado e o comprador vê a sugestão de pagar com Pix ou boleto. Bandeiras sem 3DS (JCB, Aura, Diners, Discover) seguem sem ela.
  • Não aparece: o 3DS está desabilitado no seu Anexo Comercial, ou a conta é LLC (conta global, em que a autenticação do cartão é feita automaticamente).

Assinaturas: no checkout de um plano, o 3DS só roda quando ele é obrigatório na sua conta — a cobrança recorrente não leva a confirmação ao banco, então com o 3DS apenas ligado o plano segue como antes. Renovações, cartão salvo e one-click nunca pedem a confirmação.

No detalhe de cada transação de cartão (Visão geral → Transações), a linha 3DS mostra se o banco autenticou a compra.

Recibo automático

Com o Recibo automático ativo (ele vem ligado), o cliente recebe um e-mail de confirmação assim que o pagamento é confirmado, desde que tenha e-mail cadastrado. É nesse comprovante que vai o botão do Link de entrega (seção 6). Para desligar, use a chave do bloco Recibo automático.

Webhook

Configure a URL onde sua aplicação recebe notificações de eventos (pagamento confirmado, reembolso, chargeback, etc.).

  • URL — Endpoint HTTPS da sua aplicação
  • Secret — Gerado automaticamente, usado para validar assinaturas HMAC-SHA256

Checkout

A configuração detalhada do Checkout público vive em uma página própria — Crescimento → Checkout público. Veja a seção 14 abaixo.

API Key

Regenere sua API key (a anterior é revogada). Requer PIN.


14. Checkout público

A Vitrin hospeda uma página de checkout pronta para cada produto e plano que você cria. Sem precisar codar nada, você compartilha um link e o cliente paga direto.

URL do checkout

Cada item gera uma URL no formato:

https://vitrin.digital/c/<sua-org>/<slug-do-item>

O atalho "Copiar link" existe nos cards de Produtos e Planos. Use esse link em bios de redes sociais, anúncios, emails de campanha, QR codes em ponto físico, etc.

O que o cliente vê

  • Sua marca (logo + cores) no topo
  • Nome, descrição, capa e vídeo do produto/plano
  • Para planos: preço por ciclo, badge de trial gratuito
  • Para contribuição/valor aberto: campo destacado "Você define o valor" com piso/teto
  • Order bumps ativos — checkbox com oferta complementar
  • Campo de cupom com validação em tempo real
  • Coleta de dados do pagador (nome, email, CPF, telefone)
  • Escolha do método (Pix, Cartão, Boleto — só os ativos da sua org). No link de um plano, as opções são Pix Automático, Cartão e Boleto (o Pix comum não assina). Em contas onde o período de teste não está disponível no cartão ou boleto mensal, plano com período de teste não assina pelo link: a página mostra "Este plano tem período de teste e não está disponível para assinatura por aqui. Fale com a loja."
  • Em cartão: parcelamento dentro do limite do produto
  • Em cartão, com o 3DS ligado (seção 13): a tela "Confirmando com o seu banco" antes do pagamento, e o código do banco quando ele pedir
  • Após o pagamento: redireciona para o Link de entrega configurado no item (ou para o Link de entrega padrão definido em Checkout público), ou exibe instruções (QR Pix / boleto). O mesmo link vai como botão no comprovante enviado ao pagador
  • Em plano no cartão: "Assinatura confirmada" (ou o redirecionamento para o Link de entrega). Se a assinatura nascer esperando o cartão, a tela "Falta cadastrar o cartão", com o botão para o cliente cadastrar o cartão e ativar a assinatura
  • Em plano no boleto: "Assinatura criada", avisando que o boleto de cada cobrança é enviado para o e-mail do cliente. Não há redirecionamento para o Link de entrega, porque nada foi pago ainda

Configuração — Crescimento → Checkout público

BlocoCampos
TopoLogo (URL da imagem), Cor principal (botão de pagar, meio escolhido e etapas) e Mostrar o nome da loja ao lado do logo
Etapa 1 · Seus dadosDefina o que o pagador preenche antes de pagar (ver "Campos do checkout", abaixo)
Etapa 2 · PagamentoSó leitura: o que cada meio pede a mais. Os meios oferecidos são os habilitados em Conta → Configurações → Métodos de pagamento
RodapéTexto de termos (abaixo do botão de pagar), E-mail de suporte e WhatsApp de suporte
Depois de pagarLink de entrega padrão (vale quando o produto ou plano não define o seu)

A página exibe também o link base do seu checkout para fácil cópia.

Campos do checkout

Você decide o que exibir e o que é obrigatório no checkout público.

Sempre obrigatórios (sistema): Nome completo e CPF/CNPJ — não podem ser desativados.

Toggleáveis (você escolhe Exibir / Obrigatório):

  • Email
  • Telefone
  • Data de nascimento
  • CEP, Endereço, Número, Complemento, Cidade, UF

Reforço automático por método de pagamento. Cada método tem um conjunto mínimo de campos obrigatórios. A Vitrin força esses campos como obrigatórios automaticamente quando o pagador escolhe o método correspondente — não há como desativar:

MétodoCampos exigidos automaticamente
Pix / Pix AutomáticoEmail
Cartão de créditoEmail, Telefone
BoletoEmail, CEP, Endereço, Número, Cidade, UF

Exemplo: você desabilita o bloco de endereço no checkout, mas mantém Boleto entre os métodos. Quando o pagador clica em Boleto, os campos de endereço aparecem com asterisco automaticamente. Em Pix, somem.

Ao ativar CEP, o checkout faz auto-preenchimento via ViaCEP — o pagador digita 8 dígitos e endereço/cidade/UF chegam prontos. Recomendado para produtos físicos e para reforçar defesa de chargeback.

Campos customizados. Adicione qualquer pergunta extra:

  • Chave (id) — identificador interno (ex.: como_conheceu)
  • Pergunta exibida — o texto que o pagador vê
  • Tipo — texto, texto longo, email, telefone, ou lista (select)
  • Obrigatório — checkbox
  • Opções — quando tipo é lista (uma por linha)

As respostas viram parte do Customer.custom_data e também do bloco order no webhook canônico (payment.order → customer_chosen_amount/coupon/...). Use para perguntar coisas como "Como nos conheceu?", "Tamanho da camiseta", "Restrição alimentar", etc.

White-label

A Vitrin não é mencionada nas páginas públicas — a marca exibida é a da sua organização. Cliente final percebe o pagamento como sendo direto com você.

Webhook após o pagamento

Quando o pagamento é confirmado, sua URL de webhook recebe o evento canônico de pagamento enriquecido com o bloco order contendo:

{
  "event": "PAYMENT_RECEIVED",
  "payment": {
    "id": "...",
    "status": "received",
    "amount": 50.00,
    "order": {
      "id": "...",
      "product": {
        "id": "...",
        "slug": "doacao-vitrin",
        "name": "Apoie o canal",
        "type": "contribution",
        "thank_you_url": "https://..."
      },
      "coupon": { "code": "PROMO10", "discount_amount": 5.00 },
      "bump": { "product_name": "Ebook bônus", "amount": 19.00 },
      "customer_chosen_amount": 50.00
    }
  }
}

Use isso para liberar acesso à área de membros, enviar o produto digital, registrar a doação no seu CRM, etc., sem chamada GET extra.

Trial e dunning

  • Trial gratuito: definido no plano, no campo Dias de teste (ex.: 7). Só existe trial gratuito. Em contas onde o período de teste não está disponível no cartão ou boleto mensal, o painel avisa e a assinatura de um plano com teste é feita no carnê, pelo painel ou pela API, e o link do plano com teste não aceita assinatura (ver 4.10, linha "Período de teste").
  • Inadimplência (dunning): assinaturas que ficam overdue por 7 dias disparam o webhook subscription.dunning_warning. Após 30 dias, são automaticamente canceladas e disparam subscription.canceled_for_dunning. Use esses eventos no seu fluxo de retenção.

15. Segurança

PIN de 6 dígitos

Operações sensíveis requerem PIN:

AçãoRequer PIN
Reembolsar transaçãoSim
Solicitar antecipaçãoSim
Cancelar autorização Pix AutomáticoSim
Transferir saldoSim
Alterar webhookSim
Regenerar API keySim
Alterar métodos de pagamentoSim
Criar cobrançaNão
Criar autorização Pix AutomáticoNão
Gerar cobrança recorrente Pix AutomáticoNão
Visualizar relatóriosNão

Bloqueio de PIN

Após 5 tentativas erradas, o PIN é bloqueado por 15 minutos.

Redefinir PIN

Na tela de login, clique em "Esqueci meu PIN" (o mesmo link aparece na janela que pede o PIN). Confirme com seu e-mail e senha: você recebe por e-mail um link para criar o novo PIN.


16. Chargebacks

Disputa é manual: você sustenta a defesa diretamente com a operadora do cartão. A Vitrin é o organizador: aqui você guarda e baixa o material, e encaminha pra operadora pelo canal manual deles.

Acesse Chargebacks no menu pra ver as disputas em aberto.

Anexar evidências

Em cada disputa (botão "Defender"), abra o painel lateral e anexe arquivos por categoria:

  • Comprovante de entrega/serviço — nota fiscal, rastreio, foto do entregue
  • Comunicação com cliente — emails, prints de chat, SMS
  • Contrato/termo aceito — termos de uso, contrato assinado
  • Recibo / comprovante de uso — login logs, prova de uso do produto
  • Tentativa de reembolso/contato — mostra que tentou resolver
  • Logs de IP / sessão / dispositivo — comprova que foi o cliente quem comprou
  • Outro

Arquivos PDF, imagens, etc — máx 25 MB por upload. Você pode coletar evidências preventivamente em transações que ainda não foram contestadas (ex: salvar comprovante de entrega assim que entregar) — isso facilita defesa rápida quando a disputa surge.

Dossiê de defesa pré-montado

A Vitrin gera automaticamente um relatório com tudo que ela tem da transação:

  • Dados do pagador (CPF, email, telefone, IP, endereço)
  • Detalhes da transação (valor, data, método)
  • Comprovante de entrega (se o pedido foi marcado como entregue)
  • Transações anteriores do mesmo cliente (não contestadas)
  • Timeline de webhooks
  • Registro de auditoria

Junto com suas evidências anexadas, você usa esse material pra montar a contestação no painel/canal da operadora do cartão.

Boas práticas pra reduzir chargebacks: cobre só após confirmar identidade, marque pedidos como fulfilled assim que entregar, mantenha cadastro de cliente completo (endereço!), responda chargebacks rapidamente.


17. Recebíveis

Acesse Recebíveis no menu lateral pra ver o cronograma do dinheiro que vai cair na sua conta. Útil pra projetar fluxo de caixa.

A página mostra:

  • A receber — total previsto no horizonte selecionado (7/30/90/365 dias)
  • Próximos 7 dias — caixa de curto prazo
  • Por mês — quanto cai em cada mês
  • Detalhamento — cada repasse previsto, com método e parcela (ex: 2/3 em cartão 3x)

Regras de release: a tela mostra o prazo de liquidação de cada método e parcela. Se você antecipou uma cobrança, ela aparece consolidada com o selo "Antecipado".


18. Exportar dados (LGPD)

Acesse Conta → Configurações → Exportar dados pra baixar um snapshot completo dos seus dados (clientes, transações, assinaturas, planos, produtos). Atende ao direito de portabilidade da LGPD.

  • Formato JSON — arquivo único com tudo aninhado
  • Formato CSV — zip com 5 tabelas separadas

Processamento leva alguns segundos. Quando pronto, você recebe email com link de download. O histórico fica disponível por 90 dias. Limite: 1 export rodando por vez (pra não sobrecarregar).


19. Indicadores no header (test/live + ambiente)

Dois badges pequenos no topo do dashboard:

  • Test mode / Live mode — reflete o estado da sua org. Antes da aprovação, só vd_test_* funciona; depois, vd_live_* também.
  • Local / Sandbox / Produção — indica em qual ambiente da Vitrin você está logado. Útil quando você tem várias instâncias.

Passe o mouse pra ver o tooltip explicativo de cada um.


20. Casos de uso

Situações do dia a dia e o caminho completo para resolver cada uma, no painel e pela API. Todos os casos seguem o mesmo formato: para quem é, o desafio, como a Vitrin resolve, o passo a passo, pela API, as formas de pagamento e o que é bom saber. Os exemplos usam uma doceria, mas o caminho é o mesmo para qualquer negócio.

As formas de pagamento de cada caso dependem do que está liberado e ativo na sua conta, em Conta → Configurações → Métodos de pagamento (seção 13). Uma forma com o selo Não liberado precisa ser pedida ao suporte.

CasoQuando usar
Clube de assinatura com valor por clienteMensalidade automática em que cada cliente paga um valor
Encomenda sob medida paga antes da produçãoValor combinado na conversa, pago por link
Assinante que prefere boleto: boleto mensal ou carnêAssinatura sem cartão, com um boleto por mês no e-mail ou todos de uma vez
Loja virtual própria integrada pela APISite ou app próprio que cria cobranças
Pagamento com cartão dentro do seu siteFormulário de cartão na sua própria página
Campanha sazonal com combo, oferta extra e cupomKit de data especial com desconto
Vendas pelo link da bio, sem siteVender pelas redes sociais com página pronta
Cliente fiel que recompra sem digitar o cartãoRecompra com um clique
Associação ou clube com mensalidade por faixa e aprovaçãoMuitos membros, valores por categoria, inscrição aprovada
Doação ou contribuição com valor livreCada pessoa escolhe quanto dá, uma vez ou todo mês
Débito automático no Pix (Pix Automático)Assinatura no Pix sem o cliente lembrar todo mês
Receber o valor cheio: repasse da taxa e adicional de parcelamentoO cliente paga a taxa ou o acréscimo do parcelado
Revendedoras e parceiras que ganham comissão (afiliados)Vender por indicação, com comissão automática

Clube de assinatura com valor por cliente

Para quem: loja com caixa ou pacote mensal em que cada cliente paga um valor diferente.

O desafio: cobrar todo mês sem esquecer ninguém, sem criar um plano para cada preço, e ajustar o valor quando a cliente muda de caixa.

Como a Vitrin resolve: um só plano serve de base, e cada assinatura tem o preço daquela cliente. A cobrança de cada mês sai sozinha. Quando a cliente muda de caixa, você altera o valor pelo painel: ele vale a partir da próxima cobrança, sem cobrar duas vezes o mesmo mês.

Passo a passo no painel:

  1. Em Catálogo → Planos, clique em Novo plano. Dê um nome (ex.: "Clube do doce"), informe o preço de referência, escolha o ciclo Mensal e clique em Criar plano.
  2. Em Vendas → Clientes, clique em Novo cliente e cadastre a cliente.
  3. Em Recorrência → Assinaturas, clique em Nova assinatura. Escolha a cliente e o plano, ligue Preço personalizado para este contrato e informe o Valor cobrado por ciclo.
  4. Em Forma de pagamento, escolha uma das opções que aparecem e clique em Criar:
    • Cartão: aparece o Link de ativação, com Copiar, Enviar por WhatsApp e Enviar por e-mail. A cliente cadastra o cartão uma vez.
    • Pix Auto (só aparece se o Pix Automático estiver liberado na sua conta): aparece o QR Code para a cliente autorizar uma vez no app do banco.
    • Boleto: a cliente recebe o boleto de cada mês por e-mail.
    • Carnê (boletos): todos os boletos de uma vez. Veja o caso "Assinante que prefere boleto: boleto mensal ou carnê".
  5. Quando a cliente mudar de caixa, clique na assinatura para abrir o detalhe e depois em Alterar valor. Informe o novo valor e, se quiser, o motivo.
  6. O detalhe passa a mostrar Novo valor a partir de DD/MM. Mudou de ideia antes da data? Clique em Cancelar mudança.
  7. No cartão, na data da mudança você recebe por e-mail o link de ativação. Envie à cliente pelo botão Enviar link de ativação, no detalhe da assinatura. A cobrança no valor novo sai quando ela cadastra o cartão de novo.

Pela API:

  • POST /plans/: Planos
  • POST /customers/: 2. Clientes
  • POST /subscriptions/ com amount_override e billing_type: Assinaturas
  • POST /subscriptions/{id}/change-amount/ e POST /subscriptions/{id}/change-amount/cancel/: Alterar valor

Formas de pagamento: Cartão de crédito, se estiver ativo na sua conta. Boleto mensal e carnê, se o Boleto estiver ativo (o carnê não tem Alterar valor, veja abaixo). Pix Automático, se estiver liberado na sua conta. Assinatura no Pix comum não existe: para Pix, use o Pix Automático.

Bom saber:

  • O novo valor vale a partir da próxima cobrança, nunca no mês já pago. No boleto mensal, o boleto daquela data já sai no valor novo. No Pix Automático, vale na hora e a cliente não precisa autorizar de novo.
  • No cartão, a cliente precisa cadastrar o cartão de novo na data da mudança. Até lá a assinatura fica Pendente e nada é cobrado. Avise a cliente antes que vai chegar um link.
  • Assinatura em carnê não tem Alterar valor, porque as parcelas já foram emitidas. Para mudar, cancele e crie outra.
  • Mais detalhes em Preço personalizado por contrato e Alterar valor de uma assinatura ativa, neste manual.

Encomenda sob medida paga antes da produção

Para quem: quem vende sob encomenda, com o valor combinado na conversa (bolo, cesta, serviço).

O desafio: receber antes de produzir, sem cadastrar um produto para cada encomenda.

Como a Vitrin resolve: você cria um link de pagamento com o valor combinado e envia pelo WhatsApp ou por e-mail. A cliente paga por Pix, cartão ou boleto numa página com a marca da sua loja, e o link vale para um pagamento só.

Passo a passo no painel:

  1. Em Vendas → Links de pagamento, clique em Novo link.
  2. Preencha Valor e Descrição (ex.: "Bolo de aniversário, 2 kg"). Se quiser, ajuste a Validade, escolha o Cliente (opcional), marque os Meios de pagamento e defina as Parcelas máximas (cartão).
  3. Clique em Criar link. Na tela do link, use Copiar, Enviar por WhatsApp ou Enviar por e-mail.
  4. Para mandar de novo depois, clique em Enviar no link que está Aberto.
  5. Quando a cliente paga, o link vira Pago, com o botão Ver transação.

Se a encomenda é um item do seu catálogo, use um pedido: em Vendas → Pedidos, clique em Novo pedido, escolha Cliente e Produto e clique em Criar pedido e link. O pedido vira Pago sozinho quando a cliente paga.

Pela API:

  • POST /payment-links/, POST /payment-links/{id}/send-email/ e POST /payment-links/{id}/cancel/: 3.9 Link de pagamento avulso
  • POST /orders/create/ sem billing_type e POST /orders/{id}/payment-link/renew/: Pedidos

Formas de pagamento: Pix, Cartão de crédito e Boleto, os que estiverem ativos na sua conta. No cartão, a cliente pode parcelar até o teto da sua conta (no máximo 12x). Pix Automático não entra em link de pagamento.

Bom saber:

  • Cada link vale para um pagamento. Para cobrar duas pessoas, crie um link para cada uma.
  • Com a cliente escolhida no link, ela só confirma o pagamento. Sem cliente, o link pede os dados dela.
  • Enviar por e-mail só funciona com cliente escolhida no link e com e-mail cadastrado.
  • Link vencido não volta a valer: crie outro (no pedido, Gerar novo link). Um Pix ou boleto que a cliente já gerou continua valendo.
  • Link de pagamento e pedido com link só funcionam com a chave de produção, não no sandbox. Contas LLC (conta global) não têm link de pagamento.
  • Mais detalhes em Pedidos e Links de pagamento, neste manual.

Assinante que prefere boleto: boleto mensal ou carnê

Para quem: assinantes que não têm cartão, não querem deixar o cartão salvo ou preferem pagar boleto.

O desafio: manter a assinatura sem cartão e sem precisar gerar e mandar um boleto por mês à mão.

Como a Vitrin resolve: há dois jeitos, e nos dois o boleto chega sozinho. No boleto mensal, a cada ciclo sai um boleto novo e o assinante recebe o boleto de cada mês por e-mail. No carnê, todos os boletos do período (de 1 a 12) saem de uma vez, num PDF com a marca da sua loja, que você envia uma vez pelo WhatsApp ou por e-mail. No carnê, cada parcela pode ser paga pelo código de barras ou, quando o boleto tem Pix, pelo QR Code, e o próximo carnê sai sozinho antes do fim do atual.

Passo a passo no painel:

  1. Em Recorrência → Assinaturas, clique em Nova assinatura e escolha a assinante e o plano. Se quiser, ligue Preço personalizado para este contrato.
  2. Em Forma de pagamento, escolha:
    • Boleto, para um boleto por mês enviado ao e-mail da assinante. Sem e-mail no cadastro dela, a Vitrin recusa a criação;
    • ou Carnê (boletos), para todos os boletos de uma vez.
  3. No carnê, escolha as Parcelas (de 1 a 12) e o 1º vencimento. Ligue Enviar o carnê por e-mail ao assinante para ela receber por e-mail agora e a cada renovação.
  4. Clique em Criar. No carnê, o painel do carnê abre: use Enviar por WhatsApp, Enviar por e-mail ou Copiar o link do PDF.
  5. Assinante que hoje paga no cartão ou no boleto mensal e quer o carnê: clique na assinatura e depois em Trocar para carnê. Deixe o 1º vencimento em branco para a 1ª parcela vencer na próxima cobrança, sem cobrar de novo o período já pago.
  6. A assinante do carnê perdeu o boleto? Abra o carnê (Abrir carnê, no detalhe da assinatura) e mande o mesmo link de novo, ou use Copiar linha ou Copiar Pix para mandar uma parcela só.

Pela API:

Formas de pagamento: as duas precisam do Boleto ativo na sua conta. Contas LLC (conta global) não têm carnê.

Bom saber:

  • Boleto mensal: em contas em que ele chega por e-mail, o cadastro precisa de um e-mail válido — sem ele, a Vitrin recusa criar ou aprovar a assinatura. Alterar valor vale a partir da próxima cobrança, e o assinante não precisa fazer nada.
  • Carnê: não tem Alterar valor, porque as parcelas já saem com o valor. Para mudar, cancele e crie outra assinatura.
  • O link do plano (Copiar link no card, em Catálogo → Planos) também oferece Boleto: quem assina por ele recebe o boleto de cada mês por e-mail. O carnê só se cria pelo painel ou pela API.
  • Em contas onde o período de teste não está disponível no cartão ou boleto mensal, plano com período de teste só aceita o carnê, que tem o 1º vencimento no fim do teste. No boleto mensal, o 1º boleto sai na hora.
  • Assinatura no Pix Automático não troca para carnê. Cancele e crie outra em carnê.
  • O carnê novo sai sozinho 30 dias antes do vencimento da última parcela, se a assinatura estiver Ativa. Com o Boleto desativado na conta, ele não renova.
  • No carnê, a assinatura só fica Inadimplente alguns dias depois do vencimento de uma parcela não paga (veja as datas em Assinatura em carnê, neste manual).
  • Mais detalhes em Assinatura em carnê, neste manual.

Loja virtual própria integrada pela API

Para quem: quem tem site ou app próprio, e o desenvolvedor que faz a integração.

O desafio: criar a cobrança dentro do site, liberar o pedido na hora certa e nunca cobrar duas vezes a mesma compra.

Como a Vitrin resolve: a API cria o cliente e a cobrança no Pix, no cartão ou no boleto, e o webhook avisa o seu sistema quando o pagamento é confirmado. Com a chave de idempotência, uma requisição repetida devolve a mesma cobrança em vez de criar outra. Dá para integrar e testar no sandbox antes da aprovação da conta.

Passo a passo no painel:

  1. Em Conta → Configurações → Chaves de API, veja as chaves. A de teste (vd_test_*) funciona na hora; a de produção (vd_live_*), depois da aprovação.
  2. Em Conta → Configurações → Webhook, informe a URL HTTPS que vai receber os avisos e clique em Salvar webhook (pede o PIN). Guarde o Secret (HMAC): ele valida a assinatura de cada aviso.
  3. Acompanhe as cobranças criadas pelo site em Visão geral → Transações.

Pela API:

Formas de pagamento: Pix, Cartão de crédito e Boleto, os que estiverem ativos na sua conta. Para o cartão digitado numa página sua, veja o caso "Pagamento com cartão dentro do seu site".

Bom saber:

  • A chave secreta (vd_live_* ou vd_test_*) fica só no servidor. Nunca a coloque na página ou no app.
  • Use como Idempotency-Key um identificador do seu pedido e repita a mesma chave em toda nova tentativa do mesmo pedido. Uma chave nova a cada tentativa não protege.
  • Trate o webhook de forma idempotente por payment.id: o mesmo pagamento pode chegar em mais de um aviso.
  • Link de pagamento e pedido com link não existem no sandbox.

Pagamento com cartão dentro do seu site

Para quem: o desenvolvedor de uma loja com checkout próprio.

O desafio: ter o formulário de cartão na própria página sem expor a chave secreta e sem deixar o navegador decidir o valor.

Como a Vitrin resolve: o seu servidor cria uma intenção de pagamento com o valor e o cliente já definidos, e a página confirma o pagamento com a chave publicável, que só serve para isso. Se o banco pedir, o comprador confirma a compra no app ou por código, na mesma tela.

Passo a passo no painel:

  1. Em Conta → Configurações → Chaves de API, copie a chave do bloco No navegador (vd_pk_live_* na produção, vd_pk_test_* no teste). Ela pode ir na página.
  2. No mesmo bloco, a chave secreta aparece em Só no servidor: ela fica no seu servidor, que cria a intenção de pagamento.
  3. Se quiser que o banco confirme as compras no cartão, ligue a Confirmação do banco no cartão (3DS) em Conta → Configurações. A opção só aparece quando está disponível para a sua conta.
  4. Acompanhe os pagamentos em Visão geral → Transações.

Pela API:

Formas de pagamento: Cartão de crédito, à vista ou parcelado até o limite da intenção e da sua conta (no máximo 12x). Para Pix e boleto, use POST /charges/ (caso anterior).

Bom saber:

  • A intenção de pagamento é de uso único e vale 60 minutos. Crie uma por tentativa de compra.
  • Se a resposta vier processing, não cobre de novo: a cobrança pode ter sido feita. Aguarde o webhook.
  • A chave publicável não escolhe valor nem cliente, e em qualquer outro endpoint recebe 401.
  • O banco do comprador pode pedir uma confirmação (código por SMS ou no app do banco).

Campanha sazonal com combo, oferta extra e cupom

Para quem: loja que monta kits em datas especiais (Páscoa, Dia das Mães, Natal).

O desafio: vender um kit por um preço promocional, aumentar o valor de cada venda e dar um desconto só durante a campanha, sem mexer nos preços do catálogo.

Como a Vitrin resolve: o combo junta vários produtos num preço só, a oferta extra (order bump) aparece no checkout para o cliente acrescentar com um clique, e o cupom dá o desconto da campanha com validade e limite de usos. Tudo sai num link pronto para divulgar.

Passo a passo no painel:

  1. Em Catálogo → Produtos, clique em Novo produto para cada item (ex.: ovo de 500 g, caixa de bombons), com o tipo Pagamento único, e clique em Criar produto.
  2. Clique em Novo produto de novo, escolha o tipo Combo, informe o preço do kit e clique em Criar produto.
  3. Clique em Editar no combo. Em Itens incluídos no combo, escolha cada produto em Adicionar produto ao combo..., clique em Adicionar e depois em Salvar.
  4. Em Catálogo → Order Bumps, clique em Novo bump. Em Aparece no checkout de, escolha o combo; em Oferta produto adicional, o item extra. Preencha o Título da oferta e, se quiser, o Desconto sobre preço original (%).
  5. Em Catálogo → Cupons, clique em Novo cupom. Preencha o Código (ex.: PASCOA10), o Tipo (Percentual ou Valor fixo) e o valor, a Validade e o Limite de usos. Em Vale para, marque o combo. Clique em Criar.
  6. Em Catálogo → Produtos, clique em Copiar link no card do combo e divulgue.

Pela API:

Formas de pagamento: Pix, Cartão de crédito e Boleto, os que estiverem ativos na sua conta. No cartão, o parcelamento vai até o teto do produto e da sua conta (no máximo 12x).

Bom saber:

  • O combo tem preço fixo: não aceita Pagador escolhe o valor, e um combo não entra em outro combo.
  • Salve o combo antes de adicionar os itens.
  • Cupom sem nada marcado em Vale para vale para todos os produtos e planos. Nas assinaturas, o cupom só vale no Pix Automático e só na 1ª cobrança (veja Cupom em planos (assinaturas), neste manual). Para a campanha, marque só os produtos dela.
  • O cupom conta um uso quando a cobrança é gerada, mesmo que o Pix ou o boleto não seja pago depois. Uma cobrança que falha não gasta o cupom.
  • Mais detalhes em Combo (bundle de produtos), Order Bumps e Cupons, neste manual.

Para quem: quem vende pelas redes sociais ou pelo WhatsApp e não tem site.

O desafio: ter uma página de pagamento com a cara da loja e levar o cliente ao que ele comprou, mesmo quando ele fecha a página antes de terminar.

Como a Vitrin resolve: cada produto ganha uma página de pagamento pronta, com o logo e a cor da sua loja, e um link para pôr na bio. Depois de pagar, o cliente vai para o seu link de entrega, e o mesmo link vai como botão no comprovante que ele recebe por e-mail.

Passo a passo no painel:

  1. Em Catálogo → Produtos, clique em Novo produto (ex.: "Kit festa com 50 docinhos"), informe o preço e, em Link de entrega, a página para onde o cliente vai depois de pagar (ex.: o seu WhatsApp ou um formulário para agendar a entrega). Clique em Criar produto.
  2. Em Crescimento → Checkout público, preencha Logo (URL da imagem), Cor principal, WhatsApp de suporte e Link de entrega padrão. Se quiser, crie Perguntas extras (ex.: "Data da festa"). Clique em Salvar.
  3. Em Conta → Configurações, confira se o Recibo automático está ativo. Ele vem ligado.
  4. Em Catálogo → Produtos, clique em Copiar link no card do produto e cole na bio.

Pela API:

Formas de pagamento: Pix, Cartão de crédito e Boleto, os que estiverem ativos na sua conta. No boleto, o checkout pede o endereço. No cartão, o parcelamento vai até o teto do produto e da sua conta (no máximo 12x).

Bom saber:

  • Quem paga no Pix ou no boleto costuma fechar a página e pagar depois. Aí o botão no comprovante é o caminho até o link de entrega, então preencha o link mesmo que você entregue por outro canal.
  • O comprovante só vai com o Recibo automático ativo e para cliente com e-mail.
  • A entrega é sua: a Vitrin mostra o caminho, mas não guarda o arquivo nem controla o acesso.
  • Mais detalhes em Produtos (Link de entrega) e Checkout público, neste manual.

Cliente fiel que recompra sem digitar o cartão

Para quem: loja com clientes que compram de novo com frequência.

O desafio: cobrar a recompra sem pedir os dados do cartão toda vez.

Como a Vitrin resolve: no checkout, a cliente pode salvar o cartão. Depois, no cadastro dela, você gera um link de recompra: ela abre, vê o cartão salvo e o valor, e paga com um clique.

Passo a passo no painel:

  1. Na primeira compra com cartão (no link do produto ou num link de pagamento), a cliente marca Salvar este cartão para próximas compras.
  2. Em Vendas → Clientes, abra o cadastro da cliente (ícone de lápis) e vá ao bloco Cartão salvo (one-click).
  3. Clique em Link de recompra 1-clique. Escolha Produto e o item, o Valor (R$, opcional) (em branco, usa o preço do item) e as Parcelas. Clique em Gerar link.
  4. Clique em Copiar e mande o link por WhatsApp ou e-mail. A cliente abre e paga com um clique.
  5. Para a cliente ver ou remover o cartão salvo, gere o Link de gestão (24h) no mesmo bloco.

Pela API:

Formas de pagamento: Cartão de crédito, com o cartão que a cliente salvou.

Bom saber:

  • O link de recompra vale 15 minutos e um uso só: gere na hora de mandar.
  • Cada cliente tem um cartão salvo. Salvar outro substitui o anterior.
  • Cartão vencido não sai sozinho: peça para a cliente pagar com o cartão novo e salvá-lo de novo.
  • A cobrança com cartão salvo não pede o código de segurança (CVV).
  • Se o valor e a frequência são sempre os mesmos, uma assinatura dá menos trabalho (caso "Clube de assinatura com valor por cliente").
  • Mais detalhes em Cartão salvo & One-click buy, neste manual, com um texto sugerido para a sua política de privacidade.

Associação ou clube com mensalidade por faixa e aprovação

Para quem: associação, clube, escola ou loja maçônica com mensalidade que muda por categoria e com cadastro que precisa de aprovação.

O desafio: cobrar muitos membros com valores diferentes, todo mês, e só aceitar quem foi aprovado.

Como a Vitrin resolve: um plano serve para todos, e o valor de cada membro fica na assinatura dele. O link do plano recebe as inscrições, que só começam a cobrar depois que você aprova, e a lista de membros que já existe entra de uma vez por planilha.

Passo a passo no painel:

  1. Em Catálogo → Planos, clique em Novo plano e escolha o ciclo Mensal (o preço do plano é só a referência). Em Trial e cobranças avançadas, ligue Exige aprovação manual. Se o próprio membro informa o valor da faixa, ligue também Pagador define o valor e ajuste Mínimo aceito e Máximo aceito. Clique em Criar plano.
  2. Divulgue o link do plano (Copiar link, no card do plano). Cada inscrição aparece em Recorrência → Assinaturas como Aguardando aprovação (use o filtro de situação). Clique na inscrição e em Aprovar ou Rejeitar. No cartão, aparece o Link de ativação para você mandar ao membro.
  3. Para cadastrar um membro você mesma: em Vendas → Clientes, clique em Novo cliente. Depois, em Recorrência → Assinaturas, clique em Nova assinatura, ligue Preço personalizado para este contrato e informe o valor da faixa.
  4. Para uma lista grande no cartão ou no boleto mensal, clique em Importar CSV em Recorrência → Assinaturas, baixe o modelo e preencha uma linha por membro, com a forma em billing_type (CREDIT_CARD ou BOLETO; na conta global, PIX no lugar de BOLETO) e o valor da faixa em amount_override. No cartão, cada assinatura nasce esperando o cartão, com o botão Enviar link de ativação no detalhe. No boleto, o boleto de cada mês vai para o e-mail da linha.
  5. Quando a faixa de um membro mudar, use Alterar valor no detalhe da assinatura (caso "Clube de assinatura com valor por cliente").

Pela API:

  • POST /plans/ com requires_approval, allow_customer_defined_amount, min_amount e max_amount: Planos
  • POST /subscriptions/{id}/approve/ e POST /subscriptions/{id}/reject/: Aprovar ou rejeitar inscrição
  • POST /subscriptions/ com amount_override e POST /subscriptions/bulk/ (importação): Assinaturas

Formas de pagamento: Cartão de crédito, se estiver ativo na sua conta. Boleto mensal (em contas em que ele chega por e-mail) e carnê, se o Boleto estiver ativo. Pix Automático, se estiver liberado na sua conta. As formas aceitas na importação por CSV estão na planilha modelo, em Importar assinaturas em massa (CSV), neste manual.

Bom saber:

  • A Vitrin não avisa o membro sobre a aprovação: combine com ele o próximo passo.
  • A importação aceita até 500 linhas por vez. Pix Automático e carnê entram por Nova assinatura.
  • Não use uma autorização avulsa de Pix Automático para mensalidade: nela é você quem gera cada cobrança todo mês (veja Pix Automático, neste manual).
  • Cada conta recebe em nome do próprio CPF ou CNPJ. Se a associação é outra entidade, com CNPJ próprio, ela precisa da própria conta na Vitrin.
  • Mais detalhes em Preço personalizado por contrato, Importar assinaturas em massa (CSV) e Aprovação manual de inscrições, neste manual.

Doação ou contribuição com valor livre

Para quem: campanha solidária, ONG, igreja, criador de conteúdo ou loja que quer aceitar contribuição.

O desafio: deixar cada pessoa escolher quanto dá, uma vez ou todo mês.

Como a Vitrin resolve: o produto do tipo Contribuição recebe doações únicas com o valor que a pessoa escolhe, e o plano com valor livre transforma a doação em mensal, cobrada sozinha. Você define o mínimo, o máximo e um valor sugerido.

Passo a passo no painel:

  1. Doação única: em Catálogo → Produtos, clique em Novo produto e escolha o tipo Contribuição. Informe o Valor sugerido (R$) e, se quiser, o Mínimo aceito (R$) e o Máximo aceito (R$). Clique em Criar produto e depois em Copiar link no card.
  2. Doação mensal: em Catálogo → Planos, clique em Novo plano e escolha o ciclo Mensal. Em Trial e cobranças avançadas, ligue Pagador define o valor e ajuste Mínimo aceito (R$) e Máximo aceito (R$). Clique em Criar plano e depois em Copiar link no card.
  3. Para sugerir um valor no link do plano, acrescente ?suggested= ao final (ex.: ?suggested=30,00).

Pela API:

  • POST /products/ com product_type: "contribution", min_price e max_price: Produtos
  • POST /plans/ com allow_customer_defined_amount, min_amount e max_amount: Planos
  • Na doação única, o valor escolhido chega no webhook de pagamento, em payment.order.customer_chosen_amount; na mensal, é o amount_override da assinatura: Receber eventos

Formas de pagamento: na doação única, Pix, Cartão de crédito e Boleto, os que estiverem ativos na sua conta. Na mensal, Cartão de crédito, Boleto (em contas em que ele chega por e-mail) e, se estiver liberado na sua conta, Pix Automático.

Bom saber:

  • A doação mensal é um plano, não um produto.
  • Combo não aceita valor livre.
  • No plano, o valor escolhido vira o preço da assinatura daquela pessoa. Para mudar depois, use Alterar valor.
  • Mais detalhes em Planos e em Modo de preço, na seção Produtos deste manual.

Débito automático no Pix (Pix Automático)

Para quem: assinantes que querem pagar no Pix sem ter que lembrar todo mês.

O desafio: no Pix comum, o cliente precisa pagar cada cobrança, e o esquecimento vira atraso.

Como a Vitrin resolve: com o Pix Automático, o cliente autoriza uma vez no app do banco e as cobranças seguintes são debitadas sozinhas na data. A 1ª cobrança já vem junto com a autorização.

Passo a passo no painel:

  1. Confira se o Pix Automático está liberado em Conta → Configurações → Métodos de pagamento. Com o selo Não liberado, fale com o suporte. Liberado, ative.
  2. Em Vendas → Clientes, confira o cadastro do cliente: CPF/CNPJ, nome e endereço completo (CEP, endereço, número, cidade e UF).
  3. Em Recorrência → Assinaturas, clique em Nova assinatura, escolha o cliente e o plano, selecione Pix Auto em Forma de pagamento e clique em Criar. Aparecem o QR Code e o copia e cola para você mandar ao cliente.
  4. Quando o cliente autoriza no app do banco, a assinatura passa para Ativa.
  5. Pelo link do plano (Copiar link em Catálogo → Planos), com o Pix Automático liberado, o cliente escolhe entre Pix Automático, cartão e boleto (os que estiverem ativos).
  6. Sem o Pix Automático liberado, as alternativas para quem não usa cartão são o boleto mensal (em contas em que ele chega por e-mail) e o carnê, em que cada boleto pode ser pago também por Pix (caso "Assinante que prefere boleto: boleto mensal ou carnê"). Assinatura no Pix comum não existe, porque exigiria o assinante pagar cada cobrança.

Pela API:

  • POST /subscriptions/ com billing_type: "PIX_AUTOMATIC" (a resposta traz pix_automatic.qr_code e pix_automatic.qr_payload): Assinaturas
  • GET /settings/, para ver allowed_payment_methods e enabled_payment_methods: Ler configurações atuais
  • Autorização avulsa, em que você cria cada cobrança: 3.6 Pix Automático

Formas de pagamento: Pix Automático, só se estiver liberado e ativo na sua conta. Sem ele: boleto mensal ou carnê (com o Boleto ativo), ou cartão de crédito.

Bom saber:

  • Sem o cadastro completo do cliente, a assinatura não é criada.
  • Em contas onde o período de teste não está disponível no cartão ou boleto mensal, plano com período de teste também não aceita Pix Automático.
  • Alterar valor vale na hora, e o cliente não precisa autorizar de novo.
  • Cupom em plano só vale no Pix Automático, e só na 1ª cobrança (veja Cupom em planos (assinaturas), neste manual).
  • Assinatura no Pix Automático não troca para carnê.
  • A autorização avulsa (Recorrência → Pix Automático, botão Nova autorização) é outra coisa: nela você gera cada cobrança. Para mensalidade, use a assinatura.
  • Mais detalhes em Como funciona em cada forma de pagamento e em Pix Automático, neste manual.

Receber o valor cheio: repasse da taxa e adicional de parcelamento

Para quem: loja que quer que o cliente pague a taxa da venda ou um acréscimo no parcelado.

O desafio: anunciar um preço e receber esse valor inteiro, ou compensar o parcelamento longo.

Como a Vitrin resolve: com o repasse da taxa, o cliente paga o preço mais a taxa e você recebe o valor que anunciou. Com o adicional de parcelamento, o parcelado sai com um acréscimo que fica para você. O cliente vê o total antes de pagar.

Passo a passo no painel:

  1. Em Conta → Configurações, procure o bloco Repassar taxa ao cliente. Ele só aparece depois que a Vitrin libera a opção para a sua conta: peça ao suporte. Com ele liberado, ligue o repasse em cada forma de pagamento que quiser (o Pix vale também para o Pix Automático).
  2. No mesmo lugar, no bloco Adicional de parcelamento, informe o percentual em 2 a 6 parcelas (%) e em 7 a 12 parcelas (%). 0 desliga a faixa, e cada faixa vai até o limite liberado para a sua conta. O bloco aparece quando a Vitrin libera o adicional (peça ao suporte), com o cartão ativo e o Máximo de parcelas acima de 1x.

Pela API:

Formas de pagamento: o repasse vale para Cartão de crédito, Pix (inclusive Pix Automático, se liberado) e Boleto, os que estiverem ativos na sua conta. O adicional vale só no cartão parcelado.

Bom saber:

  • O repasse vale para cobranças e assinaturas novas. As assinaturas que já existem continuam cobrando como antes.
  • A comissão de afiliados é calculada sobre o preço, sem o repasse e sem o adicional.
  • Autorizações avulsas de Pix Automático criadas pela API não recebem o repasse.
  • Contas LLC (conta global) não têm o repasse.
  • Mais detalhes em Adicional de parcelamento e Repassar taxa ao cliente, na seção Configurações deste manual.

Revendedoras e parceiras que ganham comissão (afiliados)

Para quem: loja que quer vender por meio de revendedoras, influenciadoras ou clientes que indicam.

O desafio: pagar uma porcentagem por venda indicada sem planilha nem acerto manual.

Como a Vitrin resolve: cada afiliada aprovada divulga um link próprio, e a venda que vem dele registra a comissão sozinha. Você decide a comissão por produto ou plano, aprova quem divulga e acompanha tudo num relatório. Se a venda for estornada, a comissão é desfeita na mesma proporção.

Passo a passo no painel:

  1. Em Crescimento → Afiliados, ligue Programa ativo e ajuste a Janela de atribuição, a Comissão padrão — primeira venda (%) e, para planos, a Comissão recorrente padrão (%). Para revisar cada pedido, ligue Exigir aprovação manual. Clique em Salvar alterações.
  2. Para uma comissão diferente num item, vá a Crescimento → Afiliados → Configurar por produto e clique em Configurar no produto ou plano.
  3. Em Crescimento → Afiliados → Pedidos de afiliação, aprove ou rejeite quem pediu para divulgar.
  4. Acompanhe as vendas e comissões em Crescimento → Afiliados → Relatório de comissões.

Pela API:

Formas de pagamento: as mesmas do checkout do item vendido: Pix, Cartão de crédito e Boleto nos produtos; Cartão de crédito, Boleto e, se estiver liberado, Pix Automático nos planos.

Bom saber:

  • A comissão sai do líquido da sua venda. A taxa da Vitrin não muda com o programa.
  • Estorno ou contestação desfaz a comissão na mesma proporção.
  • A comissão é calculada sobre o preço do item, sem juros e sem o seu adicional de parcelamento.
  • Se a cliente clicou em mais de uma afiliada dentro da janela, vale a última.
  • Com Listar publicamente no marketplace Vitrin ligado, qualquer afiliada encontra seus produtos. Desligado, só as convidadas.
  • Mais detalhes em Programa de Afiliados, neste manual.

21. Suporte