Visão Geral
A API Pública Avista é uma plataforma completa para integração com serviços de pagamento PIX e gestão de contas. Nossa API permite que você:- Gere cobranças PIX dinâmicas para recebimento
- Realize pagamentos PIX para qualquer chave
- Consulte saldos em tempo real
- Gerencie estornos de transações
- Integre pagamentos instantâneos em sua aplicação
Ambientes
Desenvolvimento
Produção
Autenticação
Todos os endpoints da API (exceto o de geração de token) requerem autenticação via Bearer token. O processo de autenticação segue o padrão OAuth 2.0 com certificado X.509:1
Obtenha suas credenciais
Solicite seu
clientId e clientSecret através do portal Avista2
Configure seu certificado X.509
Instale o certificado cliente fornecido em seu ambiente
3
Gere o token de acesso
Use o endpoint
/api/auth/token com suas credenciais e certificado para gerar um token Bearer4
Utilize o token
Inclua o token no header
Authorization: Bearer {token} em todas as requisiçõesO token gerado tem validade de 30 minutos e deve ser renovado após esse período.
Códigos de Status HTTP
A API utiliza códigos de status HTTP padrão para indicar o sucesso ou falha de uma requisição:| Código | Significado | Descrição |
|---|---|---|
200 | OK | Requisição bem-sucedida (GET) |
201 | Created | Recurso criado com sucesso (POST) |
400 | Bad Request | Dados inválidos na requisição |
401 | Unauthorized | Token ausente, inválido ou expirado |
404 | Not Found | Recurso não encontrado |
500 | Internal Server Error | Erro interno do servidor |
Formato de Datas
Todas as datas na API seguem o padrão ISO 8601 com timezone UTC:Primeiros Passos
Autenticação
Aprenda a autenticar e obter tokens de acesso
Consultar Saldo
Consulte o saldo da sua conta
Gerar Cobrança PIX
Crie cobranças para receber pagamentos
Realizar Pagamento PIX
Envie pagamentos PIX para qualquer chave
Suporte
Para questões técnicas ou suporte, entre em contato:- Email: [email protected]
- Documentação: https://docs.avista.com.br
- Status da API: https://status.avista.com.br