Skip to main content
These guides walk through the workflows integrators build most often on top of the Portão 3 APIs. Each one explains the end-to-end flow, shows the requests in order, and links to the exact endpoints in the API Reference. If you haven’t authenticated yet, start with the Quickstart — every flow below assumes you already have an accessToken.

​
Before you begin

A few conventions apply to every Banking flow in these guides:
  • Base URL — Banking lives at https://api.banking.v2.portao3.com.br.
  • Tenancy — most paths are scoped to your realmId, organizationId, accountId, and a walletId. You receive these during onboarding. Replace the {...} placeholders with your values.
  • Environment header — Banking requests carry an x-environment header: LIVE for production money movement, TEST for sandbox data.
  • Amounts are in centavos — an amount of 10000 means R$ 100,00.
  • Authorization — send your token as Authorization: Bearer <accessToken> on every call.
Some sensitive operations (confirming a payment, reading full card details) may additionally require the authenticated user’s transaction pin header, depending on how your credentials are provisioned. See Authentication for details.

​
Choose a flow

Issue virtual cards

Create a virtual card, read its PAN and CVV, and hand it to a merchant for a charge.

Control card spending

Attach spend limits and merchant-category rules to cards, and check available balance.

Manage and monitor cards

List cards, block and unblock them, and read their transaction history.

Send a Pix payment

Pay by Pix key, QR code or bank details: create the payment, set its details, then confirm it.

Pay a boleto

Pay a bank boleto or a utility bill from its barcode, now or on its due date.

Send a TED

Transfer from a wallet to an account at another bank by its bank details: create the TED, then confirm it.

Business policies and approvals

Confirm a payment straight away, or send it for approval when your organization’s policies require it.

Manage Pix keys

Register Pix keys on a wallet, confirm and remove them, and answer claims from other institutions.

Charge with PIX

Generate a PIX QR Code (Copia e Cola) and get notified when it’s paid.

Charge with a boleto

Issue a boleto to a customer, share its digitable line or PDF, and know when it’s paid.

Recurring billing with Pix Automático

Set up an authorized recurring debit, track each cycle, and fall back to boleto.

Wallets for your customers

Open a wallet per end customer, register PIX keys, read balances, and move money between wallets.

Receive webhooks

Understand the notification envelope and the events that drive every async flow.