Ambientes
A API PayerScan opera atualmente em ambiente Production para transações reais.
URL Base
Todas as requisições da API devem ser enviadas para:
https://api.payerscan.com
Endpoints disponíveis
| Método | Endpoint | Descrição |
|---|---|---|
POST | /payment/crypto | Criar uma nova fatura de pagamento. |
GET | /invoice/:trans_id | Verificar o status e detalhes da fatura. |
Requisito HTTPS
Todas as requisições da API devem ser enviadas via HTTPS.
URLs de callback (callback_url, completed_url, expired_url) devem usar HTTPS em produção. Quando PayerScan envia webhooks para faturas concluídas ou expiradas, valida as URLs de callback antes do envio — URLs usando HTTP ou apontando para endereços privados/internos serão rejeitadas, e o webhook não será entregue.
Proteção SSRF
Ao entregar webhooks, PayerScan valida as URLs de callback para prevenir ataques de Server-Side Request Forgery (SSRF). Webhooks não serão enviados para:
- Localhost —
127.0.0.0/8,localhost,::1 - Redes privadas —
10.0.0.0/8,172.16.0.0/12,192.168.0.0/16 - Link-local —
169.254.0.0/16 - Domínios que resolvem para IPs privados — a resolução DNS é verificada
Sempre utilize uma URL HTTPS publicamente acessível para callback_url para garantir a entrega dos webhooks.
CORS
A API suporta Cross-Origin Resource Sharing (CORS). No entanto, você nunca deve chamar a API diretamente do código do lado do cliente — sempre encaminhe através do seu servidor backend. Consulte Autenticação para detalhes.
Formato de resposta
Resposta de sucesso
{
"status": "success",
"data": { ... }
}
Resposta de erro
{
"status": "error",
"message": "Descrição do erro",
"error_code": "ERROR_CODE"
}
Para detalhes sobre limites de taxa, consulte Rate Limits. Para códigos de erro de autenticação, consulte Autenticação.