UPay Gateway API - Documentação Pública

Documentação oficial e completa da API UPay Gateway

Plataforma completa de pagamentos com PIX, cartão de crédito/débito, boleto bancário e muito mais.

---

📋 Sobre

A UPay Gateway API é uma solução completa de processamento de pagamentos desenvolvida para oferecer integração simples, segura e eficiente. Esta documentação fornece todas as informações necessárias para desenvolvedores integrarem pagamentos em suas aplicações.

Características Principais

• ✅ API RESTful moderna - Endpoints intuitivos e bem documentados
• ✅ Múltiplos métodos de pagamento - PIX, Cartão de Crédito/Débito e Boleto Bancário
• ✅ Links de pagamento personalizados - Crie e compartilhe links únicos com configurações flexíveis
• ✅ Gestão completa de produtos - Catálogo integrado com controle de estoque
• ✅ Sistema de cupons - Descontos percentuais ou valores fixos com regras configuráveis
• ✅ Webhooks em tempo real - Notificações instantâneas sobre eventos importantes
• ✅ Dashboard administrativo - Interface completa para gerenciamento e relatórios
• ✅ Documentação interativa - Exemplos práticos e referência completa da API

🚀 Início Rápido

Para Desenvolvedores

1. Obtenha suas credenciais de API

   • Acesse o Dashboard UPay
   • Complete o processo de verificação (KYC)
   • Gere sua API Key em Configurações → Credenciais de API

2. Faça sua primeira requisição

   curl -X GET "https://upay-sistema-api.onrender.com/api/v1/payment-links" \
     -H "Authorization: Bearer SUA_API_KEY" \
     -H "Content-Type: application/json"

3. Explore a documentação

   • Guia de Início Rápido
   • Referência Completa da API
   • Exemplos de Código

📚 Estrutura do Projeto

documentation/
├── api-reference/          # Especificação OpenAPI e referência de endpoints
│   └── openapi.json        # Especificação OpenAPI 3.0.3 completa
├── pages/                  # Conteúdo principal da documentação
│   ├── guides/             # Guias e tutoriais detalhados
│   │   └── features/       # Guias específicos por funcionalidade
│   ├── payment-links/      # Documentação de Links de Pagamento
│   ├── products/           # Documentação de Produtos
│   ├── coupon/             # Documentação de Cupons
│   ├── transactions/       # Documentação de Transações
│   ├── webhooks/           # Documentação de Webhooks
│   └── balance/            # Documentação de Saldo
├── images/                 # Imagens e assets visuais
├── logo/                   # Logos para temas claro e escuro
├── custom.css              # Estilos customizados (scrollbar, etc.)
├── docs.json               # Configuração principal do Mintlify
├── favicon.ico             # Ícone do site
└── README.md               # Este arquivo

Adicionando Novo Conteúdo

1. Nova página de guia: Adicione arquivo .mdx em pages/guides/
2. Novo endpoint: Atualize api-reference/openapi.json e crie página em pages/[recurso]/
3. Atualizar navegação: Edite docs.json na seção navigation

Convenções

• Use Markdown/MDX para formatação
• Siga a estrutura de pastas existente
• Mantenha consistência com o tom e estilo da documentação
• Inclua exemplos de código quando relevante

URL da Documentação: https://docs.upay.com.br

📖 Recursos da API

Endpoints Principais

Recurso	Descrição	Documentação
Links de Pagamento	Crie e gerencie links personalizados	Ver Documentação
Produtos	Gerencie seu catálogo de produtos	Ver Documentação
Cupons	Sistema completo de cupons de desconto	Ver Documentação
Transações	Consulte e gerencie transações	Ver Documentação
Webhooks	Configure notificações em tempo real	Ver Documentação
Saldo	Consulte saldo e movimentações	Ver Documentação

Autenticação

A API utiliza autenticação via API Key (Bearer Token). Todas as requisições autenticadas devem incluir o header:

Authorization: Bearer SUA_API_KEY

Para mais detalhes, consulte a documentação de autenticação.

🔗 Links Importantes

Documentação e Recursos

• Documentação Online: https://docs.upay.com.br
• API Base URL: https://upay-sistema-api.onrender.com
• Dashboard: https://app.upaybr.com
• Status da API: Verificar Status

Repositórios

• Documentação: GitHub Repository
• Sistema Principal: GitHub Repository

Suporte

• Email: suporte@upay.com.br
• Issues: GitHub Issues
• Documentação de Suporte: Páginas de Ajuda

🤝 Contribuindo

Contribuições são bem-vindas! Se você encontrar erros, tiver sugestões ou quiser adicionar conteúdo:

1. Abra uma Issue descrevendo sua proposta
2. Faça um Fork do repositório
3. Crie uma branch para sua alteração (git checkout -b feature/minha-contribuicao)
4. Faça commit das alterações (git commit -m 'Adiciona nova funcionalidade')
5. Faça push para a branch (git push origin feature/minha-contribuicao)
6. Abra um Pull Request

📝 Licença

Este projeto está licenciado sob a MIT License.

---

UPay Gateway API - Simplificando pagamentos online