Bem-vindo à documentação da DEX API! 🎉

A DEX é uma plataforma Banking as a Service (BaaS) — ou seja, "Banco como Serviço". Nós fornecemos toda a infraestrutura financeira por baixo dos panos (Pix, contas e cripto) e você foca em construir a melhor experiência para o seu negócio ou cliente.

Qual é a Sua Situação de Uso?

A documentação foi organizada em 3 cenários práticos. Identifique qual se aplica a você e vá direto para o guia focado:

Cenário 1: Integração de Backend (Empresa/Participante)

Você quer conectar o servidor da sua empresa para movimentar o seu próprio cofre (tesouro) ou consultar dados dos seus usuários.
👉 Ir para Guia do Participante B2B

Cenário 2: Construir o Aplicativo do Seu Cliente

Você é desenvolvedor de front-end e precisa integrar telas de cadastro, login (via AWS Cognito), KYC e Pix para os seus usuários finais.
👉 Ir para Guia de Integração de Front-end

Cenário 3: Automação Pessoal (Usuário Comum)

Você é um usuário final e quer gerar uma API Key pessoal para conectar sua própria conta a sistemas de gestão financeira, planilhas ou scripts de automação.
👉 Ir para Guia do Usuário Comum

Os Três Tipos de Crachás de Acesso (Tokens)

Tipo de Token	O que representa	Onde é obtido	Onde usar
1. Token de Participante	O tesouro da sua empresa	/auth/api-key (com as chaves do Painel Admin)	No backend da sua empresa
2. Token de Usuário	O saldo do seu cliente final	Login direto no AWS Cognito	No front-end do seu aplicativo
3. Token de API Key do Usuário	O saldo do usuário final (pessoal)	/auth/api-key (com chaves geradas no PWA/Desktop)	Em scripts pessoais de automação

Ambiente e Endereço Base

Ambiente	URL Base	Descrição
Produção	https://api.dexkey.finance/v1	Ambiente real. Requer KYC (usuários) ou contrato (empresas).

Protocolo: Todas as chamadas devem usar obrigatoriamente HTTPS. Conexões HTTP simples serão recusadas.

Referências Técnicas Completas

Além dos guias por cenário acima, estas páginas são referência de contrato completo (filtros, paginação, todos os campos, exemplos por tipo):

• Portal de Leitura sobre Seus Usuários — /participant/users/* completo, incluindo o alerta sobre o campo user em transações (rollout gradual — ver nota na própria página).

• Referência Completa do Ledger — /ledger/balance, /users/consolidated-balance, /users/assets, /users/wallets, /ledger/statement, /ledger/statement/export, /ledger/transactions/{id}, com exemplo de payload para cada tipo de transação (TRANSFER_INTERNAL, BRT_MINT, CRYPTO_SWAP, etc.).

• Referência de Taxas — /fees/preview, /fees/history, /fees/catalog, arredondamento, spread, estorno.

• Cobranças / Links de Pagamento — /receive-requests, criação, listagem, consulta pública e cancelamento.