Skip to main content
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:

PIX Cash-in

Gerar QR Codes para recebimento

PIX Cash-out

Transferir para outras contas

PIX Refund

Reembolsar pagamentos recebidos

​
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

Gera um QR Code PIX para recebimento de pagamento.Corpo da requisição:
{
  "requestNumber": "PEDIDO-12345",
  "dueDate": "2024-12-31",
  "amount": 100.00,
  "callbackUrl": "https://seu-site.com/webhook/relaxpay"
}
Resposta:
{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "paymentCode": "00020101021226890014br.gov.bcb.pix...",
  "paymentCodeBase64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQ...",
  "response": "OK",
  "expiresAt": "2024-12-31T23:59:59Z"
}
Ver documentação completa
Verifica o status de um pagamento PIX.Parâmetros de consulta:
idTransaction=0b935d10-3c90-4af3-8776-dd18622a7941
Resposta:
{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "status": "PAID",
  "amount": 100.00,
  "paidAt": "2024-12-15T14:30:45Z",
  "response": "OK"
}
Ver documentação completa

​
PIX Cash-out

Realiza uma transferência PIX para uma chave PIX.Corpo da requisição:
{
  "value": 150.00,
  "key": "62999998888",
  "typeKey": "phoneNumber",
  "callbackUrl": "https://seu-site.com/webhook/relaxpay",
  "externalId": "PAGAMENTO-12345"
}
Resposta:
{
  "idTransaction": "10dc395c-bee0-4368-a980-85a610987e30",
  "status": "PROCESSING",
  "response": "OK"
}
Ver documentação completa

​
PIX Refund

Reembolsa um pagamento PIX recebido anteriormente.Corpo da requisição:
{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "refundReason": "Cancelamento solicitado pelo cliente",
  "callbackUrl": "https://seu-site.com/webhook/relaxpay"
}
Resposta:
{
  "idTransaction": "3f8b2a5c-9e47-4d98-b6a1-7c432f89e21b",
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "amount": 100.00,
  "status": "PROCESSING",
  "response": "OK"
}
Ver documentação completa

​
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:

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 [email protected].