Skip to content

Introdução

Bem-vindo à documentação da API Gateway Finexis Payments! Esta é uma solução completa para integração de pagamentos PIX, oferecendo uma interface simples e segura para processar transações financeiras.

Sobre a API

A Finexis Payments é uma API Gateway que facilita a integração de pagamentos PIX em sua aplicação. Com ela, você pode:

  • 🔐 Autenticação Segura: Sistema de autenticação JWT para garantir a segurança das transações
  • 💳 Cobranças PIX: Crie cobranças e receba pagamentos via PIX
  • 🔄 Transferências PIX: Realize transferências entre contas
  • 📊 Gestão de Contas: Acompanhe saldos, taxas e informações detalhadas
  • 📈 Consultas em Tempo Real: Verifique o status de cobranças e transferências

Informações Gerais

URL Base

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

Formato de Autenticação

Todas as requisições (exceto login) requerem autenticação via Bearer Token (JWT) no header Authorization.

Formato de Resposta

Todas as respostas são retornadas no formato JSON.

Estrutura da Documentação

Esta documentação está organizada nas seguintes seções:

  1. Autenticação: Como autenticar e obter tokens de acesso
  2. Informações da Conta: Consultar dados e informações da conta
  3. Taxas da Conta: Entender as taxas configuradas
  4. PIX - Cobranças: Criar e gerenciar cobranças PIX
  5. PIX - Transferências: Realizar transferências PIX
  6. Fluxo de Trabalho: Guia passo a passo para integração
  7. Referência: Códigos de status, observações e detalhes técnicos

Começando

Para começar a usar a API, siga estes passos:

  1. Autentique-se: Use o endpoint de login para obter seu token de acesso
  2. Explore os Endpoints: Consulte a documentação de cada endpoint para entender os parâmetros necessários
  3. Teste suas Integrações: Use os exemplos fornecidos para testar suas requisições
  4. Siga o Fluxo de Trabalho: Consulte a seção de fluxo de trabalho para entender o processo completo

Próximos Passos

👉 Continue para a seção de Autenticação para começar a integrar a API.

Documentação Finexis Payments