Como conectar o seu CVCRM ao Play2sell PAY e pagar comissões automaticamente — credenciais, webhooks, forma de pagamento, comprovante, ciclo de vida, testes, FAQ e solução de problemas. Configuração por telas, sem programação.
A integração CVCRM × Pagadoria de Comissões conecta o seu CVCRM ao Play2sell PAY para emitir o boleto da venda ao comprador e pagar as comissões automaticamente — com boleto, baixa, escrituração e comprovante refletidos de volta no seu CVCRM. A configuração é feita por telas, sem programação, e leva cerca de 15 minutos.
Gerar um token de API, criar 3 webhooks e garantir que a comissão use forma de pagamento Boleto.
2
No painel Play2sell
Conectar o CVCRM (credenciais + mapeamento de situações) e copiar a URL de webhook.
Passo
O que você faz
Resultado
1
Gera um token no CVCRM
a credencial de API da conexão
2
Conecta o CVCRM no painel Play2sell
integração configurada
3
Copia a sua URL de webhook
o endereço para o CVCRM avisar o Play2sell
4
Cria 3 webhooks no CVCRM
o CVCRM passa a notificar cada evento
5
Testa com uma venda
confirma o fluxo ponta a ponta
Pré-requisitos
Acesso administrativo ao gestor do seu CVCRM (suaempresa.cvcrm.com.br/gestor).
Um usuário de API dedicado (o CVCRM recomenda chamá-lo de “Integração”, para o histórico ficar atribuível). Se for usar o comprovante de repasse (Passo 2.4), esse usuário precisa ser gestor com senha de acesso ao painel.
As situações (status) que você usa para venda, escriturar e cancelamento/distrato já configuradas no CVCRM.
Play2sell PAY habilitado na sua conta (em dúvida, fale com o suporte).
O CVCRM é a fonte da verdade da venda, das partes, do split de comissão e da escrituração. O Play2sell PAY emite o boleto ao comprador, custodia os recursos e distribui as comissões. Os dois sistemas ficam em sincronia por webhooks (o CVCRM avisa quando algo muda) e write-backs (o Play2sell informa o resultado de volta no CVCRM).
1
O CVCRM cria o contrato
Ao registrar a venda, o CVCRM tem o valor, os beneficiários, o número de parcelas e os vencimentos.
2
O Play2sell emite o boleto
O Play2sell origina a venda e emite um boleto (com Pix) ao comprador.
3
O boleto volta para o CVCRM
O boleto emitido é gravado de volta na comissão da reserva (situação “Programado”).
4
Comprador paga → o CVCRM recebe a baixa
Na confirmação do pagamento, o Play2sell informa o status pago de volta ao CVCRM.
5
O CVCRM escritura → o repasse é liberado
Quando a comissão é escriturada, o Play2sell libera e distribui o repasse aos beneficiários.
6
O Play2sell paga e anexa o comprovante
Repasse via PIX a cada beneficiário; o comprovante é anexado à comissão no CVCRM. Em distrato, o valor é estornado.
Sincronização segura. Os webhooks do CVCRM são magros — carregam apenas um identificador (ex.: {"idreserva": 123}). O Play2sell usa esse aviso só como gatilho e busca o registro completo de volta na API do CVCRM, autenticado, antes de agir. Por isso um webhook forjado não injeta dado.
Identidade é por CPF/CNPJ, nunca por e‑mail. Compradores e beneficiários são resolvidos pelo documento. Garanta que corretores, imobiliária e demais beneficiários tenham CPF/CNPJ preenchido no CVCRM.
Passo 1 — Obter as credenciais no CVCRM (e‑mail + token)
A conexão precisa de três valores do seu CVCRM: domínio, e‑mail e token.
1
Abra Usuários Administrativos
No gestor do CVCRM, clique na engrenagem ⚙ (canto superior direito) e vá em Usuários Administrativos.
2
Abra as opções do usuário de integração
Localize o usuário de integração na lista e, em Opções, escolha Tokens.
Gestor CVCRM → Usuários Administrativos → lista de usuários
3
Gere e copie o token
Preencha a Descrição (ex.: Play2sell), escolha a Validade do Token e clique em Gerar token. O token aparece na Listagem de Tokens — em Ações → Copiar Token, copie-o.
Tela de Tokens — gerar e, em Ações → Copiar Token, copiar
4
Anote o e‑mail e o domínio
E‑mail: o e‑mail do usuário administrativo (precisa pertencer ao mesmo domínio do CVCRM).
Domínio: o subdomínio da sua conta — a parte antes de .cvcrm.com.br (ex.: em suaempresa.cvcrm.com.br, o domínio é suaempresa).
Você tem em mãos domínio, e‑mail e token — os três valores do Passo 2.
O token é sensível — trate como uma senha. Para trocá-lo depois, gere um novo no CVCRM e atualize a conexão no painel Play2sell.
Aqui você diz ao Play2sell qual situação do seu CVCRM corresponde a cada ação. Informe o nome (ou o id) da situação, exatamente como aparece no seu CVCRM.
Campo
Quando usar
Ação que dispara
Vendida
Situação da reserva que indica venda confirmada.
Origina a venda e emite o boleto.
Escriturada
(Opcional) Situação da reserva quando a escrituração é registrada na própria reserva.
Libera o repasse.
Distrato
(Opcional) Situação da reserva de cancelamento/distrato.
Estorno.
Escriturada (via comissão)
Use quando a escrituração no seu CVCRM é uma situação da comissão (ex.: “Escriturar”), e não da reserva.
Libera o repasse.
Cancelada (via comissão)
(Opcional) Situação da comissão que dispara distrato/estorno.
Estorno.
Use o label exato da sua instância. As situações são configuráveis e mudam de empresa para empresa — “Vendida”, “Venda Realizada”, “Aprovada” etc. Copie o texto como ele aparece no seu CVCRM.
Muitas operações registram a escrituração na comissão (situação “Escriturar”), não na reserva. Nesse caso, deixe Escriturada em branco e preencha Escriturada (via comissão).
O write-back é quando o Play2sell informa o resultado de volta no CVCRM. Estes campos dizem qual situação o seu CVCRM deve assumir em cada evento. São opcionais.
Campo
Significado
Exemplo
Comissão com boleto
Situação do pagamento da comissão quando o boleto é emitido.
Programado
Comissão paga
Situação do pagamento da comissão quando há baixa (pago).
Pago
Para a situação de saída, prefira sempre o nome (ex.: Programado, Pago) em vez do id. Os ids da situação de pagamento variam por instância e podem cair em valores enganosos.
Faz o Play2sell anexar o comprovante de pagamento (PDF) à comissão no CVCRM quando o repasse é pago. É opcional e exige login de gestor no CVCRM.
Campo
O que informar
Tipo do comprovante
O nome do tipo de arquivo cadastrado no seu CVCRM (ex.: Comprovante_Play2sell).
Senha de gestor
A senha do usuário gestor do CVCRM (o mesmo e‑mail de integração).
Credenciais que o comprovante exige. O anexo usa a API v3 do CVCRM, que — diferente do resto da integração (que usa o token) — faz login com e‑mail + senha no painel do gestor. Portanto:
O e‑mail de integração (Passo 2.1) precisa ser de um usuário gestor que entre no painel do CVCRM com senha.
Informe a senha desse usuário no campo Senha de gestor.
O acesso é renovado automaticamente — você não atualiza nada periodicamente. Se trocar a senha no CVCRM, atualize-a aqui também.
O tipo de comprovante precisa existir antes no seu CVCRM, e o nome aqui tem que ser idêntico ao cadastrado lá. Veja como criá-lo no Passo 4.2. Sem essa configuração, todo o resto funciona — só o anexo do comprovante não acontece.
Traduza o tipo de comissão do seu CVCRM para o papel do beneficiário no Play2sell. À esquerda, o texto como vem do CVCRM (ex.: Corretor); à direita, o papel: VENDEDOR, IMOBILIARIA, HOUSE, GERENTE, COORDENADOR ou PARCEIRO. Use ”+ Adicionar papel” para incluir quantos precisar.Clique em Conectar para salvar.
O CVCRM aparece como conectado no painel e abre a tela “CRM conectado” com a sua URL de webhook.
Ao clicar em Conectar, o Play2sell provisiona automaticamente o endpoint de recebimento e mostra a tela “CRM conectado” com a sua URL de webhook e um botão de copiar. Copie essa URL — você vai colá-la no CVCRM no próximo passo.
A URL é única da sua conta. Para recuperá-la depois, vá em Integrações → Endpoints — é onde os endpoints de webhook ficam listados.
Integrações → Endpoints — onde a URL fica disponível depois
Você tem a URL de webhook copiada — pronta para colar no CVCRM.
Você vai criar 3 webhooks — todos apontando para a mesma URL (a do Passo 3). O que muda em cada um é a Funcionalidade e a situação do gatilho:
#
Funcionalidade
Situação do gatilho (exemplo)
Campo no painel (Passo 2.2)
O que dispara
1
Reserva
venda / enviar à pagadoria
Vendida
originação + emissão do boleto
2
Comissão
escriturar
Escriturada (via comissão)
libera o repasse (PIX)
3
Comissão
cancelamento
Cancelada (via comissão)
cancela o boleto não pago / estorna o pago
Para cada um, clique em ”+ Criar novo Webhook” e preencha o formulário:
Campo do CVCRM
O que informar
Nome
Um rótulo claro, à sua escolha (ex.: Pagadoria — venda).
Funcionalidade
Reserva (webhook 1) ou Comissão (webhooks 2 e 3).
Workflow
Aparece quando a Funcionalidade tem mais de um fluxo de situações. Em Comissão há mais de um workflow — escolha o que contém a situação do gatilho (“Escriturar” / “Cancelada”); na dúvida, abra o seletor e veja em qual workflow a situação aparece. Em Reserva normalmente há só um.
Gatilho
A situação que dispara o envio. Use o label exato da sua instância (a mesma do Passo 2.2).
Forma de envio
Deixe o padrão.
Endereço
Cole a URL de webhook copiada no Passo 3.
Ativo no painel
Deixe ativo — sem isso, o webhook não dispara.
Cadastro de um novo webhook no CVCRM
1
Webhook 1 — Originação (obrigatório)
Funcionalidade Reserva, na situação que marca a venda / o envio para a pagadoria (a mesma do campo Vendida, Passo 2.2). Faz o Play2sell originar a venda e emitir o boleto.
2
Webhook 2 — Escrituração → libera o repasse (obrigatório)
Funcionalidade Comissão, na situação que indica escriturar/liberar — ex.: “Escriturar” (a mesma do campo Escriturada (via comissão), Passo 2.2). Libera o repasse e paga os beneficiários via PIX.
3
Webhook 3 — Cancelamento / Distrato (recomendado)
Funcionalidade Comissão, na situação de cancelamento — ex.: “Cancelada” (a mesma do campo Cancelada (via comissão), Passo 2.2). Cancela o boleto não pago ou estorna o pago, conforme o estado.
Vincule os webhooks ao usuário de integração (“Integração”) — assim as alterações feitas pela automação ficam atribuíveis no histórico do CVCRM.
Variação por instância. Se o seu CVCRM registra a escrituração ou o cancelamento na própria reserva (e não na comissão), crie os webhooks 2 e 3 com Funcionalidade Reserva e, no Passo 2.2, use os campos Escriturada e Distrato em vez dos “(via comissão)”. O comportamento é o mesmo.
Confirme que os 3 webhooks estão disparando. Na lista de webhooks, a coluna Transações conta cada envio. Se continuar 0 depois de mover um registro para a situação do gatilho, revise: a Funcionalidade, a situação (deve bater com o Passo 2.2), se o webhook está Ativo no painel e se o Endereço é a URL exata do Passo 3 (sem espaços).
Faça isto apenas se você habilitou o Comprovante de repasse no Passo 2.4. É uma configuração única que cria o tipo de arquivo usado para anexar o PDF do comprovante à comissão.No gestor do CVCRM, vá em Configurações → Tipos de Arquivos de Pagamento Comissão, clique em ”+ Criar novo Tipo” e preencha:
Campo
O que informar
Nome
O nome do tipo (ex.: Comprovante_Play2sell). Use exatamente este nome no campo “Tipo do comprovante” do Passo 2.4.
Ativo no painel
Ativo.
Tipo Pessoa
Física / Jurídica.
Obrigatório
Não — o Play2sell anexa o comprovante automaticamente.
CVCRM → Tipos de Arquivos de Pagamento Comissão → Criar novo Tipo
Para o boleto emitido pelo Play2sell aparecer como o recebível da comissão (e dar baixa corretamente), os pagamentos da comissão no CVCRM precisam usar a forma de pagamento “Boleto”.Para conferir: em Financeiro → Comissões, abra uma comissão e clique no ícone $ (Pagamentos). Na seção Pagamentos, cada parcela do beneficiário tem a coluna “Forma de pagamento” — ela deve estar como Boleto.
Se a parcela estiver com outra forma (ex.: “Transferência bancária”), o boleto que emitimos não casa com a comissão. Ajuste a forma para Boleto na regra/condição de comissão do seu CVCRM.
Comissão → Pagamentos: cada parcela com Forma de pagamento = Boleto (situação “Programado” após a emissão)
4.4 — Escolher quem entra no boleto (“Enviar para Pagadoria”)
Na regra de comissão do CVCRM, cada comissionado tem o campo Enviar para Pagadoria (Sim ou Não). É ele que decide quem o Play2sell cobra e paga.Para conferir: em Financeiro → Configuração de Comissões → Regras da comissão, abra a linha do comissionado em Editar e veja o campo Enviar para Pagadoria.
Como está a regra
O que o Play2sell faz
Pelo menos um comissionado com Sim
Origina a venda. O boleto de cada vencimento é a soma das comissões marcadas com Sim.
Comissionado com Não
Fica fora do boleto e não recebe pelo Play2sell na escrituração. Você paga esse comissionado por fora.
Todos com Não
Nenhum boleto é emitido. A reserva aparece como Nada a cobrar no painel — não é erro.
Exemplo. Comissão total de R10.000comtre^scomissionados:oprimeirorecebeR 5.000 (Sim), o segundo R2.000(∗∗Na~o∗∗)eoterceiroR 3.000 (Sim). O boleto do comprador sai de R$ 8.000, e na escrituração só o primeiro e o terceiro recebem.
No máximo 6 comissionados com “Sim” por vencimento. A regra pode ter mais comissionados que isso, desde que só até 6 estejam com Sim em cada vencimento.
Mudou a opção depois que a reserva passou? Editar “Enviar para Pagadoria” no CVCRM não avisa o Play2sell. Depois de ajustar, use Gerar boleto no painel — veja Como reprocessar uma reserva em Solução de problemas.
Quando o mesmo comissionado aparece em mais de uma linha da regra (por exemplo, comissão e prêmio), deixe todas as linhas dele com a mesma opção. Com uma linha em Sim e outra em Não, o Play2sell não tem como saber qual parcela cobrar e não emite o boleto.
Não. Toda a configuração é feita por telas, no gestor do CVCRM e no painel do Play2sell. Você só precisa de acesso administrativo aos dois sistemas. Nenhum código é necessário.
Quais webhooks o CVCRM precisa ter?
Três, todos apontando para a mesma URL: (1) Reserva na situação de venda → originação; (2) Comissão na situação “Escriturar” → libera o repasse; (3) Comissão na situação de cancelamento → estorno.
Como o valor da comissão é calculado?
O CVCRM mostra a comissão bruta. O Play2sell aplica a taxa de serviço (em geral 1–3%) e o beneficiário recebe o líquido via PIX. O cálculo usa o valor da comissão, não o da venda.
A integração funciona com comissão menor que 100% da venda?
Sim. O boleto e o split são calculados sobre o valor da comissão, então qualquer percentual funciona.
Em quanto tempo o corretor recebe?
Após a comissão ser escriturada no CVCRM, o repasse via PIX é processado em segundos e cai na conta do beneficiário.
O comprovante de repasse é obrigatório?
Não, é opcional. Sem ele, o repasse é pago normalmente; apenas o anexo do PDF na comissão do CVCRM não acontece.
Verifique no CVCRM: o webhook está Ativo? A Funcionalidade (Reserva/Comissão) e a situação do gatilho batem com o que você mapeou no painel? O Endereço é a URL exata copiada no Passo 3 (sem espaços/quebras)?
O boleto não apareceu na comissão
Confirme que a forma de pagamento da comissão é Boleto (Passo 4.3) e que a situação de saída “Comissão com boleto” está preenchida (ex.: Programado). Depois de ajustar a configuração, use Gerar boleto no painel (veja Como reprocessar uma reserva, abaixo).
A reserva ficou como "Nada a cobrar"
Todos os comissionados da regra estavam com Enviar para Pagadoria = Não quando a reserva chegou, então não havia o que cobrar. Se era para cobrar, mude para Sim os comissionados certos (Passo 4.4) e use Gerar boleto no painel.
Como reprocessar uma reserva
No painel Play2sell, vá em Integrações → Geral, no cartão Integração CRM/ERP, e abra Eventos recentes. Nas linhas de reserva com status Falha ou Nada a cobrar aparece a ação Gerar boleto.Ao confirmar, o Play2sell lê a reserva no CVCRM como ela está agora e emite o boleto com as comissões marcadas com Sim — mesmo que a reserva já tenha saído da situação que gera o boleto. Se a reserva estiver em situação de distrato, vale o distrato. A ação aparece para quem tem permissão de gerenciar pagamentos.
Um beneficiário não foi encontrado / repasse não saiu
A identidade é por CPF/CNPJ, nunca por e‑mail. Garanta que o documento do beneficiário está preenchido e correto no CVCRM.
O status pago não refletiu na hora
Confirmações de pagamento e write-backs podem levar alguns instantes. Se persistir, fale com o suporte.
Esta seção é para times técnicos. A configuração acima não exige nada daqui.
Famílias de API do CVCRM
Família
Uso
Observação
v1 (/api/v1/<módulo>/*)
Atual — usada pela integração
Auth por headers email + token; 200 req/min
CVIO (/api/cvio/*)
Legado
Em depreciação — o CVCRM está padronizando para v1
CVDW (/api/v1/cvdw/*)
BI / data warehouse
Contrato pago à parte; 20 req/min; retorna 403 se não contratado
Sincronização e idempotência
Webhook magro → pull-back: o webhook carrega só um id; o Play2sell busca o registro completo via GET autenticado antes de agir.
Idempotência: cada contrato mapeia para uma chave estável derivada do id da reserva (cvcrm:{idreserva}); reentrega nunca duplica a venda.
Ordem: se a escrituração chega antes de a originação concluir, é adiada e reprocessada.
Atenções (gotchas)
O CVCRM pode retornar HTTP 200 com codigo:404 no corpo para rotas inexistentes — sempre confira o campo codigo, não só o status HTTP.
Filtros de data em alguns endpoints são ignorados — janele no lado do cliente.
Datas no GET de parcelas usam DD/MM/AAAA.
Existem dois workflows de situação distintos — o da comissão e o do pagamento da comissão — com ids que podem colidir. Por isso o write-back de situação usa o nome (“Programado”/“Pago”), não o id.
Precisa de ajuda para mapear as situações da sua instância? Fale com o suporte em suporte@play2sell.com com o seu domínio e a lista de situações que você usa para vendida / escriturar / distrato.
