Esta é uma visão geral de todos os endpoints disponíveis na API RelaxPay v2. Para documentação detalhada de cada operação, consulte suas respectivas seções.

Visão Geral

A API RelaxPay v2 oferece uma solução completa para integração de pagamentos PIX em suas aplicações. Com ela, você pode:

Ambientes

Sandbox

https://sandbox.ws.relaxpay.site

Ambiente de testes. Todos os pagamentos são simulados.

Produção

https://ws.relaxpay.site

Ambiente de produção. Todas as transações são reais.

Endpoints

PIX Cash-in

PIX Cash-out

PIX Refund

Webhooks

A API RelaxPay v2 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:

{
  "event": "pix.received",
  "data": {
    "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
    "status": "PAID",
    "amount": 100.00,
    "paidAt": "2024-12-15T14:30:45Z"
  }
}

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: 100 requisições por minuto
  • Tamanho máximo do payload: 1MB
  • Timeout da requisição: 30 segundos
  • Validade do QR Code: Até a data de vencimento especificada
  • Limite de transferência: Configurável no Dashboard

Exemplos de Implementação

Acesse os exemplos completos de implementação nas páginas específicas de cada operação:

Para suporte técnico e dúvidas específicas, entre em contato com nossa equipe pelo email suporte@relaxpay.app.