Introdução à API
Visão Geral
A API Pública FyPay é 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
- Realize pagamentos PIX via QR Code
- Consulte saldos em tempo real
- Gerencie estornos de transações
- Integre pagamentos instantâneos em sua aplicação
Ambiente
Produção
| Recurso | URL |
|---|---|
| URL base da API | https://api.fypay.me/api |
| Health check | GET https://api.fypay.me/health |
| Painel | https://banking.fypay.me |
Todos os endpoints da API ficam sob o prefixo /api (por exemplo, https://api.fypay.me/api/balance). O health check é a única rota fora desse prefixo.
Autenticação
Todos os endpoints da API (exceto o de geração de token) requerem autenticação via Bearer token. O token é obtido com suas credenciais OAuth 2.0 e um certificado de cliente X.509 apresentado no handshake TLS (mTLS):
No Painel FyPay, acesse Configurações → Credenciais e gere seu clientId e clientSecret. O clientSecret é exibido uma única vez.
Use o certificado X.509 (PEM, RSA 2048, válido por 2 anos) vinculado à sua conta e a respectiva chave privada.
Chame POST https://api.fypay.me/api/auth/token com suas credenciais, apresentando o certificado no handshake TLS (por exemplo, curl --cert client.crt --key client.key).
Inclua o token no header Authorization: Bearer <token> nas demais requisições. Elas não exigem certificado.
A validade do token é informada no campo expires_in (em segundos) da resposta. Renove o token antes que ele expire.
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 |
201 | Created | Recurso criado com sucesso |
400 | Bad Request | Dados inválidos na requisição |
401 | Unauthorized | Token ausente, inválido ou expirado |
403 | Forbidden | Acesso negado ao recurso |
404 | Not Found | Recurso não encontrado |
429 | Too Many Requests | Limite de requisições excedido |
500 | Internal Server Error | Erro interno do servidor |
503 | Service Unavailable | Serviço temporariamente indisponível |
Formato de Datas
Todas as datas na API seguem o padrão ISO 8601 com timezone UTC:
2024-01-15T10:30:00.000ZPrimeiros 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
Pagar via QR Code
Pague escaneando QR Codes PIX
Suporte
Para questões técnicas ou suporte, entre em contato:
- Email: suporte@fypay.me [A DEFINIR]
- Documentação: https://docs.fypay.me
- Health da API:
GET https://api.fypay.me/health