Get a boleto charge

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "_id": "6727c3d4b4d3e80012c9b5c2",
  "environment": "LIVE",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "walletId": "66f2a3d1b4d3e80012c9a0d2",
  "status": "CREATED",
  "txnCurrency": "986",
  "txnAmount": 150000,
  "txnDivergentAmountType": "NOT_ALLOW_DIFFERENT_AMOUNT",
  "txnMaxAmount": 150000,
  "txnMinAmount": 150000,
  "txnDiscountAmount": [
    {
      "_id": "6727c3d4b4d3e80012c9b5c3",
      "date": "2026-11-15T00:00:00.000Z",
      "amount": 0.05,
      "amountType": "PERCENT_UNTIL_INFORMED_DATE"
    }
  ],
  "dueDate": "2026-11-20T00:00:00.000Z",
  "expiresAt": "2026-12-20T00:00:00.000Z",
  "description": "Mensalidade de novembro",
  "customer": {
    "name": "Padaria Pao Dourado Ltda",
    "document": "11222333000181",
    "address": {
      "street": "Rua das Laranjeiras",
      "number": "250",
      "neighborhood": "Centro",
      "postalCode": "01310-100",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Loja 2"
    }
  },
  "confirmedAmount": 0,
  "createdAt": "2026-11-05T13:10:22.000Z",
  "updatedAt": "2026-11-05T13:10:24.000Z",
  "barcode": "34191162100001500001090000012345678901234567",
  "digitableLine": "34191090080123456789001234567890116210000150000",
  "txnAmountLimitType": "FIXED_VALUE",
  "txnFineAmount": {
    "date": "2026-11-21T00:00:00.000Z",
    "amount": 0.02,
    "amountType": "PERCENT"
  },
  "txnInterestAmount": {
    "date": "2026-11-21T00:00:00.000Z",
    "amount": 0.01,
    "amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
  },
  "finalBeneficiary": {
    "document": "45678912000134",
    "documentType": "CNPJ",
    "name": "ACME COMERCIO LTDA"
  },
  "external": {
    "boletoBillingId": "3c5e7a9b-1d2f-4b6a-8c0e-2f4a6b8c0d1e"
  },
  "confirmedAt": "2026-11-18T14:32:10.000Z",
  "confirmedCurrency": "986",
  "confirmedBalanceCategory": "FLEX_INTERNATIONAL",
  "__v": 0
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

GET

realms

{realmId}

organizations

{organizationId}

accounts

{accountId}

wallets

{walletId}

boleto-billing

{boletoId}

Get a boleto charge

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}

import requests

url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "_id": "6727c3d4b4d3e80012c9b5c2",
  "environment": "LIVE",
  "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
  "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
  "accountId": "66f2a1c7b4d3e80012c9a0b4",
  "walletId": "66f2a3d1b4d3e80012c9a0d2",
  "status": "CREATED",
  "txnCurrency": "986",
  "txnAmount": 150000,
  "txnDivergentAmountType": "NOT_ALLOW_DIFFERENT_AMOUNT",
  "txnMaxAmount": 150000,
  "txnMinAmount": 150000,
  "txnDiscountAmount": [
    {
      "_id": "6727c3d4b4d3e80012c9b5c3",
      "date": "2026-11-15T00:00:00.000Z",
      "amount": 0.05,
      "amountType": "PERCENT_UNTIL_INFORMED_DATE"
    }
  ],
  "dueDate": "2026-11-20T00:00:00.000Z",
  "expiresAt": "2026-12-20T00:00:00.000Z",
  "description": "Mensalidade de novembro",
  "customer": {
    "name": "Padaria Pao Dourado Ltda",
    "document": "11222333000181",
    "address": {
      "street": "Rua das Laranjeiras",
      "number": "250",
      "neighborhood": "Centro",
      "postalCode": "01310-100",
      "city": "São Paulo",
      "state": "SP",
      "complement": "Loja 2"
    }
  },
  "confirmedAmount": 0,
  "createdAt": "2026-11-05T13:10:22.000Z",
  "updatedAt": "2026-11-05T13:10:24.000Z",
  "barcode": "34191162100001500001090000012345678901234567",
  "digitableLine": "34191090080123456789001234567890116210000150000",
  "txnAmountLimitType": "FIXED_VALUE",
  "txnFineAmount": {
    "date": "2026-11-21T00:00:00.000Z",
    "amount": 0.02,
    "amountType": "PERCENT"
  },
  "txnInterestAmount": {
    "date": "2026-11-21T00:00:00.000Z",
    "amount": 0.01,
    "amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
  },
  "finalBeneficiary": {
    "document": "45678912000134",
    "documentType": "CNPJ",
    "name": "ACME COMERCIO LTDA"
  },
  "external": {
    "boletoBillingId": "3c5e7a9b-1d2f-4b6a-8c0e-2f4a6b8c0d1e"
  },
  "confirmedAt": "2026-11-18T14:32:10.000Z",
  "confirmedCurrency": "986",
  "confirmedBalanceCategory": "FLEX_INTERNATIONAL",
  "__v": 0
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "ACCOUNT_NOT_FOUND",
  "origin": "BANKING",
  "message": "Account not found"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "organizationId",
      "message": "Invalid UUID",
      "code": "ORGANIZATIONID_UUID"
    }
  ]
}

There is no notification for a boleto charge: read it to follow its status. Once it is CREATED, show the payer digitableLine (or barcode), or send them the PDF; once it is PAID, confirmedAmount is what was credited to the wallet. An unpaid boleto stays payable until expiresAt and is then written off by the bank (CANCELED). Use default as walletId for the organization’s main wallet. Any member of the organization can read it.

Headers

x-environment

enum<string>

Environment of the charge: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; any other value is rejected.

Available options:

LIVE,

TEST

Path Parameters

realmId

string<uuid>

required

ID of your realm.

Format: UUID

organizationId

string<uuid>

required

ID of the organization.

Format: UUID

accountId

string

required

ID of the organization's account (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

walletId

string

required

ID of the wallet that issued the charge (24 hexadecimal characters), or default for the organization's main wallet.

Pattern: ^([0-9a-fA-F]{24}|default)$

boletoId

string

required

ID of the boleto charge — its _id (24 hexadecimal characters).

Pattern: ^[0-9a-fA-F]{24}$

Response

Successful response

A boleto charge issued from one of your wallets.

_id

string

required

ID of the charge. Use it as {boletoId} in the charge endpoints.

Example:

"6727c3d4b4d3e80012c9b5c2"

environment

enum<string>

required

Environment of the charge: LIVE (production) or TEST (sandbox).

Available options:

LIVE,

TEST

Example:

"LIVE"

realmId

string<uuid>

required

ID of the realm.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId

string<uuid>

required

ID of the organization.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

accountId

string

required

ID of the account.

Example:

"66f2a1c7b4d3e80012c9a0b4"

walletId

string

required

ID of the wallet that receives the payment.

Example:

"66f2a3d1b4d3e80012c9a0d2"

status

enum<string>

required

Status of the charge:

CREATED — registered at the bank and payable: show digitableLine, barcode or the PDF.
PAID — paid and credited to the wallet (see confirmedAmount).
CANCELED — written off unpaid by the bank some weeks after expiresAt; it can't be paid.
INITIATED, REQUESTED, ENQUEUED — accepted by the bank and being registered; there is no barcode yet, so read the charge again until it is CREATED.
PROCESSING — being issued. A charge still PROCESSING after its creation answered an error never gets a barcode from Portão 3. If the bank refused it, create a new one; if the bank didn't answer, it may have registered the boleto anyway — contact support before creating a new one, so the payer isn't charged twice.
PROCESSING_PAYMENT — paid and being credited.
ERROR — the bank could not issue it.

Available options:

INITIATED,

REQUESTED,

ENQUEUED,

PROCESSING,

CREATED,

PROCESSING_PAYMENT,

PAID,

CANCELED,

ERROR

Example:

"CREATED"

txnCurrency

string

required

Currency of the charge: 986 (Brazilian real). A charge whose creation failed before 2026-11 keeps the currency it was sent with.

Example:

"986"

txnAmount

number

required

Amount of the boleto, in cents.

Example:

150000

txnDivergentAmountType

enum<string>

required

Whether the payer may pay a different amount. Always NOT_ALLOW_DIFFERENT_AMOUNT once the charge is issued: the boleto is issued for exactly txnAmount.

Available options:

ANY_AMOUNT,

BETWEEN_MIN_AND_MAX,

ONLY_MIN_AMOUNT,

NOT_ALLOW_DIFFERENT_AMOUNT

Example:

"NOT_ALLOW_DIFFERENT_AMOUNT"

txnMaxAmount

number

required

Highest amount the payer may pay, in cents — txnAmount once the charge is issued.

Example:

150000

txnMinAmount

number

required

Lowest amount the payer may pay, in cents — txnAmount once the charge is issued.

Example:

150000

txnDiscountAmount

object[] | null

required

Discounts for paying early. Empty when there are none — null on some charges created before 2026-11, whose creation failed.

Show child attributes

dueDate

string<date-time>

required

Due date of the boleto.

Example:

"2026-11-20T00:00:00.000Z"

expiresAt

string<date-time>

required

Last day the boleto can be paid.

Example:

"2026-12-20T00:00:00.000Z"

description

string

required

Description of the charge. Empty when none was sent.

Example:

"Mensalidade de novembro"

customer

object

required

The payer, as printed on the boleto (as it was sent, on a charge whose creation failed).

Show child attributes

confirmedAmount

number

required

Amount paid, in cents — with any discount, fine or interest applied. 0 until the charge is paid.

Example:

0

createdAt

string<date-time>

required

When the charge was created.

Example:

"2026-11-05T13:10:22.000Z"

updatedAt

string<date-time>

required

When the charge last changed.

Example:

"2026-11-05T13:10:24.000Z"

barcode

string | null

Barcode of the boleto (44 digits). Absent or null until the charge is CREATED.

Example:

"34191162100001500001090000012345678901234567"

digitableLine

string | null

Digitable line of the boleto (linha digitável, 47 digits) — what the payer types into their bank app. Absent or null until the charge is CREATED.

Example:

"34191090080123456789001234567890116210000150000"

txnAmountLimitType

enum<string>

Unit of txnMinAmount and txnMaxAmount. Always FIXED_VALUE once the charge is issued.

Available options:

FIXED_VALUE,

PERCENT

Example:

"FIXED_VALUE"

txnFineAmount

object | null

The fine for paying late. Absent (or null, on some older charges) when there is none.

Show child attributes

txnInterestAmount

object | null

The interest for paying late. Absent (or null, on some older charges) when there is none.

Show child attributes

finalBeneficiary

object

The beneficiary printed on the boleto. Absent until the charge is issued.

Show child attributes

external

object

Reference of the boleto at the bank. Absent until the charge is issued.

Show child attributes

confirmedAt

string<date-time>

When the payment was credited. Present only on PAID charges.

Example:

"2026-11-18T14:32:10.000Z"

confirmedCurrency

string

Currency of the payment: 986 (Brazilian real). Absent until the charge is issued.

Example:

"986"

confirmedBalanceCategory

enum<string>

Balance category of the wallet the payment is credited to. Absent until the charge is issued.

Available options:

FLEX_NATIONAL,

FLEX_INTERNATIONAL,

FOOD,

GAS,

MOBILITY,

TOLL,

FLEX_NATIONAL_WITHOUT_WITHDRAWALS,

ADS,

SAAS,

HOTEL,

AIRLINES,

TRAVEL,

BLOCKED,

CASHBACK

Example:

"FLEX_INTERNATIONAL"

__v

number

Internal revision counter of the record.

Example:

0

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

Get a boleto charge

Headers

Path Parameters

Response