List the realm's Pix charges
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billingimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing', 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}/pix-billing",
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}/pix-billing"
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}/pix-billing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing")
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{
"items": [
{
"_id": "672a1f4eb4d3e80012c9b3e7",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"status": "ACTIVE",
"txnCurrency": "986",
"txnAmount": 28500,
"txnCanAmountChange": false,
"txnFineAmount": {
"amount": 2,
"amountType": "PERCENT"
},
"txnInterestAmount": {
"amount": 1,
"amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
},
"txnDiscountAmount": {
"amount": 0,
"amountType": "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS"
},
"txnRebateAmount": {
"amount": 0,
"amountType": "FIXED_VALUE"
},
"dueDate": "2026-11-20T00:00:00.000Z",
"expiresAt": "2026-12-20T00:00:00.000Z",
"description": "Pedido 4821",
"customer": {
"name": "Juliana Ribeiro",
"document": "12345678909",
"email": "juliana.ribeiro@exemplo.com.br",
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"postalCode": "01310-200",
"city": "São Paulo",
"state": "SP",
"complement": "Sala 12"
}
},
"confirmedAmount": 0,
"confirmedAmountAuthorized": 0,
"createdAt": "2026-11-05T18:21:34.112Z",
"updatedAt": "2026-11-05T18:21:35.004Z",
"__v": 0,
"emv": "00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2",
"key": "financeiro@lojaexemplo.com.br",
"confirmedAt": "2026-11-18T14:32:07.512Z",
"canceledAt": "2026-11-19T09:15:42.087Z",
"external": {
"pixBillingId": "b8c1d3e5-4f2a-4c6b-9d7e-1a2b3c4d5e6f",
"locationId": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"transactionId": "672a1f4eb4d3e80012c9b3e70000"
}
}
],
"next": "NjcyYTFmNGViNGQzZTgwMDEyYzliM2U3"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "USER_NOT_HAVE_WALLET_PERMISSION",
"origin": "BANKING",
"message": "You do not have permission to perform this action"
}{
"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": "limit",
"message": "Invalid input: expected integer, received string",
"code": "LIMIT_TYPE_ERROR"
}
]
}List the realm's Pix charges
Lists the Pix charges of every organization in the realm, newest first.
GET
/
realms
/
{realmId}
/
pix-billing
List the realm's Pix charges
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billingimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing', 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}/pix-billing",
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}/pix-billing"
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}/pix-billing")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-billing")
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{
"items": [
{
"_id": "672a1f4eb4d3e80012c9b3e7",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"status": "ACTIVE",
"txnCurrency": "986",
"txnAmount": 28500,
"txnCanAmountChange": false,
"txnFineAmount": {
"amount": 2,
"amountType": "PERCENT"
},
"txnInterestAmount": {
"amount": 1,
"amountType": "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS"
},
"txnDiscountAmount": {
"amount": 0,
"amountType": "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS"
},
"txnRebateAmount": {
"amount": 0,
"amountType": "FIXED_VALUE"
},
"dueDate": "2026-11-20T00:00:00.000Z",
"expiresAt": "2026-12-20T00:00:00.000Z",
"description": "Pedido 4821",
"customer": {
"name": "Juliana Ribeiro",
"document": "12345678909",
"email": "juliana.ribeiro@exemplo.com.br",
"address": {
"street": "Avenida Paulista",
"number": "1578",
"neighborhood": "Bela Vista",
"postalCode": "01310-200",
"city": "São Paulo",
"state": "SP",
"complement": "Sala 12"
}
},
"confirmedAmount": 0,
"confirmedAmountAuthorized": 0,
"createdAt": "2026-11-05T18:21:34.112Z",
"updatedAt": "2026-11-05T18:21:35.004Z",
"__v": 0,
"emv": "00020101021226900014br.gov.bcb.pix2568qrcodes.exemplo.com.br/v2/cobv/b8c1d3e54f2a4c6b9d7e1a2b3c4d5e6f5204000053039865802BR5915Loja Exemplo6009Sao Paulo62070503***6304A1B2",
"key": "financeiro@lojaexemplo.com.br",
"confirmedAt": "2026-11-18T14:32:07.512Z",
"canceledAt": "2026-11-19T09:15:42.087Z",
"external": {
"pixBillingId": "b8c1d3e5-4f2a-4c6b-9d7e-1a2b3c4d5e6f",
"locationId": "d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a",
"transactionId": "672a1f4eb4d3e80012c9b3e70000"
}
}
],
"next": "NjcyYTFmNGViNGQzZTgwMDEyYzliM2U3"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "USER_NOT_HAVE_WALLET_PERMISSION",
"origin": "BANKING",
"message": "You do not have permission to perform this action"
}{
"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": "limit",
"message": "Invalid input: expected integer, received string",
"code": "LIMIT_TYPE_ERROR"
}
]
}Page with
limit + next. Any other query parameter filters by the exact value of that field of the charge — for example ?organizationId=c4bd3f21-dfbd-44e8-8055-68ba15bed410 or ?status=PAID; a value that doesn’t fit the field (?dueDate=tomorrow) fails the request. Only the charges of the environment in x-environment are listed, so send x-environment: LIVE for production ones.
Only a realm admin can list them.Headers
Environment whose charges you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST ones; any other value is rejected.
Available options:
LIVE, TEST Path Parameters
ID of your realm.
Format: UUID
Query Parameters
Cursor returned as next by the previous page. Omit it for the first page.
Page size. Defaults to 15.
Required range:
x > 0