API Reference

The reference is grouped by service. Every service is a separate API with its own base URL, listed on each endpoint page:

https://api.<service>.v2.portao3.com.br

Authentication

Unless an endpoint says otherwise, every request requires a JWT bearer token issued by the Identity service:

Authorization: Bearer <accessToken>

See the Quickstart for how to obtain and renew tokens. A few endpoints don’t take a bearer token — for example POST /auth/sign-in (which takes your API client credentials as HTTP Basic instead), service health checks (GET /health), and the hosted checkout pages for payment links. Some sensitive operations also require the user’s transaction PIN in a pin header — see Authentication in the introduction.

Pagination

List endpoints return one page at a time: items plus a next cursor that is null on the last page. See Pagination.

Tenancy

Endpoints whose path starts with /realms/{realmId}/organizations/{organizationId}/ are tenant-scoped: the token you send must belong to that realm and be entitled to that organization. Your IDs are provided during onboarding.

Services

Service	What you can do
Identity	Sign in and refresh tokens, manage users, organizations, MFA, and API clients
Banking	Manage accounts, wallets, and cards; send and receive PIX; issue and pay boleto; query the transaction ledger
Billing	Manage deals, invoices, entries, and statements; settle invoices; orchestrate NFSe issuance
Payment Links & Checkout	Create payment links and run hosted checkouts
Accounting	Configure tax issuers and issue, cancel, and download NFSe fiscal documents
Registry	Manage payer/customer records, export customer data, manage the product catalog and suppliers, look up companies by CNPJ
Platform	Aggregated operations across wallets, cards, payments, and reports
Notification	Configure notification routing, channels, and webhook destinations
Rule Engine	Define transaction security policies and manage blocked wallet balances
Scheduling	Schedule future PIX, boleto, and wallet-to-wallet transfers and track their execution
Travel	Search air, hotel, bus, and vehicle inventory; manage passengers; create, issue, and cancel trip reservations
Vehicle	Register fleet vehicles, each with a dedicated wallet for its fuel and other card purchases; archive and reactivate them
Attachment	Upload, list, download, and delete files; read each file’s automatic summary, preview thumbnail, and extracted fiscal data

Not sure where to start? Billing manages the agreement and invoice lifecycle between you and your counterparties; Payment Links & Checkout is for collecting one-off payments through a hosted page; Banking is where money actually moves (PIX, boleto, wallets, cards).

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Authentication

Tenancy

Services

​Authentication

​Pagination

​Tenancy

​Services

Authentication

Pagination

Tenancy

Services