Skip to main content
Este guia rápido te ajudará a fazer sua primeira requisição à API da Upay em poucos minutos.

​
Pré-requisitos

Antes de começar, você precisa de:
  • Uma conta na Upay
  • Uma chave de API (criada no Dashboard)
  • Conhecimento básico de HTTP e JSON

Novo na Upay?

Se você ainda não tem uma conta, acesse o Dashboard e crie sua conta gratuitamente.

​
Passo 1: Obter sua Chave de API

1

Acesse o Dashboard

Faça login em app.upaybr.com.
2

Crie uma Chave de API

Navegue até Configurações → Credenciais de API e clique em “Criar Nova API Key”.
3

Copie sua Chave

Copie a chave gerada e armazene-a em um local seguro. Ela não será exibida novamente.
Sua chave de API é uma credencial sensível. Nunca a compartilhe publicamente nem a commite em repositórios de código.

Desenvolvimento x Produção

O ambiente é determinado automaticamente pela chave utilizada:
  • Chave de Desenvolvimento → transações simuladas, ideal para testes
  • Chave de Produção → transações reais, requer conta verificada (KYC)
Para mais detalhes, consulte a documentação de Chaves de API.

​
Passo 2: Fazer sua Primeira Requisição

Vamos criar seu primeiro link de pagamento: 
curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/payment-links \
  --header 'Authorization: Bearer SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Produto Premium",
    "amountCents": 9900,
    "description": "Acesso vitalício"
  }'

​
Resposta de sucesso

{
  "id": "lnk_abc123",
  "title": "Produto Premium",
  "description": "Acesso vitalício",
  "amountCents": 9900,
  "status": "ACTIVE",
  "url": "https://pay.upaybr.com/l/abc123",
  "createdAt": "2026-04-08T00:00:00.000Z"
}

Visualize no Dashboard

Após criar seu link, acesse o Dashboard e navegue até Links de Pagamento para ver todos os detalhes, status e histórico de pagamentos.

​
Passo 3: Criar uma Transação PIX

curl --request POST \
  --url https://upay-sistema-api.onrender.com/api/v1/transactions \
  --header 'Authorization: Bearer SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "product": "Curso Online",
    "paymentMethod": "PIX",
    "amountCents": 9900,
    "clientName": "João Silva",
    "clientEmail": "joao@example.com",
    "clientDocument": "12345678900"
  }'

​
Resposta de sucesso

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "paymentMethod": "PIX",
  "amountCents": 9900,
  "pixCopiaECola": "00020101021226940014br.gov.bcb.pix...",
  "pixExpiresAt": "2026-04-09T00:00:00.000Z",
  "createdAt": "2026-04-08T00:00:00.000Z"
}

​
Próximos Passos

Chaves de API

Entenda permissões e boas práticas de segurança.

Links de Pagamento

Todas as opções disponíveis para criar cobranças.

Webhooks

Receba notificações em tempo real sobre eventos.

SDKs Oficiais

Use nossas bibliotecas para integrar mais rápido.

​
Precisa de Ajuda?

Suporte

Nossa equipe está sempre à disposição. Entre em contato: suporte@upaybr.com