Pular para o conteúdo principal
O Portão 3 é uma plataforma brasileira de pagamentos e serviços bancários corporativos. Nossas APIs permitem gerenciar contas e carteiras, emitir e controlar cartões, movimentar dinheiro com PIX, boleto e transferências entre carteiras, executar seu ciclo de cobrança (negociações, faturas, links de pagamento), emitir documentos fiscais NFSe e gerenciar as pessoas e organizações que usam sua conta.

​
Como a plataforma está organizada

A API do Portão 3 é dividida em serviços focados. Cada serviço tem sua própria URL base:

​
Autenticação

As APIs do Portão 3 se autenticam com tokens JWT bearer. Exceto por alguns endpoints públicos (login, verificações de saúde, páginas de checkout hospedadas), toda requisição deve carregar um token obtido do serviço Identity:
Para obter um token, faça login via POST /auth/sign-in com o par client_id / client_secret de um cliente de API emitido pelo Portão 3, enviado como credenciais HTTP Basic. Consulte o Início rápido para o fluxo completo. Os tokens expiram após um curto período; quando um expirar, faça login novamente para obter um novo.

​
PIN de transação

Algumas operações sensíveis — confirmação de pagamentos e transferências, visualização de detalhes completos de cartão, administração de usuários — exigem adicionalmente o PIN de transação do usuário autenticado, enviado em um cabeçalho pin junto com o token bearer. Requisições a esses endpoints sem um PIN válido são rejeitadas com 403.

​
Multi-tenancy: realms e organizações

Seu acesso é restrito a um realm (seu tenant) e a uma ou mais organizações dentro dele. A maioria dos endpoints carrega ambos no caminho:
Você recebe seu realmId e organizationId durante o onboarding. Requisições a um realm ou organização aos quais seu token não tem direito são rejeitadas com 403.

​
Ambientes

As URLs base acima são de produção. Um ambiente de desenvolvimento separado está disponível para construir e testar sua integração antes de ir ao ar — cada página de endpoint na referência da API lista ambos os servidores, e seu contato no Portão 3 pode fornecer credenciais de desenvolvimento. Os dados são totalmente isolados entre ambientes.

​
Erros

A maioria dos erros retorna um corpo JSON com este formato:
Algumas operações retornam corpos de erro específicos da operação. Sempre que houver um traceId, inclua-o ao entrar em contato com o suporte — ele nos permite localizar a requisição exata.

​
Próximos passos

Início rápido

Autentique-se e faça sua primeira chamada de API em minutos.

Referência da API

Navegue por todos os endpoints, agrupados por serviço.
Precisa de ajuda ou credenciais de acesso? Fale conosco em suporte@portao3.com.br.