curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedulesimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules"
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}/pix-billing-automatic/schedules', 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}/pix-billing-automatic/schedules",
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}/pix-billing-automatic/schedules"
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}/pix-billing-automatic/schedules")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules")
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": "6729f3e1b4d3e80012c9a7d4",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixBillingAutomaticId": "6729f3e1b4d3e80012c9a7c1",
"amount": 18990,
"status": "SCHEDULED",
"scheduledTo": "2026-12-10T00:00:00.000Z",
"attempts": [
{
"_id": "672c1f00b4d3e80012c9a9f1",
"attempt": 1,
"date": "2026-12-10T00:00:00.000Z"
}
],
"createdAt": "2026-11-05T14:20:31.655Z",
"updatedAt": "2026-12-03T03:30:12.904Z",
"description": "Mensalidade Academia Movimento",
"isFirstPayment": true,
"external": {
"scheduleId": "3ea13f85-8db1-4a7d-8d94-5c6f708192a3",
"endToEndId": "E00000000202612101203a1b2c3d4e5f",
"scheduleAttemptsCount": 1
},
"error": {
"code": "LIMITE_PERIODO_VALOR_EXCEDIDO",
"description": "Limite de valor do período excedido",
"detail": "O valor do pagamento excede o limite do período",
"title": "Payment failed"
},
"__v": 0
}
],
"next": "NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Q0"
}{
"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": "order",
"message": "Invalid option: expected one of \"ASC\"|\"DESC\"",
"code": "ORDER_ONE_OF"
}
]
}List a wallet's Pix Automatic charges
Lists the charges of all the wallet’s Pix Automático authorizations, the most recently created first.
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedulesimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules"
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}/pix-billing-automatic/schedules', 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}/pix-billing-automatic/schedules",
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}/pix-billing-automatic/schedules"
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}/pix-billing-automatic/schedules")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules")
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": "6729f3e1b4d3e80012c9a7d4",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixBillingAutomaticId": "6729f3e1b4d3e80012c9a7c1",
"amount": 18990,
"status": "SCHEDULED",
"scheduledTo": "2026-12-10T00:00:00.000Z",
"attempts": [
{
"_id": "672c1f00b4d3e80012c9a9f1",
"attempt": 1,
"date": "2026-12-10T00:00:00.000Z"
}
],
"createdAt": "2026-11-05T14:20:31.655Z",
"updatedAt": "2026-12-03T03:30:12.904Z",
"description": "Mensalidade Academia Movimento",
"isFirstPayment": true,
"external": {
"scheduleId": "3ea13f85-8db1-4a7d-8d94-5c6f708192a3",
"endToEndId": "E00000000202612101203a1b2c3d4e5f",
"scheduleAttemptsCount": 1
},
"error": {
"code": "LIMITE_PERIODO_VALOR_EXCEDIDO",
"description": "Limite de valor do período excedido",
"detail": "O valor do pagamento excede o limite do período",
"title": "Payment failed"
},
"__v": 0
}
],
"next": "NjcyOWYzZTFiNGQzZTgwMDEyYzlhN2Q0"
}{
"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": "order",
"message": "Invalid option: expected one of \"ASC\"|\"DESC\"",
"code": "ORDER_ONE_OF"
}
]
}minDueDate, maxDueDate) and by status, which takes its values comma-separated (?status=SCHEDULED,PAID); sort with order and page with limit + next. Use it to follow what is due and what was paid. Only the charges of the environment in x-environment are listed, so send x-environment: LIVE for production ones. Use default as walletId for the organization’s main wallet.
Any member of the organization 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.
LIVE, TEST Path Parameters
ID of your realm.
Format: UUID
ID of the organization.
Format: UUID
ID of the organization's account (24 hexadecimal characters).
^[0-9a-fA-F]{24}$ID of the wallet that receives the payments (24 hexadecimal characters), or default for the organization's main wallet.
^([0-9a-fA-F]{24}|default)$Query Parameters
Only charges due (scheduledTo) on or after this date: an ISO 8601 date (2026-12-01, midnight UTC) or date-time.
Only charges due on or before this date, in the same format.
Only charges in these statuses (case-insensitive): CREATED, SCHEDULED, PAID, FAILED, SCHEDULE_ERROR, CANCELED, EXPIRED or RETRY. Other values match no charge.
Example (comma-separated list): ?status=SCHEDULED,PAID
64Order of the charges by when they were created: 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