Depois de informar o valor do pagamento e seleciona a forma de pagamento, este evendo irá iniciar a interação com o parceiro via API antes da efetivação do pagamento.
Caminho : Configurações de PDVs > Integrações externas > Vendas > Integração 001 > Eventos > Antes do pagamento da venda
Imagem 01 - Antes do pagamento
O Formato do request enviado para o parceiro é o mesmo do pagamento da venda (03 - Pagamento da Venda).
O Retorno teremos os novos campos para aplicação da venda.
Tabela dos campos retornado pela interação com o parceiro
"payBefore": {
"idDocument": "12345646",
"document": "71981526978830",
"documentType": "cdtCNPJ",
"solidaryChange": 10,
"discount": 0,
"increase": 0}
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": 12,
"status": "sttValid",
"sellerCode": 0,
"partitionIncrease": [],
"partitionDiscount": [
{
"price": 6,
"partnerCode": 0,
"promotionCode": 9,
"discountAmount": 1
},
{
"price": 6,
"partnerCode": 0,
"promotionCode": 88,
"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"
}
],
"partitionIncrease": [],
"partitionDiscount": [
{
"price": 0,
"partnerCode": 0,
"promotionCode": 426,
"discountAmount": 0
}
],
"taxDocument": null,
"print": {
"printType": "cptNone"
}
},
"pay": null,
"payBefore": {
"idDocument": "12345646",
"document": "71981526978830",
"documentType": "cdtCNPJ",
"solidaryChange": 10,
"discount": 0,
"increase": 0
},
"return": {
"code": 0,
"messageText": "0",
"skipNextEvents": false
},
"execution": "cetCompleted",
"interpret": null,
"vouchersPrint": [
{
"text": " RECEBO PAGAMENTO, CONVENIO: \r\n\r\n N. 100, Vlr. Compra: 99,99\r\n"
}
]
}