Skip to main content
Gerencie links de pagamento personalizados que podem ser compartilhados com seus clientes.
Para um guia completo sobre Links de pagamento, consulte Guia de Links de pagamento.

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étodoEndpointDescriçã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}/startIniciar checkout (cria transação PENDING sem dados do cliente)
POST/api/payment-links/public/slug/{slug}/checkoutCriar checkout completo com dados do cliente
GET/api/payment-links/public/transactions/{id}/statusConsultar status de uma transação
GET/api/payment-links/public/transactions/{id}/sync-statusSincronizar status consultando gateway diretamente

Endpoints privados (API v1)

Estes endpoints requerem autenticação via API Key:
MétodoEndpointDescrição
POST/api/v1/payment-linksCriar um novo link de pagamento
GET/api/v1/payment-linksListar 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étodoEndpointDescrição
GET/api/payment-linksListar links de pagamento
POST/api/payment-linksCriar 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 endpointLimite
Endpoints públicos100 requisições/minuto por IP
Endpoints autenticados1000 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.