Introdução

O Gateway de Pagamentos da 4all é um intermediário entre o comerciante e o adquirente, fornecendo um meio seguro de trafegar dados das transações e permitindo a integração de diferentes adquirentes com apenas uma API (Application Programming Interface).

Além de robusto e confiável o Gateway de pagamentos 4all está em conformidade com PCI-DSS. Desde de 2017 a 4all segue certificando-se no nível mais alto de de segurança de acordo com a organização.

Visão geral

Comunicação com o gateway

A API do gateway só pode ser acessada com o uso do protocolo TLS 1.2 ou posterior. O certificado fornecido pelo servidor deve ser inspecionado a cada nova conexão, para confirmar que se trata de um certificado confiável.

Definições

Estabelecimento Comercial (EC)

O estabelecimento comercial, denominado EC, é o publico alvo deste gateway.

Cadeia de Pagamento

Para realizar um pagamento, existe toda uma cadeia onde cada um dos elos se comunica com o próximo.

Chave de autenticação

O acesso à API é restrito aos estabelecimentos comerciais cadastrados, sendo necessário informar, em cada conexão, a chave de autenticação fornecida na interface de gerenciamento. A duração da chave é indeterminada, somente perdendo a validade caso a conta do estabelecimento comercial seja desativada na interface de gerenciamento. Esta chave é disponibilizada pela 4all após a conclusão do cadastro.

Json sobre https

Atualmente, a única forma de comunicação suportada é o JSON sobre HTTPS. Os dados devem estar codificados no formato UTF8. Os headers HTTP devem indicar ContentType como application/json. O header ‘Accept’ deve ser usado e deve indicar application/json.

Chamadas

Muitas chamadas para a Gateway transmitem dados sensiveis, como a chave particular de autenticação do estabelecimento comercial. Por este motivo, essas chamadas em que houverem dados sensiveis, deverão ser feitas via SERVER SIDE.

Na descrição de todas as rotas será informado os tipos de chamadas que podem ser feitas para as mesmas, visando proteger os dados que não devem ser vazados, como a merchantKey.

Parâmetros das Requisições e Repostas

O tamanho dos parâmetros pode ser fixo ou variável e segue as seguintes regras:

• String, URL e Datetime : tamanho medido em caracteres UTF8;
• Number : Valores numéricos;
• Object : Não possui tamanho.

Respostas de Sucesso

Respostas de sucesso apresentam status HTTP 200 quando possuírem conteúdo, e status HTTP 204 quando não possuírem conteúdo.

Respostas de Erro

Respostas que indicam erros podem ser identificadas pelo código de status HTTP 4xx (client error) ou 5xx (server error). O corpo da resposta de erro sempre contém um código de erro e uma mensagem descrevendo o motivo do erro ter ocorrido.

Adquirentes

O Gateway da 4all tem integração com as principais adquirentes do mercado como:

• Cielo;
• Getnet;
• Rede;
• Stone/Pagar.me.