Objetivo

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.

Informações para Requisição (Request Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO

TIPO

OBRIGATÓRIO

DESCRIÇÃO

AuthenticatorObject JsonSim

Grupo com os dados para autenticação

Authenticator.HeaderObject JsonSim

Grupo com os dados do cabeçalho

Authenticator.Header.DescriptionStringSim

Descrição da rotina a ser liberada

Authenticator.Header.IdStoreIntegerSim

Código da loja

Authenticator.Header.IdTerminalIntegerSim

Código do PDV

Authenticator.Header.IdUserIntegerSim

Código do usuário (operador de caixa)

Authenticator.Header.MethodStringSim

Rotina a ser liberada

Authenticator.Header.MethodStatusStringSim

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

Título da rotina a ser liberada

Authenticator.SaleObject JsonSim

Grupo com os dados da venda

Authenticator.Sale.AccountingDateDateSim

Data do documento ou, quando não existir, da transação

Authenticator.Sale.DateTimeIssueDateSim

Data e hora da requisição

Authenticator.Sale.IdDocumentIntegerSim

Código do documento

Authenticator.Sale.ItemsArray object JsonNão

Lista de produto(s) da venda

Authenticator.Sale.Items[0].DescriptionStringSim

Descrição do produto

Authenticator.Sale.Items[0].InternalCodeIntegerSim

Código interno do produto

Authenticator.Sale.Items[0].ItemNumberIntegerSim

Código de sequência do produto

EventStringSim

Tipo de evento da API

ExecutionStringSim

Status da execução

IDStringSim

ID da transação (que será consultando depois no evento GET)

OperationStringSim

Operação que está sendo enviada ("cotAuthenticador" para este evento POST)

VersionIntegerSim

Número da versão

Formatos de Requisição (Request Formats)

application/json

Exemplo (Sample)

{
    "Authenticator": {
        "Header": {
            "Description": "Cancelamento do documento",
            "IdStore": 1,
            "IdTerminal": 301,
            "IdUser": 2,
            "Method": "mtCancelarCupom",
            "MethodStatus": "arNone",
            "MethodTitle": "Autenticacao de usuario"
        },
        "Sale": {
            "AccountingDate": "2023-11-23T00:00:00",
            "DateTimeIssue": "2023-11-23T08:03:41",
            "IdDocument": 122552,
            "Items": [
                {
                    "Description": "AJINOMOTO REFIL 100G",
                    "InternalCode": "7274",
                    "ItemNumber": 1
                },
                {
                    "Description": "ACENDEDOR IMPERIAL TOCA FOGO C/6",
                    "InternalCode": "1825",
                    "ItemNumber": 2
                }
            ]
        }
    },
    "Event": "cetBefore",
    "Execution": "cetContinue",
    "ID": "00130120231123080341",
    "Operation": "cotAuthenticator",
    "Version": 1
}