Skip to main content

​
Comece aqui

Aprenda sobre a Upay Gateway API e como integrar pagamentos na sua aplicação. Nesta documentação você encontrará tudo o que precisa para integrar com a API da Upay. Desenvolvida por desenvolvedores para desenvolvedores, nossa plataforma foi projetada para ser intuitiva e fácil de usar.

​
O que é a Upay Gateway API?

A Upay Gateway API é uma plataforma completa de pagamentos que surgiu da necessidade de oferecer uma solução white-label robusta e flexível para processamento de transações. Diferente de outras plataformas que são excessivamente complexas:
  • API simples e intuitiva: Endpoints claros e bem documentados
  • Múltiplos métodos de pagamento: PIX, Cartão de Crédito/Débito e Boleto
  • Links de pagamento personalizados: Crie links únicos com configurações flexíveis
  • Gestão completa: Produtos, cupons, webhooks e muito mais
  • Dashboard administrativo: Controle total sobre transações e relatórios
Veja como é fácil: 
// Exemplo de criação de link de pagamento
const response = await fetch('https://upay-sistema-api.onrender.com/api/v1/payment-links', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Produto Premium',
    amount: 10000,
    settings: {
      methods: {
        pix: true,
        card: true
      }
    }
  })
});

const data = await response.json();
console.log(data.data.url); // URL do checkout

​
Arquitetura RESTful Simplificada

Nossa API foi construída seguindo os princípios REST com foco em simplicidade e previsibilidade:

​
1. Baseada em intenção: Cada endpoint representa exatamente o que você lê

POST /api/v1/payment-links     // Cria um link de pagamento
GET  /api/v1/payment-links     // Lista links de pagamento
GET  /api/v1/payment-links/:id // Busca um link específico

​
2. Idempotência: Requisições seguras para retry

Operações POST e PUT são idempotentes quando você fornece um idempotencyKey, garantindo que requisições duplicadas não criem recursos múltiplos. 
await fetch('/api/v1/payment-links', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Idempotency-Key': 'unique-key-123' // Previne duplicação
  },
  body: JSON.stringify({...})
});

​
3. Consistente: Respostas padronizadas facilitam o tratamento de erros

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "slug": "produto-premium-abc123",
    "title": "Produto Premium",
    "amount": 10000,
    "url": "https://app.upaybr.com/checkout/produto-premium-abc123",
    "status": "ACTIVE"
  }
}

​
4. Documentação completa e suporte dedicado

Para garantir uma integração bem-sucedida, oferecemos:
  • Guias passo a passo com casos de uso reais
  • Exemplos de código em JavaScript, Python, PHP e cURL
  • Referência completa da API com todos os parâmetros documentados
  • Suporte técnico via email: suporte@upay.com.br

​
Funcionalidades Principais

Links de Pagamento

Crie links personalizados com múltiplos métodos de pagamento

Autenticação

Configure suas credenciais de API

Tratamento de Erros

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

Referência da API

Documentação completa dos endpoints

​
Próximos Passos

Início Rápido

Configure sua integração em minutos e comece a processar pagamentos.

Autenticação

Aprenda como obter e usar suas credenciais de API.

​
Dúvidas?

Nossa equipe está sempre pronta para ajudar! Entre em contato pelo email suporte@upay.com.br