curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/historyimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history', 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}/pix-billing-automatic/{pixBillingAutomaticId}/history",
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}/pix-billing-automatic/{pixBillingAutomaticId}/history"
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}/pix-billing-automatic/{pixBillingAutomaticId}/history")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history")
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": "672a0b7cb4d3e80012c9a8e3",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixBillingAutomaticId": "6729f3e1b4d3e80012c9a7c1",
"code": "SCHEDULE_ATTEMPT_SUCCEEDED",
"description": "Agendamento realizado com sucesso",
"origin": "P3",
"eventNature": "SUCCESS",
"createdAt": "2026-12-03T03:30:12.911Z",
"updatedAt": "2026-12-03T03:30:12.911Z",
"pixBillingAutomaticItemId": "6729f3e1b4d3e80012c9a7d4",
"flowCode": "CREATE_PIX_AUTOMATIC_SCHEDULE",
"error": {
"code": "AUTOMATIC_PIX_PAYMENT_CANCEL_SAME_DATE",
"description": "Cannot cancel a payment on or after its payment date",
"message": "Cannot cancel a payment on or after its payment date"
},
"__v": 0
}
],
"next": "NjcyYTBiN2NiNGQzZTgwMDEyYzlhOGUz"
}{
"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": "order",
"message": "Invalid option: expected one of \"ASC\"|\"DESC\"",
"code": "ORDER_ONE_OF"
}
]
}List an authorization's history
Lists the events of a Pix Automático authorization and of its charges, newest first: its creation and each cancellation, each update from the payer’s bank and each step Portão 3 took — with the failure, on the events that record one. A change of a charge’s amount is not recorded.
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/historyimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history', 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}/pix-billing-automatic/{pixBillingAutomaticId}/history",
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}/pix-billing-automatic/{pixBillingAutomaticId}/history"
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}/pix-billing-automatic/{pixBillingAutomaticId}/history")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history")
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": "672a0b7cb4d3e80012c9a8e3",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixBillingAutomaticId": "6729f3e1b4d3e80012c9a7c1",
"code": "SCHEDULE_ATTEMPT_SUCCEEDED",
"description": "Agendamento realizado com sucesso",
"origin": "P3",
"eventNature": "SUCCESS",
"createdAt": "2026-12-03T03:30:12.911Z",
"updatedAt": "2026-12-03T03:30:12.911Z",
"pixBillingAutomaticItemId": "6729f3e1b4d3e80012c9a7d4",
"flowCode": "CREATE_PIX_AUTOMATIC_SCHEDULE",
"error": {
"code": "AUTOMATIC_PIX_PAYMENT_CANCEL_SAME_DATE",
"description": "Cannot cancel a payment on or after its payment date",
"message": "Cannot cancel a payment on or after its payment date"
},
"__v": 0
}
],
"next": "NjcyYTBiN2NiNGQzZTgwMDEyYzlhOGUz"
}{
"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": "order",
"message": "Invalid option: expected one of \"ASC\"|\"DESC\"",
"code": "ORDER_ONE_OF"
}
]
}pixBillingAutomaticItemId), by code, origin, flow (the flowCode) and eventNature, which take their values comma-separated (?eventNature=SUCCESS,ERROR), and by period (startAt, endAt); sort with order and page with limit + next. Filtering by pixBillingAutomaticItemId leaves out the events of sending a charge to the payer’s bank, which don’t record the charge; and look for failures in error, not only in ERROR events. The events of both environments are listed. An unknown authorization has none: the page is empty.
Any member of the organization can list them.Path Parameters
ID of your realm.
Format: UUID
ID of the organization.
Format: UUID
ID of the authorization — its _id (24 hexadecimal characters).
^[0-9a-fA-F]{24}$Query Parameters
Only events of these wallets (24 hexadecimal characters each). The authorization has one wallet, so this only narrows to it or to nothing.
Example (comma-separated list): ?walletId=66f2a3d1b4d3e80012c9a0d2,66f2a3d1b4d3e80012c9a0e5
^[0-9a-fA-F]{24}$Only events about these charges — their _id in schedules (24 hexadecimal characters each). The events of sending a charge to the payer's bank don't record the charge, so they are left out.
Example (comma-separated list): ?pixBillingAutomaticItemId=6729f3e1b4d3e80012c9a7d4,6729f3e1b4d3e80012c9a7d5
^[0-9a-fA-F]{24}$Only events with these codes (case-insensitive) — the code values in the response. Other values match no event.
Example (comma-separated list): ?code=SCHEDULE_PAID,SCHEDULE_FAILED
64Only events with these origins (case-insensitive) — the origin values in the response, such as P3. Other values match no event.
Example: ?origin=P3
64Only events of these processes (case-insensitive) — the flowCode values in the response. Other values match no event.
Example (comma-separated list): ?flow=CREATE_PIX_AUTOMATIC_SCHEDULE,UPDATE_PIX_AUTOMATIC_SCHEDULE_STATUS
64Only events of these natures (case-insensitive): FLOW, SUCCESS or ERROR. Other values match no event.
Example (comma-separated list): ?eventNature=SUCCESS,ERROR
64Only events recorded on or after this moment: an ISO 8601 date-time (2026-12-01T03:00:00.000Z) or date (2026-12-01, midnight UTC).
Only events recorded on or before this moment, in the same format.
Order of the events by when they were recorded: DESC (newest first, the default) or ASC (oldest first). Case-insensitive.
ASC, DESC Cursor returned as next by the previous page. Omit it for the first page.
Page size. Defaults to 15.
x > 0