Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
Tecnologias Homologadas

01. VISÃO GERAL

Permite o PDV integre a algum parceiro antes de receber o pagamento da venda, através do evento "Antes do Pagamento" da Custom API.

02. EXEMPLO DE UTILIZAÇÃO

Caminho

Monitor PDV / Configurações / Configurações de PDVs / Integrações externas / Vendas

Pré-Requisitos e Restrições

Ter acesso ao monitor para realizar as configurações necessárias.

Formas de pagamento diferente de dinheiro configurar para não gerar troco.

Passo a Passo

Configurações no Monitor PDV

Acesse o Monitor PDV de um navegador na URL http://<ipservidor>/monitorpdv. Troque os símbolos maior e menor e o que está entre eles pelo IP do servidor.

Na sequência informe um Usuário e Senha com permissão para acessar a aplicação.

No menu lateral do lado esquerdo, acesse Configurações e depois Configurações de PDV.

Na tela de Configurações de PDVs, no menu superior, informe a Loja, o Segmento e os PDVs que receberão as novas configurações. Em seguida, clique no botão Carregar Parâmetros.

Imagem 1 - Tela de configurações de PDVs.

Acesso o grupo Integrações externas > Vendas.

Escolha uma das 4 integrações disponíveis.

Informe o Código do parceiro.

Home TOTVS Varejo Supermercados > 11 - Antes do pagamento da venda > image-2024-12-9_8-44-27.png Imagem 2 - Código do parceiro.

Acesso o grupo Integrações externas > Antes do pagamento da venda.

Escolha uma das 4 integrações disponíveis.

Configure a URL para gerar a comunicação com o parceiro

Configure a lista de formas de pagamento separado por linha que geraram a comunicação

Home TOTVS Varejo Supermercados > 11 - Antes do pagamento da venda > image-2024-11-1_17-39-45.png

Imagem 01 - Antes do pagamento

Após configurado evento antes do pagamento no passo anterior. Ao realizar um recebimento de alguma cupom, é realizado uma comunicação com o parceiro via Custom API através do evento de antes do pagamento, conforme imagem abaixo:

Home TOTVS Varejo Supermercados > 11 - Antes do pagamento da venda > image-2025-4-10_16-44-45.png

Home TOTVS Varejo Supermercados > 11 - Antes do pagamento da venda > image-2025-4-10_16-48-32.png

Evento também utilizado para integração com Troco Solidário ou Super Troco.

Requisição antes do pagamento:

{
    "Authenticator": null,
    "ClosedSale": null,
    "Event": "cetBefore",
    "Execution": "cetContinue",
    "ID": "001897000030608",
    "Operation": "cotSalePaymentBefore",
    "ParkingTicket": null
}

Resposta antes do pagamento

"payBefore": {
        "idDocument": "12345646",
        "document": "71981526978830",
        "documentType": "cdtCNPJ",
        "solidaryChange": 2,
        "discount": 0,
        "increase": 0
    }

Tabela dos campos retornado pela interação com o parceiro

PARÂMETRO	TIPO	OBRIGATÓRIO	DESCRIÇÃO
idDocument	String	false	Identificação documento parceiro
document	String	false	Documento (CPF ou CNPJ) enviado pelo parceiro
documentType	String	false	Tipo do documento
solidaryChange	Double	false	Valor para adicionar ao valor da forma de pagamento
increase	Double	false	Valor para adicionar ao valor da forma de pagamento
discount	Double	false	Valor para descontos

Exemplo JSON Response recebido do parceiro

{
  "version": 1,
  "sale": {
    "increase": 0,
    "discount": 0,
    "total": 0,
    "header": ,
    "payments": [],
    "paymentChange": ,
    "solidaryChange": ,
    "items": [
      {
        "itemNumber": 1,
        "unitPrice": 0,
        "increasePrice": 0,
        "packingQuantity": 0,
        "quantity": 0,
        "totalPrice": 0,
        "discountPrice": 0.324,
        "status": "sttValid",
        "sellerCode": 0,
        "partitionIncrease": [],
        "partitionDiscount": [
          {
            "price": 0.162,
            "partnerCode": 0,
            "promotionCode": 62,
            "discountAmount": 1
          },
          {
            "price": 0.162,
            "partnerCode": 0,
            "promotionCode": 83,
            "discountAmount": 1
          }
        ]
      }
    ],
    "discountCodes": [],
    "messages": {
      "customer": [
        {
          "text": 
        }
      ],
      "user": [
        {
          "text": 
        }
      ]
    },
    "vouchersPrint": [
      {
        "text":
      },
      {
        "text": 
      }
    ],
    "observation": 
    "partitionIncrease": [],
    "partitionDiscount": [
      {
        "price": 0,
        "partnerCode": 0,
        "promotionCode": 49,
        "discountAmount": 0
      }
    ],
    "taxDocument": ,
    "print": {}
  },
  "pay": ,
  "payBefore": {
    "idDocument": "12345646",
    "document": "71981526978830",
    "documentType": "cdtCNPJ",
    "solidaryChange": 2,
    "discount": 0,
    "increase": 0
  },
  "return": {
    "code": 0,
    "payNumberUnappliedIncentive": 0
  },
  "execution": "cetContinue",
  "interpret": {
    "commandType": "cctPay",
    "messageCommand": ,
    "options": ,
    "value": ,
    "pay": {
      "value": 10,
      "paymentTypes": [],
      "operation": "optPayment",
      "iDPayment": "1234567890"
    }
  },
  "vouchersPrint": [
    {
      "text":
    }
  ]
}

03. TECNOLOGIAS HOMOLOGADAS

O uso do Tipo de Produto em diferentes tecnologias não homologadas, como em Sistema Operacional, Plataforma, Navegadores e outros dispositivos, pode comprometer a segurança dos sistemas e está sujeito a situações não previstas, sem cobertura de suporte.

Tipo de produto	PDV
Sistema Operacional	Linux Windows Desktop
Plataforma	Desktop
Navegador	N/A (não se aplica)
Utilização/Experiência	Aplicações Desktop em geral Aplicações Web em geral