Histórico da Página

CONTEÚDO

1. Visão Geral
2. Configuração
3. Exemplo de utilização
4. Tecnologias Homologadas

...

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 /

...

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

Image Removed

Imagem 01 - Antes do pagamento

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

...

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

Image AddedImagem 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.

Image AddedImagem 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

Image Added

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:

...

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

Requisição antes do pagamento:

"payBefore": {
    "Event": "cetBefore",
    "idDocumentExecution": "12345646cetContinue",
        "documentID": "71981526978830001897000030620",
        "documentTypeOperation": "cdtCNPJcotSalePaymentBefore",
        "solidaryChangePay": 2,{
        "discountDiscount": 0.0000000000000000E+000,
        "increaseIncrease": 0.0000000000000000E+000,
    }

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

...

Exemplo JSON Response recebido do parceiro 

{
    "versionPaymentNumber": 1,
        "salePaymentType": {"cptBillet",
        "increaseThing": 0.0000000000000000E+000,
        "discountTotal": 01.0000000000000000E+001,
    },
    "totalSale": 0,{
        "headerDiscount": null0.0000000000000000E+000,
        "paymentsDiscountCodes": [
        ],
        "paymentChangeDiscountNotApplied": null0.0000000000000000E+000,
        "solidaryChangeHeader": null,{
        "items": [
            {"AccountingDate": "2025-04-11T00:00:00",
                "itemNumberCooDocument": 1480,
                "unitPriceDateTimeIssue": 0"2025-04-11T17:09:13",
                "increasePriceIdDocument": 030620,
                "packingQuantityIdStore": 01,
                "quantityIdTerminal": 0897,
                "totalPriceIdUser": 02,
                "discountPriceStatus": 0.324,"sttValid"
        },
        "statusID": "sttValid001897000030620",
                "sellerCodeIncrease": 0.0000000000000000E+000,
                "partitionIncreaseItems": [
                ],{
                "partitionDiscountBarCode": ["7891000100103",
                    {"CaptionPacking": "UN",
                "Description": "LEITE COND MOCA LATA 395G LEITE COND "price": 0.162MOCA",
                        "partnerCode"DiscountPrice": 0.0000000000000000E+000,
                        "promotionCode"IdSegment": 713,
                        "discountAmountIncreasePrice": 10.0000000000000000E+000,
                    }"InternalCode": "4900",
                    {
        "ItemNumber": 1,
                "pricePackingQuantity": 01.1620000000000000000E+000,
                        "partnerCode"Quantity": 01.0000000000000000E+000,
                        "promotionCode"Status": 3"sttValid",
                        "discountAmountTotalPrice": 13.2400000000000002E+000,
                    }
     "UnitPrice": 3.2400000000000002E+000
           ]
            }
        ],
        "discountCodesTotal": [
        ]3.2400000000000002E+000,
        "messagesTotalSale": {0.0000000000000000E+000,
        },
    "customerVersion": [
                {
                    "text": "Ganhou 1000 pontos nessa compra\r\n"
                }
            ],
            "user": [
    1
}

Resposta antes do pagamento

{
  "version": 1,
  "sale": {
    "items": [
            {
                    "textitemNumber": "Ganhou 100 pontos nessa compra\r\n"
                }
            ]
        }1,
        "vouchersPrintdiscountPrice": [
            {
 0.324,
               "text"status": "  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"
            }sttValid",
            {
                "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""partitionDiscount": [
            }{
        ],
        "observationprice": "Voce poderia ter economizado R$ 10,00 de desconto com o Clube",
 0.162,
            "partitionIncreasepromotionCode": [87,
        ],
        "partitionDiscountdiscountAmount": [1
            {},
                "price": 0,
   {
             "partnerCodeprice": 0.162,
                "promotionCode": 9588,
                "discountAmount": 01
            }
        ],
        "taxDocument": null,}
        "print": {
        }]
    },
    "pay": null,
    "payBefore": {
        "idDocument": "12345646",
        "document": "71981526978830",
        "documentType": "cdtCNPJ",
        "solidaryChange": 2
  },
    "return": {
    "discountskipNextEvents": 0false,
        "increaseclientToken": 0"7ec731ad-c901-4baa-8f87-14e349362797"
    },
  "execution": "cetCompleted"
}

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

Exemplo JSON Response recebido do parceiro 

{
	"version": 1,
	"returnsale": {
        "code		"items": [{
			"itemNumber": 01,
        "payNumberUnappliedIncentive			"discountPrice": 0
    },
    "execution.324,
			"status": "cetContinuesttValid",
    "interpret			"partitionDiscount": [{
        "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"
        }
    ]
}

...

					"price": 0.162,
					"promotionCode": 62,
					"discountAmount": 1
				},
				{
					"price": 0.162,
					"promotionCode": 83,
					"discountAmount": 1
				}
			]
		}],
		"partitionDiscount": [{
			"promotionCode": 49,
		}]
	},
	"payBefore": {
		"idDocument": "12345646",
		"document": "71981526978830",
		"documentType": "cdtCNPJ",
		"solidaryChange": 2,
	},
	"execution": "cetContinue",
	"interpret": {
		"commandType": "cctPay",
		"pay": {
			"value": 10,
			"operation": "optPayment",
			"iDPayment": "1234567890"
		}
	}
}

03. TECNOLOGIAS HOMOLOGADAS

...