Exibir origem

CONTEÚDO

Visão Geral
Configuração
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. CONFIGURAÇÃO

Caminho : Configurações de PDVs > Integrações externas > Vendas > Integração 001 > Eventos > Antes do pagamento da venda

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

Imagem 01 - Antes do pagamento

Lista de formas de pagamento: Informar numero de formas de pagamentos quebrando por linha que será utilizado pelo parceiro para gerar a integração
URL: Endereço de comunicação. EX: http://endereço de comunicação.com.br:2121
TimeOut de leitura: Tempo de espera do retorno

03. EXEMPLO DE UTILIZAÇÃO

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.

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": null,
        "payments": [
        ],
        "paymentChange": null,
        "solidaryChange": null,
        "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": 71,
                        "discountAmount": 1
                    },
                    {
                        "price": 0.162,
                        "partnerCode": 0,
                        "promotionCode": 3,
                        "discountAmount": 1
                    }
                ]
            }
        ],
        "discountCodes": [
        ],
        "messages": {
            "customer": [
                {
                    "text": "Ganhou 1000 pontos nessa compra\r\n"
                }
            ],
            "user": [
                {
                    "text": "Ganhou 100 pontos nessa compra\r\n"
                }
            ]
        },
        "vouchersPrint": [
            {
                "text": "  CUPOM DESCONTO 1\r\n\r\n   Cupom de 5% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
            },
            {
                "text": "  CUPOM DESCONTO 2\r\n\r\n   Cupom de 10% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
            }
        ],
        "observation": "Voce poderia ter economizado R$ 10,00 de desconto com o Clube",
        "partitionIncrease": [
        ],
        "partitionDiscount": [
            {
                "price": 0,
                "partnerCode": 0,
                "promotionCode": 95,
                "discountAmount": 0
            }
        ],
        "taxDocument": null,
        "print": {
        }
    },
    "pay": null,
    "payBefore": {
        "idDocument": "12345646",
        "document": "71981526978830",
        "documentType": "cdtCNPJ",
        "solidaryChange": 2,
        "discount": 0,
        "increase": 0
    },
    "return": {
        "code": 0,
        "payNumberUnappliedIncentive": 0
    },
    "execution": "cetContinue",
    "interpret": {
        "commandType": "cctPay",
        "messageCommand": null,
        "options": null,
        "value": null,
        "pay": {
            "value": 10,
            "paymentTypes": [
            ],
            "operation": "optPayment",
            "iDPayment": "1234567890"
        }
    },
    "vouchersPrint": [
        {
            "text": "  RECEBO PAGAMENTO, CONVENIO: \r\n\r\n   N. 100, Vlr. Compra: 99,99\r\n"
        }
    ]
}

04. 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