Integração de Backend Corporativo (Participante B2B)

Este guia orienta empresas parceiras (Fintechs, carteiras, ERPs) a conectar seus servidores corporativos para gerenciar seu próprio tesouro ou ler os dados dos usuários vinculados.

1. Autenticação e Token do Tesouro

  1. Gere seu Client ID e Client Secret corporativos no Painel Admin do Participante.

  2. Gere seu token fazendo um POST contendo as chaves para /auth/api-key. Veja como fazer em Autenticação.

  3. Salve o token gerado em memória no seu servidor para evitar chamadas excessivas.

2. Movimentando Recursos Corporativos

Qualquer chamada feita nos endpoints abaixo usando seu Token de Participante movimentará diretamente a conta e o saldo da sua própria empresa:

  • Pix de Entrada: POST /v1/pix/deposit (gera um QR Code para receber depósitos no cofre da empresa).

  • Pix de Saída: POST /v1/pix/withdraw (retira Reais do saldo da empresa para um Pix externo).

  • Swap (Câmbio): POST /v1/swap/execute (converte moedas fiduciárias da empresa por criptomoedas).

  • Saques Cripto: POST /v1/ledger/crypto/withdraw (envia criptoativos da empresa para um endereço de rede).

3. Acompanhando Seus Usuários (Apenas Leitura)

O seu backend pode usar o token corporativo para consultar saldos e transações dos clientes que se cadastraram por meio do seu aplicativo.

🔒 Regra de Segurança: Suas chaves corporativas são de somente leitura para contas de usuários. Você nunca conseguirá realizar saques ou transferências em nome deles usando a chave da sua empresa.

Listar Seus Usuários Vinculados

GET /v1/participant/users?page=1&pageSize=20

Consultar o Saldo de um Usuário

GET /v1/participant/users/{userId}/balance

Listar Transações para Conciliação Diária

GET /v1/participant/users/{userId}/transactions?limit=20

Esta funcionalidade está em rollout gradual — pode não estar habilitada para o seu participante ainda. Fale com seu gerente de conta para mais detalhes.

👉 Detalhes completos, exemplos de resposta e um alerta importante sobre o campo user nas transações: Portal de Leitura sobre Seus Usuários.

Limites de Chamadas (Rate Limits)

  • Portal de Usuários (/participant/users/*): Máximo de 30 chamadas por minuto.

  • Outros Endpoints: Limite padrão de 100 chamadas por minuto.