Skip to main content
Portão 3 is a Brazilian corporate payments and banking platform. Our APIs let you manage accounts and wallets, issue and control cards, move money with PIX, boleto, and wallet-to-wallet transfers, run your billing cycle (contracts, deals, invoices, payment links), issue NFSe fiscal documents, and manage the people and organizations that use your account.

​
How the platform is organized

The Portão 3 API is split into focused services. Each service has its own base URL:
Shortlinks is the exception to the pattern above: it runs on the custom domain api.links.portao3.com.br and is production-only — there is no development environment.

​
Authentication

Portão 3 APIs authenticate with JWT bearer tokens. Except for a few public endpoints (sign-in, password recovery, health checks, hosted checkout pages), every request must carry a token obtained from the Identity service:
There are two ways to get a token:
  • User credentials — sign in with email and password via POST /auth/sign-in. Users with MFA enabled complete a second step.
  • API client credentials — for server-to-server integrations, sign in with a client_id / client_secret pair issued by Portão 3. See the Quickstart for both flows.
Tokens expire after a short period; use POST /auth/refresh-token to obtain new ones without re-authenticating.

​
Transaction PIN

Some sensitive operations — confirming payments and transfers, viewing full card details, administering users — additionally require the authenticated user’s transaction PIN, sent in a pin header alongside the bearer token. Requests to those endpoints without a valid PIN are rejected with 403.

​
Tenancy: realms and organizations

Your access is scoped to a realm (your tenant) and one or more organizations inside it. Most endpoints carry both in the path:
You receive your realmId and organizationId during onboarding. Requests to a realm or organization your token is not entitled to are rejected with 403.

​
Environments

The base URLs above are production. A separate development environment is available for building and testing your integration before going live — each endpoint page in the API reference lists both servers, and your Portão 3 contact can provide development credentials. Data is fully isolated between environments. (Shortlinks is the exception: it is production-only and has no development environment.)

​
Errors

Most errors return a JSON body with this shape:
A few operations return operation-specific error bodies. Whenever a traceId is present, include it when contacting support — it lets us locate the exact request.

​
Next steps

Quickstart

Authenticate and make your first API call in minutes.

API Reference

Browse every endpoint, grouped by service.
Need help or access credentials? Contact us at suporte@portao3.com.br.