Realizar venda online via API

A API de vendas permite registrar transações envolvendo prospects (clientes potenciais) e membros (clientes registrados), abrangendo a aquisição de serviços, contratos de adesão e aulas experimentais. Ela foi desenvolvida para oferecer flexibilidade e precisão no controle comercial, integrando processos como aplicação de descontos, definição de forma de pagamento (à vista ou parcelado), uso de vouchers e vinculação à filial responsável pela venda.

Cada tipo de venda possui um fluxo específico, determinado pelo status do cliente (prospect ou membro) e pelo tipo de produto adquirido (serviço ou contrato). Este guia apresenta os principais casos de uso, com exemplos práticos e estrutura de payloads, para facilitar a integração correta com a API.

O uso adequado dos campos obrigatórios e opcionais garante que as informações sejam processadas corretamente pelo sistema, otimizando o registro das vendas e a conversão de prospects em membros ativos.

Casos de Uso

Caso 1: Prospect + Serviço

Descrição
Um prospect (potencial cliente) realiza uma compra de um serviço específico. O sistema registra o prospect e o serviço adquirido.

Campos Obrigatórios:

idProspect: Identificação do prospect.

idService: Identificação do serviço adquirido.

payment: Tipo de pagamento (1 para à vista, 5 para parcelado).

idMember: 0 (indica que ainda não é membro).

Exemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 481,
  "payment": 5
}

Fluxo:

Prospect identificado por idProspect.

Serviço associado por idService.

Pagamento registrado em payment.

Se parcelado, usar totalInstallments.

O campo serviceValue pode ser ajustado.

Caso 2: Membro + Serviço

Descrição:
Um membro registrado realiza a compra de um serviço. O sistema associa o serviço ao membro.

Campos Obrigatórios:

idMember: Identificação do membro.

idService: Identificação do serviço adquirido.

payment: Tipo de pagamento.

Exemplo:

{
  "memberData": {
    "idMember": 12345
  },
  "idService": 481,
  "payment": 6
}

Fluxo:

Membro identificado por idMember.

Serviço identificado por idService.

Pagamento registrado.

Parcelamento com totalInstallments, se aplicável.

serviceValue ajustável.

Caso 3: Venda de Contrato para Prospect

Descrição:
Um prospect adquire um contrato de adesão. O sistema registra a venda para o prospect.

Campos Obrigatórios:

idProspect: Identificação do prospect.

idMembership: ID do contrato adquirido.

payment: Tipo de pagamento.

idMember: 0 (não é membro ainda).

Exemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idMembership": 789,
  "payment": 6
}

Fluxo:

Prospect identificado por idProspect.

Contrato identificado por idMembership.

Tipo de pagamento informado.

Parcelamento com totalInstallments, se necessário.

Valor ajustável (serviceValue), possível uso de voucher.

Após compra, prospect se torna membro (idMember atribuído).

Caso 4: Venda de Contrato para Membro

Descrição:
Um membro adquire um contrato de adesão. O sistema associa a venda ao membro.

Campos Obrigatórios:

idMember: Identificação do membro.

idMembership: ID do contrato.

payment: Tipo de pagamento.

Exemplo:

{
  "memberData": {
    "idMember": 12345
  },
  "idMembership": 789,
  "payment": 6
}

Caso 5: Aula Experimental para Prospect

Descrição:
O prospect deseja realizar a inscrição em uma aula experimental, onde o valor é zerado para promover o serviço e gerar interesse. A transação é registrada com um pagamento de valor zero, mas é tratada como uma transação válida no sistema, com o payment definido para 5 (indicando que é um serviço, mesmo sem valor de pagamento).

Campos Obrigatórios:

idProspect: Identificação do prospect.

idService: ID da aula experimental.

payment: 5 (indica serviço gratuito).

idMember: 0.

Campos Opcionais:

idBranch: Se houver múltiplas filiais.

Exemplo:

{
  "memberData": {
    "idMember": 0
  },
  "idProspect": 27473,
  "idService": 101,
  "payment": 5
}

Fluxo:

Prospect realiza inscrição (campo idProspect).

Aula experimental identificada pelo idService.

Pagamento marcado como 5 (zerado).

Venda registrada com idMember: 0.

Recursos Adicionais

1. Adicionando Parcelamento

Se a venda for parcelada, preencha o campo totalInstallments com o número de parcelas.
Por exemplo, para 12 parcelas:

"totalInstallments": 12

Se for pagamento à vista, o campo pode ser:

"totalInstallments": 0

"totalInstallments": 1

2. Adicionando Voucher de Desconto

Se o cliente utilizar um voucher para obter um desconto, insira o código do voucher no campo voucher.
O sistema aplicará o desconto automaticamente ao valor do contrato ou serviço.

"voucher": "MEUDESCONTO123"

3. Alterando o Valor do Serviço (Apenas para serviços)

O campo serviceValue pode ser ajustado caso haja algum desconto, modificação ou outra alteração no valor do serviço.
Se não for informado, o sistema utilizará o valor padrão cadastrado.

"serviceValue": 199.90

4. Escolhendo a Filial da Venda (Token Multifilial)

Se o sistema operar com múltiplas filiais, utilize o campo idBranch para indicar a filial responsável pela venda.
Caso o token de autenticação seja multifilial:

Se idBranchfor informado , a venda será registrada na filial correspondente.

Se idBranchnão for informado , o sistema usará o valor de idBranch do próprio token.

"idBranch": 12

Desejo integrar com a EVO PAY

Realizar venda online via API

Casos de Uso#

Caso 1: Prospect + Serviço#

Caso 2: Membro + Serviço#

Caso 3: Venda de Contrato para Prospect#

Caso 4: Venda de Contrato para Membro#

Caso 5: Aula Experimental para Prospect#

Recursos Adicionais#

1. Adicionando Parcelamento#

2. Adicionando Voucher de Desconto#

3. Alterando o Valor do Serviço (Apenas para serviços)#

4. Escolhendo a Filial da Venda (Token Multifilial)#

Casos de Uso

Caso 1: Prospect + Serviço

Caso 2: Membro + Serviço

Caso 3: Venda de Contrato para Prospect

Caso 4: Venda de Contrato para Membro

Caso 5: Aula Experimental para Prospect

Recursos Adicionais

1. Adicionando Parcelamento

2. Adicionando Voucher de Desconto

3. Alterando o Valor do Serviço (Apenas para serviços)

4. Escolhendo a Filial da Venda (Token Multifilial)