1 - Cadastrando o meio de pagamento:
- Acesse Configs > Meios de Pagamento > Adicionar meio de pagamento > Pagamento Externo Genérico, e em seguida, na aba Dados Gerais, preencha:
- Nome
- O nome parametrizado aqui, será identificado no admin.
- Status
- Nome
- Salve!
2 - Configuração da Integração:
- Na aba Integrações, preencha:
Campos obrigatórios
- Identificador do lojista (ClientId)
- Informe o código único do lojista fornecido pelo parceiro de pagamento. Esse dado garante a identificação correta da loja junto ao sistema externo.
Chave de autenticação
Código fornecido pelo parceiro, utilizado para validar a comunicação entre a Linx Commerce e a API de pagamento.
Token de autenticação
Token de segurança para autenticação de chamadas, quando exigido pelo parceiro.
URL de criação
Endpoint da API do parceiro responsável por iniciar uma transação de pagamento.
URL de consulta
Endpoint utilizado para consultar o status de uma transação previamente criada.
URL de cancelamento
Endpoint da API para cancelamento de transações.
Moeda
Código da moeda utilizada para a transação, seguindo o padrão ISO 4217 (ex.:
BRL,USD,EUR).
Atenção!
Observações importantes
Todos os campos marcados como obrigatórios devem ser preenchidos corretamente para que a integração funcione.
Os dados de autenticação (ClientId, chave e token) devem ser fornecidos diretamente pelo parceiro de pagamento.
Recomenda-se validar as URLs em ambiente de homologação antes de publicar em produção.
2.1 - Configuração do Pix – GenericExternal
- Na configuração do Pix para o meio de pagamento GenericExternal, os seguintes campos devem ser preenchidos:
Campos obrigatórios
Timeout
Define o tempo máximo (em milissegundos) que a plataforma aguardará a resposta do serviço externo antes de considerar a requisição como expirada.Exemplo comum:
16000(equivalente a 16 segundos).Valor
0pode ser informado para indicar que não haverá timeout, porém essa prática não é recomendada, pois pode gerar filas de pedidos em processamento indefinido.
Tempo para expiração do Pix
Define o período em que o QR Code Pix ou a chave Pix gerada será válido para pagamento.Exemplo:
30min(30 minutos).Após o prazo configurado, o Pix expira automaticamente e o cliente não conseguirá concluir o pagamento utilizando aquele QR Code/identificador.
Atenção!
Boas práticas
Utilize valores de timeout entre 10.000 ms e 20.000 ms (10 a 20 segundos), garantindo equilíbrio entre tempo de resposta e experiência do usuário.
Ajuste o tempo de expiração do Pix conforme o tipo de operação:
30 minutos → indicado para compras online padrão.
5 a 10 minutos → indicado em cenários de alta rotatividade ou conveniência (ex.: farmácias, delivery).
Sempre valide os parâmetros em ambiente de homologação antes de ativar em produção.
3 - Configuração – Aba Personalizados (GenericExternal)
A aba Personalizados permite definir informações adicionais de exibição e regras de parcelamento para o meio de pagamento configurado via GenericExternal.
Campos disponíveis
Número total de parcelas
Define o limite máximo de parcelas que poderá ser oferecido ao cliente no checkout.
Exemplo:
3→ significa que o cliente poderá parcelar em até 3x.
Status
Permite ativar ou inativar a forma de pagamento no checkout.
Ativo → a opção estará disponível para o cliente.
Inativo → a opção ficará oculta, sem necessidade de exclusão da configuração.
Identificador de Integração
Campo utilizado em casos específicos de integração com parceiros que demandem um identificador adicional. Pode permanecer em branco quando não aplicável.
Grupo
Define a categoria em que o pagamento será exibido.
Exemplo: “Pagamento com PIX Parcelado”.
Parceiro
Seleção do parceiro de pagamento vinculado a esta configuração: - Necessário salvar as informações da aba "Dados Gerais", para que haja retorno desse dado.
Exemplo:
PagaLeve.
Ordem
Define a posição em que o meio de pagamento será exibido na tela de checkout, quando houver múltiplas opções.
Exemplo:
1→ aparecerá como a primeira opção.
Caminho Imagem
Nome do arquivo da imagem/ícone exibido no checkout.
Exemplo:
fp_external.gif.- Verifique a imagem ou faça upload da mesma em: Menu Aparência → Gerenciador de Arquivo → Shared → Images → Payment
Descrição
Texto descritivo que aparece no painel administrativo e pode ser usado como referência interna.
Exemplo: “Pagamento genérico externo”.
Título
Nome que será exibido ao cliente no checkout como identificação da forma de pagamento.
Exemplo: “Pagamento genérico externo”.
Alias
Identificador interno do meio de pagamento dentro da plataforma. Usado em regras técnicas.
Exemplo:
fp_genericexternal.
Atenção!
Boas práticas
Utilize títulos e descrições claros e amigáveis, pensando na experiência do cliente no checkout.
Configure a ordem de exibição de acordo com a prioridade da loja (ex.: Pix e Cartão podem aparecer antes de Boleto).
Verifique se a imagem do meio de pagamento (ícone) está em formato leve (GIF/PNG) para garantir carregamento rápido.
Caso use parcelamento, alinhe previamente com o parceiro de pagamento as regras de juros e condições aplicáveis.

