A API LivePix foi construida utilizando tecnologias atuais, provendo segurança e padronização.

Para garantir o uso justo da API, cada endpoint é protegido por um limite de requisições que reseta a cada minuto. Se você ultrapassar o limite máximo de chamadas no mesmo minuto para um mesmo endpoint, a API passará a retornar HTTP 429 Too Many Requests até que o limite seja resetado no próximo minuto.

Para saber qual o limite de cada endpoint, verifique o valor do header X-RateLimit-Limit na resposta do endpoint.

A API LivePix utiliza OAuth2 para gerenciar as permissões de acesso a API. Você pode se autenticar utilizando suas credenciais de cliente ou como um usuário terceiro através do fluxo de autorização.

Crie uma aplicação nas configurações da sua conta para obter o client_id e client_secret necessários para os passos abaixo.

Para autenticar na sua própria conta, você pode utilizar o grant client_credentials:

POST https://oauth.livepix.gg/oauth2/token
grant_type=client_credentials&client_id=<id do cliente>&client_secret=<segredo do cliente>&scope=<permissoes>

A requisição acima deve retornar o token de acesso para a conta conforme o exemplo abaixo:

{
  "access_token": "...",
  "expires_in": 3600,
  "scope": "account:read wallet:read webhooks",
  "token_type": "bearer"
}

Para solicitar permissão para acessar uma conta de terceiro, siga o fluxo de autorização abaixo:

• Redirecione o usuário para a URL abaixo (substitua os parâmetros pelos configurados na sua aplicação):

https://oauth.livepix.gg/oauth2/auth?client_id=<id do cliente>&redirect_uri=<url de redirecionamento>&response_type=code&scope=<permissoes>&state=<state>

O usuário será direcionado para uma página onde revisará as permissões solicitadas e poderá aprovar ou não a conexão.

• Após o usuário aprovar, o usuário será redirecionado para a URL configurada no parâmetro redirect_uri com um parâmetro code na URL que será utilizado no passo a seguir.

• Utilize a requisição abaixo para trocar o token recebido no parâmetro code por um token de acesso que será utilizado para requisitar a API:

POST https://oauth.livepix.gg/oauth2/token
grant_type=authorization_code&client_id=<id do cliente>&client_secret=<segredo do cliente>&code=<valor do parametro code>&redirect_uri=<url de redirecionamento>

A requisição acima deve retornar o token de acesso para a conta conforme o exemplo abaixo:

{
  "access_token": "...",
  "expires_in": 3600,
  "scope": "account:read wallet:read webhooks",
  "token_type": "bearer"
}

Você deve utilizar os tokens emitidos até sua expiração para evitar chamadas desnecessárias ao servidor OAuth. Nossa equipe monitora constantemente a atividade em nossa API e caso seja detectado uso incorreto da emissão de tokens, a conta poderá ser encerrada.

Você pode configurar uma URL para receber notificações de mensagens e assinaturas recebidas.

Ao receber uma mensagem ou assinatura, a URL configurada será chamada com as informações do evento no corpo da requisição. Se a primeira chamada falhar, a URL será chamada a cada 10 minutos até que a mesma retorne uma resposta de sucesso (HTTP 200) em até 24 horas.

Por segurança, apenas algumas informações básicas são enviadas a URL configurada no webhook. Para obter todos os detalhes da mensagem ou assinatura, você deve realizar uma chamada a API.

Endpoints para interagir com os dados da conta do usuário

Endpoints para interagir com os pagamentos recebidos e iniciar novos pagamentos

Endpoints para interagir com as mensagens recebidas e iniciar o envio de novas mensagens

Endpoints para interagir com as assinaturas recebidas e planos de assinatura e iniciar o envio de novas assinaturas

Endpoints para interagir com as recompensas do usuário

Endpoints para interagir com as configurações de moedas do usuário

Endpoints para interagir com a carteira do usuário

Endpoints para configurar os webhooks do usuário