Skip to main content

​
Configure sua integração em 3 passos

Siga este guia para realizar sua primeira transação com a Upay Gateway API em menos de 10 minutos.

​
Passo 1: Obtenha suas credenciais

Para começar, você precisa de uma conta Upay e suas credenciais de API.
  1. Acesse o Dashboard Upay
  2. Faça login ou crie uma conta
  3. Complete o processo de KYC (Know Your Customer)
  4. Navegue até Configurações → API Keys
  5. Gere uma nova API Key
  6. Importante: Guarde sua API Key em local seguro, ela não será exibida novamente
Nunca compartilhe sua API Key publicamente. Mantenha-a segura e use variáveis de ambiente.
A URL base da API Upay é:
https://upay-sistema-api.onrender.com
Todas as requisições devem ser feitas para este endpoint, com exceção dos endpoints públicos de checkout.

​
Passo 2: Faça sua primeira requisição

Teste sua API Key fazendo uma requisição para listar seus links de pagamento:
curl -X GET "https://upay-sistema-api.onrender.com/api/v1/payment-links" \
  -H "Authorization: Bearer SUA_API_KEY_AQUI" \
  -H "Content-Type: application/json"
Resposta de sucesso (200 OK):
{
  "data": [
    {
      "id": "clx1234567890",
      "slug": "meu-produto",
      "name": "Meu Produto",
      "amount": 100.00,
      "currency": "BRL",
      "status": "active"
    }
  ],
  "total": 1
}
Resposta de erro (401 Unauthorized):
{
  "error": "Unauthorized",
  "message": "Token inválido ou expirado"
}
Substitua SUA_API_KEY_AQUI pela sua API Key real.
Exemplo usando fetch em JavaScript:
const apiKey = 'SUA_API_KEY_AQUI';
const response = await fetch('https://upay-sistema-api.onrender.com/api/v1/payment-links', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Exemplo usando requests em Python:
import requests

api_key = 'SUA_API_KEY_AQUI'
headers = {
    'Authorization': f'Bearer {api_key}',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://upay-sistema-api.onrender.com/api/v1/payment-links',
    headers=headers
)

data = response.json()
print(data)
Se você tiver cupons configurados, pode validá-los no checkout:
curl -X POST "https://upay-sistema-api.onrender.com/api/v1/coupons/validate" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "DESCONTO10",
    "amount": 100.00
  }'
Este endpoint é público e não requer autenticação.

​
Próximos passos

Agora que você fez sua primeira requisição, explore estas funcionalidades:

Autenticação

Aprenda sobre autenticação e segurança da API.

Links de Pagamento

Crie e gerencie links de pagamento personalizados.

Tratamento de Erros

Entenda os códigos de erro e como tratá-los.

Referência da API

Documentação completa dos endpoints disponíveis.

​
Precisa de ajuda?

Dúvidas? Entre em contato com nosso suporte em suporte@upay.com.br ou consulte a documentação completa da API.