Visao Geral

Visao Geral da API

Entenda como a API Rayo funciona e quais recursos estao disponiveis para sua integracao.

Recursos Disponiveis

PIX - Pagamentos Instantaneos

Receba pagamentos em tempo real via PIX com QR Code dinamico, chave PIX e notificacoes instantaneas via webhook. Ideal para e-commerce, marketplaces e qualquer aplicacao que necessite de pagamentos rapidos.

Geracao de QR Code dinamico
Copia e cola (PIX Copia e Cola)
Notificacoes via webhook
Consulta de status em tempo real

Saques PIX

Realize transferencias e saques via PIX de forma automatizada. Perfeito para pagamento de fornecedores, comissoes e cashback.

Transferencias instantaneas
Suporte a chave PIX, CPF, CNPJ
Notificacoes de confirmacao

Arquitetura

A Rayo Payment API e uma solucao server-to-server (S2S), o que significa que todas as requisicoes devem ser feitas a partir do seu servidor backend, nunca diretamente do frontend/cliente.

Seu Frontend

→

Seu Backend

→

API Rayo

URL Base

Base URL

url

https://rayopay.com.br

Formato de Resposta

Todas as respostas da API sao retornadas no formato JSON. Em caso de erro, seguimos o padrao RFC 7807 (Problem Details).

Resposta de Sucesso

success.json

json

{
  "data": {
    "id": "f2d96218-6635-4839-81d7-9f2d5aaf4f14",
    "status": "WAITING_PAYMENT",
    "paymentMethod": "PIX",
    "amount": 500
  },
  "status": 200,
  "message": "Transação criada com sucesso."
}

Resposta de Erro

error.json

json

{
  "type": "https://rayopay.com.br/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Os dados fornecidos são inválidos.",
  "errors": {
    "amount": ["O campo amount é obrigatório"]
  }
}

Rate Limits

Para garantir a estabilidade do servico, aplicamos limites de requisicoes:

Plano	Limite
Basico	100 req/min
Pro	500 req/min
Enterprise	Ilimitado

Dica

Recomendamos implementar retry com exponential backoff em caso de erros 429 (Too Many Requests).