Skip to main content
Estes guias percorrem os fluxos de trabalho que os integradores constroem com mais frequência sobre as APIs do Portão 3. Cada um explica o fluxo de ponta a ponta, mostra as requisições em ordem e faz link para os endpoints exatos na Referência da API. Se você ainda não se autenticou, comece pelo Guia rápido — todos os fluxos abaixo pressupõem que você já possui um accessToken.

​
Antes de começar

Algumas convenções se aplicam a todos os fluxos de Banking nestes guias:
  • URL base — o Banking fica em https://api.banking.v2.portao3.com.br.
  • Tenancy — a maioria dos caminhos é escopada por realmId, organizationId, accountId e um walletId. Você recebe esses valores durante o onboarding. Substitua os placeholders {...} pelos seus valores.
  • Header de ambiente — as requisições de Banking carregam um header x-environment: LIVE para movimentação de dinheiro em produção, TEST para dados de sandbox.
  • Os valores são em centavos — um amount de 10000 significa R$ 100,00.
  • Autorização — envie seu token como Authorization: Bearer <accessToken> em cada chamada.
Algumas operações sensíveis (confirmar um pagamento, ler os detalhes completos de um cartão) podem adicionalmente exigir o header pin da transação do usuário autenticado, dependendo de como suas credenciais foram provisionadas. Veja Autenticação para detalhes.

​
Escolha um fluxo

Emitir cartões virtuais

Crie um cartão virtual, leia seu PAN e CVV e entregue-o a um estabelecimento para uma cobrança.

Controlar gastos do cartão

Anexe limites de gasto e regras de categoria de estabelecimento aos cartões e consulte o saldo disponível.

Gerenciar e monitorar cartões

Liste cartões, bloqueie e desbloqueie e leia seu histórico de transações.

Enviar um pagamento PIX

Pague por chave PIX ou QR Code com o fluxo de iniciar-e-confirmar.

Cobrar com PIX

Gere um QR Code PIX (Copia e Cola) e seja notificado quando for pago.

Cobrança recorrente com Pix Automático

Configure um débito recorrente autorizado, acompanhe cada ciclo e utilize o boleto como fallback.

Carteiras para seus clientes

Abra uma carteira por cliente final, registre chaves PIX, leia saldos e movimente dinheiro entre carteiras.

Receber webhooks

Entenda o envelope de notificação e os eventos que dirigem cada fluxo assíncrono.