Utilizar para autênticações dos parceiro em vendas na forma de pagamento convênio.
No momento em que for solicitada a senha do convêniado, se estiver configurado para validar via integração externa, irá enviar ao parceiro informações para que ele valide ou não um código (token) do cliente para que ele digite e finalize a venda
Exemplos : Quando houve a necessidade de validar um token no pinpad.
Veja abaixo exemplo de configuração dos parâmetros :
Configurações > Configurações de PDVs > Autendicações diversas > Autênticações para convênios.
Imagem 01 - Autênticações para convênios.
Lista de formas de pagamento : Iremos configurar uma lista de formas de pagamento que poderá ser validado e autenticado pelo parceiro.
Obter o valor no pinpad: A solicitação irá ser encaminhada para o cliente informar o valor no Pinpad.
URL : Parceiro irá informar o caminho do seu servidor webservice para receber do PDV as solicitações e valores.
Autenticação: Para validação de usuario e senha do webservice criado pelo parceiro para validar e autorizar as respostas para o PDV.
PARÂMETRO | TIPO | OBRIGATÓRIO | DESCRIÇÃO |
---|---|---|---|
UserAuthentication | Object Json | Sim | Grupo com os dados para autenticação |
UserAuthentication.Header | Object Json | Sim | Grupo com os dados do cabeçalho |
UserAuthentication.Header.Description | String | Sim | Descrição da rotina a ser liberada |
UserAuthentication.Header.IdStore | Integer | Sim | Código da loja |
UserAuthentication.Header.IdTerminal | Integer | Sim | Código do PDV |
UserAuthentication.Sale | Object Json | Sim | Grupo com os dados da venda |
UserAuthentication.Sale.AccountingDate | Date | Sim | Data do documento ou, quando não existir, da transação |
UserAuthentication.Sale.DateTimeIssue | Date | Sim | Data e hora da requisição |
UserAuthentication.Sale.IdDocument | Integer | Sim | Código do documento |
UserAuthentication.Sale.Items | Array object Json | Não | Lista de produto(s) da venda |
UserAuthentication.Sale.Items[0].Description | String | Sim | Descrição do produto |
UserAuthentication.Sale.Items[0].InternalCode | Integer | Sim | Código interno do produto |
UserAuthentication.Sale.Items[0].ItemNumber | Integer | Sim | Código de sequência do produto |
UserAuthentication.Sale.CooDocument | Integer | Não | Código do documento da venda |
UserAuthentication.Sale.Document | Integer | Não | Códigos interno da venda (seqdocto) |
UserAuthentication.Sale.IdentificationType | String | Não | Tipo de identificação |
UserAuthentication.Sale.DocumentType | String | Não | CPF ou CNPJ do cliente informado |
UserAuthentication.Sale.AgreementNumber | Integer | Não | Nº do convênio/forma de pagamento |
UserAuthentication.Sale.AgreedNumber | Integer | Não | Código do cliente (Seqpessoa) |
UserAuthentication.Sale.TotalSale | Double | Não | Total da venda |
UserAuthentication.Sale.TotalPay | Double | Não | Valor do pagamento |
Event | String | Sim | Tipo de evento da API |
Execution | String | Sim | Status da execução |
ID | String | Sim | ID da transação (que será consultando depois no evento GET) |
Operation | String | Sim | Operação que está sendo enviada (" |
Response | String | Não | Valor retornado pelo PDV. Este é o valor de retorno digitado lá no pdv pelo cliente |
Version | Integer | Sim | Número da versão |
Exemplo (Sample)
|
Exemplo (Sample)
|
1º - Passo :
2º - Passo : Informa o convêniado :
Identifica o convêniado :
Neste momento, iria ser apresentada a tela de senha para o cliente informar, mas se o parãmetro (Obter o valor no pinpad) tiver habilitado irá apresentar o retorno do parceiro para validar um token.
Se o parâmetro para obter no pinpad estiver ativo, mensagem irá para o PINPAD para solicitar a digitação.
Após digitar o valor e teclar ENTER, o sistema enviará para o parceiro o JSON com a resposta do que foi digitado pelo cliente.
Requisição do Exemplo (Request) com a resposta do que foi digitado :
|
Parceiro trata o retorno e finaliza com um response se estiver de acordo com a venda.
Response do Exemplo (Response) com a resposta cetCompleted:
|