Autenticação

A autenticação é o primeiro passo para utilizar a API Finexis Payments. Todas as requisições (exceto o login) requerem um token de acesso válido.

Visão Geral

O sistema utiliza autenticação baseada em JWT (JSON Web Token). Após realizar o login, você receberá um token que deve ser incluído em todas as requisições subsequentes através do header Authorization.

Endpoint de Login

POST /auth/login

Autentica o usuário e retorna um token de acesso.

URL Completa:

https://app.finexis.com.br/api/v1/gateway/auth/login

Headers:

Content-Type: application/json

Body:

{
  "payload": "4a6f616f3a32366533393932662d366162652d343265622d613964382d333131643263623531396332"
}

Formato do Payload

O payload é uma string codificada no formato username:apikey em hexadecimal.

Exemplo:

• Username: Joao
• API Key: 26e3992f-6abe-42eb-a9d8-311d2cb519c2
• Payload codificado: 4a6f616f3a32366533393932662d366162652d3432...

NOTA: Para encontrar o payload valido da sua conta, você pode acessar seu Painel Principal e navegar até 🔑 Chaves de API e em seguida clique no botão Credenciais. O Payload de autenticação aparecerá para ser utilizada na sessão da API.

INFO

Por padrão, cada token gerado não possui tempo de expiração, porem, recomenda-se que adicione um "tempo de expiração customizado".

Para fazer isso, adicione o item "expires" junto ao payload com o tempo que deseja adicionar (em segundos).

Exemplo

• Caso queira gerar um token com tempo de expiração de 1 hora

{
  "payload": "4a6f616f3a32366533393932662d366162652d343265622d613964382d333131643263623531396332",
  "expires": 3600
}

Resposta de Sucesso (200):

{
  "status": "success",
  "message": "Authenticated successfully",
  "data": {
    "user": {
      "id": 2,
      "name": "Joao",
      "email": "[email protected]",
      "username": "Joao",
      "avatar": null,
      "apikey": "26e3992f-6abe-42eb-a9d8-311d2cb519c2",
      "email_verified_at": null,
      "access_level": "client",
      "is_blocked": false,
      "created_at": "2025-11-16T14:31:53.000000Z",
      "updated_at": "2025-11-18T04:40:10.000000Z"
    },
    "token": "5|oGBgOf7R5F2J4qPbrPgTS6SliV0lr03TaiJqvf2J5f701b21"
  }
}

Usando o Token

Após receber o token, você deve incluí-lo em todas as requisições subsequentes através do header Authorization:

Authorization: Bearer {token}

Exemplo:

Authorization: Bearer 5|oGBgOf7R5F2J4qPbrPgTS6SliV0lr03TaiJqvf2J5f701b21

Importante

• O token é válido por um período determinado. Se receber um erro 401 Unauthorized, você precisará fazer login novamente.
• Mantenha seu token seguro e nunca o exponha em código público ou repositórios.

Próximos Passos

Agora que você tem um token de acesso, você pode:

• Consultar Informações da Conta
• Verificar Taxas da Conta
• Começar a trabalhar com Cobranças PIX