Pular para o conteúdo principal

Comece por Aqui

Bem-vindo à nossa documentação de integração! Este guia foi projetado para levar você do zero à sua primeira requisição na API Seamless em poucos minutos.

Fluxo de Integração​

Para começar a transacionar via PIX, TED ou Boleto, siga os quatro passos fundamentais:

  1. Obtenção de Credenciais: Registro no portal e geração de chaves.
  2. Autenticação: Troca de credenciais por um Bearer Token.
  3. Configuração de Webhooks: Preparação do ambiente para receber notificações.
  4. Primeira Chamada: Execução do primeiro comando na API.

1. Obtenha suas Credenciais​

O acesso às nossas APIs é gerenciado através do Portal do Customer.

  • Acesso: Entre no portal e navegue até a seção de chaves de API.
  • Geração: Clique em "Gerar Credenciais" para obter seu client_id e client_secret.
  • Segurança: Importante! Guarde seu client_secret em um local seguro. Ele ficará parcialmente oculto após o fechamento do modal de geração.

2. Autenticação (OAuth 2.0)​

Utilizamos o padrão OAuth2 com Bearer Tokens. Você deve solicitar um token de acesso enviando suas credenciais para o endpoint de autenticação.

Solicitar Token​

Substitua os campos client_id e client_secret pelos valores obtidos no passo anterior:

curl --request POST \
  --url 'http://seamless-v2.stg.lbpay.com.br/v1/oauth2/token \
  --header 'accept: application/json' \
  --header 'content-type: multipart/form-data' \
  --form client_id=YOUR_CLIENT_ID \
  --form grant_type=client_credentials \
  --form client_secret=YOUR_CLIENT_SECRET

Resposta de Sucesso:

{
  "access_token": "USvx7QZQZXu77q919GKBwjOtLdOJvRH0",
  "token_type": "bearer",
  "expires_in": 7200
}

[!NOTE] Os tokens possuem validade de 2 horas (7200 segundos). Após esse período, uma nova autenticação será necessária.

3. Configure seu Webhook​

Para que seu sistema seja notificado sobre mudanças de status (como um PIX recebido ou boleto pago), você deve cadastrar uma URL de destino:

  1. No Portal do Customer, acesse a aba Webhooks.
  2. Insira a URL do seu servidor que receberá os POSTs de notificação.
  3. Após o cadastro, o sistema ativará o envio de eventos para o seu ambiente.

4. Ambiente de Sandbox​

Antes de ir para produção, utilize nosso ambiente de Sandbox. Ele simula o comportamento real da API com dados fictícios, permitindo que você valide sua integração sem riscos financeiros.

  • Endpoint Sandbox: 'http://seamless-v2.stg.lbpay.com.br/v1/
  • HTTPS Obrigatório: Todas as chamadas devem utilizar criptografia TLS.
  • mTLS: Para endpoints sensíveis, a autenticação mTLS (mutual TLS) será exigida.

Melhores Práticas​

  • Versionamento: A versão atual é indicada na URL (ex: /v1/). Fique atento aos e-mails de notificação sobre depreciação de versões legadas.
  • Compliance: Garanta que sua aplicação esteja em conformidade com a LGPD para o tratamento de dados sensíveis.
  • Retry Logic: Implemente mecanismos de retentativa para chamadas que falharem por limites de taxa (Rate Limiting).