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)'
};

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)
};

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

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.

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.

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.