Bem-vindo à documentação da API RelaxPay v1! Esta versão utiliza autenticação via headers ci e cs, proporcionando uma integração simples e direta para seu sistema.

​
Visão Geral da API v1

A API v1 do RelaxPay oferece uma solução completa para integração de pagamentos PIX em suas aplicações, com autenticação via headers ci e cs. Todos os endpoints começam com o prefixo /api/v1/gateway/.

Autenticação Simples

Basta incluir seus identificadores nos headers de cada requisição:

ci: seu-client-id
cs: seu-client-secret

Integração Direta

Sem necessidade de gerenciar tokens ou lidar com renovações de autenticação

​
Recursos Disponíveis

PIX Cash-in

Receba pagamentos via PIX:

  • Geração de QR Code dinâmico
  • Confirmação automática de pagamentos
  • Notificações em tempo real

PIX Cash-out

Envie pagamentos via PIX:

  • Transferências instantâneas
  • Validação de chaves PIX
  • Controle de duplicidade

​
Exemplo de Integração

​
Fluxo de Integração

Obtenha suas Credenciais

Acesse o Dashboard RelaxPay e obtenha seu Client ID e Client Secret

Implemente a Autenticação

Adicione os headers ci e cs em todas as suas requisições à API

Configure os Webhooks

Implemente um endpoint para receber notificações automáticas sobre o status das transações

Teste sua Integração

Utilize o ambiente de sandbox para validar sua implementação antes de ir para produção

​
Próximos Passos

Autenticação

Saiba mais sobre o processo de autenticação

Referência da API

Explore todos os endpoints disponíveis

Webhooks

Configure notificações em tempo real

Se você estiver iniciando um novo projeto, considere conhecer também nossa API v2, que utiliza autenticação via Bearer token.