Getting Started
Bem-vindo à documentação da DEX API. Nossa plataforma BaaS (Banking as a Service) oferece integração robusta com o ecossistema financeiro descentralizado e tradicional, permitindo que você construa produtos que unem o mundo fiat (como Pix) ao mundo cripto (como Wallets on-chain, Swaps e Saques de Criptomoedas).
🌍 Visão Geral da Arquitetura
A DEX API foi construída para comunicação Server-to-Server (B2B). Suas requisições devem sempre partir do seu backend, protegendo assim suas credenciais (Client ID e Client Secret).
Módulos Principais
Nossa API é dividida nas seguintes áreas de negócios:
-
Users & Wallets (
/users): Gerenciamento do ciclo de vida dos usuários (Onboarding) e provisionamento assíncrono de carteiras cripto. -
Ledger (
/ledger): Consultas de saldo, extratos detalhados (com exportação CSV) e transferências internas entre contas da plataforma. -
Pix (
/pix): Criação de QR Codes de depósito, simulação de taxas e saques Pix via DICT do Banco Central. -
Swap (
/swap): Operações de câmbio entre ativos fiduciários (BRL/USD) e criptomoedas. -
Receive Requests (
/receive-requests): Geração de links de pagamento universais (Deep links e URI de Blockchain).
📡 Ambiente (Environment)
A nossa API responde estritamente por HTTPS no seguinte endereço base:
|
Ambiente |
Base URL |
Descrição |
|---|---|---|
|
Produção |
|
Ambiente real. Requer KYC e assinatura de contrato. |
⏱️ Rate Limits (Limites de Requisição)
Para garantir a estabilidade do ecossistema, nossas APIs implementam Rate Limiting baseado no seu Client_ID.
-
Padrão: 100 requisições por segundo.
-
Em caso de excesso, a API retornará o HTTP Status
429 Too Many Requests. -
Recomendamos fortemente a implementação de algoritmos de Exponential Backoff em caso de falhas de rate limit ou timeout.
Atenção: Endpoints pesados (como o /pix/withdraw) podem possuir rate limits mais restritivos baseados no nível de contrato B2B. Consulte o gerente da sua conta para limites personalizados.
🪝 Operações Assíncronas e Webhooks
Processos que interagem com a blockchain ou sistemas externos (ex: Pix e Criação de Wallets) são assíncronos. Embora a API forneça endpoints de consulta (status), recomendamos a configuração de Webhooks no seu painel para receber notificações automáticas sobre a mudança de status (ex: de PENDING para COMPLETED), evitando polling desnecessário.

