O que é a Cyrus?

A Cyrus é uma plataforma de infraestrutura de pagamentos PIX que permite a desenvolvedores e empresas integrar cobranças, pagamentos e transferências de forma simples e confiável.

Com a API Cyrus você pode:

• Gerar cobranças PIX e receber QR Code + código Copia e Cola imediatamente
• Enviar pagamentos PIX para qualquer chave (CPF, CNPJ, e-mail, telefone, chave aleatória)
• Consultar transações com filtros por tipo, status e período
• Receber notificações em tempo real via webhook quando transações são confirmadas

Base URL

Todas as requisições devem ser feitas para:

https://api.cyrus.com.br/api/v1

Autenticação

Todas as requisições exigem o header x-api-key com uma chave válida:

Chaves são geradas no painel em Configurações → API Keys.

Formato das respostas

As respostas são JSON puro, sem wrapper success/data. Exemplo de resposta de sucesso:

  "transactionId": "cm1abc...",
  "txid": "E1234567820240115120000",
  "qrCode": "00020126580014br.gov.bcb.pix...",
  "amount": 100.00,
  "fees": {
    "feeAmount": 0.33,
    "netAmount": 99.67
  }
}

Em caso de erro:

  "error": "amount must be a positive number"
}

Endpoints disponíveis

| Método | Path | Descrição | |---|---|---| | POST | /api/v1/charges | Gerar cobrança PIX (pay-in) | | POST | /api/v1/payouts | Enviar pagamento PIX (pay-out) | | GET | /api/v1/transactions | Listar transações |

Próximos passos