Links de pagamento
Gerencie links de pagamento personalizados que podem ser compartilhados com seus clientes.
Endpoints disponíveis
Endpoints públicos (Checkout)
Estes endpoints são públicos e não requerem autenticação. São usados no checkout público:
| Método | Endpoint | Descrição |
|---|
| GET | /api/payment-links/public/slug/{slug} | Obter informações de um link de pagamento público |
| POST | /api/payment-links/public/slug/{slug}/start | Iniciar checkout (cria transação PENDING sem dados do cliente) |
| POST | /api/payment-links/public/slug/{slug}/checkout | Criar checkout completo com dados do cliente |
| GET | /api/payment-links/public/transactions/{id}/status | Consultar status de uma transação |
| GET | /api/payment-links/public/transactions/{id}/sync-status | Sincronizar status consultando gateway diretamente |
Endpoints privados (API v1)
Estes endpoints requerem autenticação via API Key:
| Método | Endpoint | Descrição |
|---|
| POST | /api/v1/payment-links | Criar um novo link de pagamento |
| GET | /api/v1/payment-links | Listar links de pagamento |
| GET | /api/v1/payment-links/{id} | Obter link de pagamento específico |
| PATCH | /api/v1/payment-links/{id} | Atualizar link de pagamento |
| DELETE | /api/v1/payment-links/{id} | Deletar link de pagamento |
Endpoints privados (Dashboard)
Estes endpoints requerem autenticação via Bearer Token (JWT):
| Método | Endpoint | Descrição |
|---|
| GET | /api/payment-links | Listar links de pagamento |
| POST | /api/payment-links | Criar link de pagamento |
| GET | /api/payment-links/{id} | Obter link de pagamento |
| PATCH | /api/payment-links/{id} | Atualizar link de pagamento |
| PUT | /api/payment-links/{id} | Atualizar link de pagamento (alias) |
| DELETE | /api/payment-links/{id} | Deletar link de pagamento |
Autenticação
Endpoints públicos
Não requerem autenticação. Apenas rate limiting por IP (100 requisições/minuto).
Endpoints API v1
Requerem autenticação via Bearer Token (API Key):
Authorization: Bearer SUA_API_KEY
Endpoints Dashboard
Requerem autenticação via Bearer Token (JWT):
Authorization: Bearer SEU_JWT_TOKEN
Base URL
https://upay-sistema-api.onrender.com
Rate limits
| Tipo de endpoint | Limite |
|---|
| Endpoints públicos | 100 requisições/minuto por IP |
| Endpoints autenticados | 1000 requisições/minuto por API Key |
Ao exceder o rate limit, você receberá um erro 429 Too Many Requests com o header Retry-After indicando quando tentar novamente.