Realizando Autenticação

Realizando a autenticação

Antes de realizar seus pagamentos será necessário autenticar o seu PDV, para isso a API disponibiliza a função authenticate.

Callback

Nosso Paykit Checkout tem callbacks de forma sincrona, ou seja, espere a resposta antes de prosseguir.

var authenticationRequest = {
    authenticationKey: 'INFORME O CNPJ DA LOJA CONFIGURADA NO PAYKIT (somente os números)'
    backgroundInteraction: '(OPCIONAL) INFORME O NOME DA FUNÇÃO CRIADA PARA PROCESSAR OS CALLBACKS DE TELA'
    autoConfirm: true
};

var success = function(response) {
    // callback para autenticação bem sucedida
    console.log(response.reason);
};

var error = function(response) {
    // callback para autenticação que falhou
    console.log(response.reason);
};

var handlePendingPayments = function(response) {
    // callback para notificação de transações pendentes
    console.log(response.details.administrativeCodes)
};

var handleScreenReceived = function (msgScreenCallback) {
  console.log(msgScreenCallback.data.requestType);
}

// instância do WebCheckout
var checkout = PaykitCheckout.authenticate(authenticationRequest, success, error, handlePendingPayments, handleScreenReceived);

Essa função retorna uma instância do Paykit Checkout, através dela você terá acesso a todas as funções disponibilizadas pela API, que estão descritas nas outras seções desse documento. Obs.: O parâmetro 'handleScreenReceived' só deve ser enviado quando a automação for utilizar as suas telas para exibir e coletar informações do Paykit, quando isto não ocorrer deve ser enviado um parametro nulo

Request para autenticação

Parâmetro	Obrigatório?	Tipo	Descrição
authenticationKey	Sim	string	É o CNPJ da loja que está utilizando o TEF Linx, precisa ser equivalente ao que está configurado no Paykit Checkout.
backgroundInteraction	Não	function	Quando este elemento estiver presente ele deve apontar para uma função que irá processar os callbacks de tela, ver a seção Integração sem telas.
autoConfirm	Não	bool	Habilita ou desabilita a confirmação automática das transações financeiras ao final da sessão de pagamento. Caso não seja informado a confirmação automática será habilitada por padrão

Sincrono

Aguarde o callback antes de prosseguir

Callback de sucesso

Será executado o callback de sucesso quando a autenticação for bem sucedida, através dele será passado os seguintes parâmetros:

Propriedade	Tipo	Descrição
authenticated	bool	Confirmação da autenticação efetuada com sucesso.

Exemplo de retorno

{
    "authenticated": true
}

Callback de erro

Será executado o callback de erro caso ocorra algum erro de processamento:

Para detalhamento dos dados consulte a seção Callback de erro.

Callback de transações pendentes

Será executado o callback de transações pendentes caso a última sessão de múltiplos pagamentos tenha ficado em aberto. Para detalhamento do funcionamento e dos dados de retorno consulte a seção Callback de transações pendentes.

Callback de coleta e exibição de dados na tela da automação

Será executado o callback com a solicitação para exibição ou coleta de dados na tela da automação necessários para execução de uma transação solicitada, a seção Callback de mensagens de tela detalha este callback.