...
PARÂMETRO | TIPO | OBRIGATÓRIO | DESCRIÇÃO |
|---|---|---|---|
| UserAuthentication | Object Json | Sim | Grupo com os dados para autenticação |
| AuthenticatorUserAuthentication.Header | Object Json | Sim | Grupo com os dados do cabeçalho |
| AuthenticatorUserAuthentication.Header.Description | String | Sim | Descrição da rotina a ser liberada |
| AuthenticatorUserAuthentication.Header.IdStore | Integer | Sim | Código da loja |
| AuthenticatorUserAuthentication.Header.IdTerminal | Integer | Sim | Código do PDV |
| Authenticator.Header.IdUser | Integer | Sim | Código do usuário (operador de caixa) |
| Authenticator.Header.Method | String | Sim | Rotina a ser liberada |
Authenticator.Header.M ethodStatus | String | Sim | Status da liberação da rotina solicitada. Legenda: arNone: envio da requisição (inicialização); arPending: requisição pendente; arAuthorized: requisição autorizada pelo fiscal de caixa; arNotAuthorized: requisição negada pelo fiscal de caixa; arCanceled: requisição cancelada (API fora do ar, timeout, usuário cancelou a solicitação, tempo limite atingido, etc). |
| Authenticator.Header.MethodTitle | String | Sim | Título da rotina a ser liberada |
| AuthenticatorUserAuthentication.Sale | Object Json | Sim | Grupo com os dados da venda |
| AuthenticatorUserAuthentication.Sale.AccountingDate | Date | Sim | Data do documento ou, quando não existir, da transação |
| AuthenticatorUserAuthentication.Sale.DateTimeIssue | Date | Sim | Data e hora da requisição |
| AuthenticatorUserAuthentication.Sale.IdDocument | Integer | Sim | Código do documento |
| AuthenticatorUserAuthentication.Sale.Items | Array object Json | Não | Lista de produto(s) da venda |
| AuthenticatorUserAuthentication.Sale.Items[0].Description | String | Sim | Descrição do produto |
| AuthenticatorUserAuthentication.Sale.Items[0].InternalCode | Integer | Sim | Código interno do produto |
| AuthenticatorUserAuthentication.Sale.Items[0].ItemNumber | Integer | Sim | Código de sequência do produto |
| AuthenticatorUserAuthentication.Sale.CooDocument | Integer | Não | Código do documento da venda |
| AuthenticatorUserAuthentication.Sale.Document | Integer | Não | Códigos interno da venda (seqdocto) |
| AuthenticatorUserAuthentication.Sale.IdentificationType | String | Não | Tipo de identificação |
| AuthenticatorUserAuthentication.Sale.DocumentType | String | Não | CPF ou CNPJ do cliente informado |
| AuthenticatorUserAuthentication.Sale.AgreementNumber | Integer | Não | Nº do convênio/forma de pagamento |
| AuthenticatorUserAuthentication.Sale.AgreedNumber | Integer | Não | Código do cliente (Seqpessoa) |
| AuthenticatorUserAuthentication.Sale.TotalSale | Double | Não | Total da venda |
| AuthenticatorUserAuthentication.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 ("cotAuthenticador" para este evento POST) |
| 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)
|
...
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.
...
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.
...