Referência da API
Visão geral de todos os endpoints da API RelaxPay v1
Esta é uma visão geral de todos os endpoints disponíveis na API RelaxPay v1. Para documentação detalhada de cada operação, consulte suas respectivas seções.
Visão Geral
A API RelaxPay v1 oferece uma solução completa para integração de pagamentos PIX em suas aplicações. Com ela, você pode:
PIX Cash-in
Gerar QR Codes para recebimento
PIX Cash-out
Transferir para outras contas
PIX Refund
Reembolsar pagamentos recebidos
Autenticação
Todas as requisições à API v1 devem incluir os headers de autenticação:
Para mais detalhes sobre autenticação, consulte a página de autenticação.
Ambientes
Sandbox
Ambiente de testes. Todos os pagamentos são simulados.
Produção
Ambiente de produção. Todas as transações são reais.
Endpoints
PIX Cash-in
PIX Cash-out
PIX Refund
Webhooks
A API RelaxPay v1 envia notificações para a URL de callback configurada nos endpoints. As notificações incluem:
pix.received
Pagamento PIX recebido
pix.payment.status
Status de transferência atualizado
refund.status
Status de reembolso atualizado
Exemplo de notificação de pagamento recebido:
Status das Operações
PENDING
Aguardando pagamento
PAID
Pagamento confirmado
PROCESSING
Em processamento
COMPLETED
Operação concluída
FAILED
Falha na operação
EXPIRED
QR Code expirado
CANCELLED
Operação cancelada
REFUNDED
Pagamento reembolsado
Códigos de Erro
Consulte a documentação de erros para ver a lista completa de códigos de erro e suas descrições.
Limites e Restrições
Limites da API
- Requisições: 120 requisições por minuto
- Tamanho máximo do payload: 1MB
- Timeout da requisição: 30 segundos
Exemplos de Implementação
Acesse os exemplos completos de implementação nas páginas específicas de cada operação:
Gerar QR Code
Como implementar a geração de QR Codes
Verificar Status
Como verificar status de pagamentos
Transferir PIX
Como implementar transferências PIX
Para suporte técnico e dúvidas específicas, entre em contato com nossa equipe pelo email suporte@relaxpay.app.