Get a Pix Automatic charge
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}"
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}', 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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}",
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}"
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}")
.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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}")
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": "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
}{
"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 a Pix Automatic charge
Returns one charge of a Pix Automático authorization — the first payment or a recurring charge — with its status, due date and, once it is sent to the payer’s bank, its references; error says why a failed charge failed.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
pix-billing-automatic
/
{pixBillingAutomaticId}
/
schedules
/
{pixBillingAutomaticScheduleId}
Get a Pix Automatic charge
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}"
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}', 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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}",
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}"
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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}")
.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/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}")
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": "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
}{
"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"
}
]
}Use
default as walletId for the organization’s main wallet. Any member of the organization can read it.Headers
Environment of the authorization: LIVE (production) or TEST (sandbox). When you omit it, TEST is used; any other value is rejected.
Available options:
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).
Pattern:
^[0-9a-fA-F]{24}$ID of the wallet that receives the payments (24 hexadecimal characters), or default for the organization's main wallet.
Pattern:
^([0-9a-fA-F]{24}|default)$ID of the authorization — its _id (24 hexadecimal characters).
Pattern:
^[0-9a-fA-F]{24}$ID of the charge — its _id in the authorization's schedules (24 hexadecimal characters).
Pattern:
^[0-9a-fA-F]{24}$Response
Successful response
One charge of an authorization: the first payment or a recurring charge.
ID of the charge. Use it as {pixBillingAutomaticScheduleId}.
Example:
"6729f3e1b4d3e80012c9a7d4"
Environment of the charge: LIVE (production) or TEST (sandbox).
Available options:
LIVE, TEST Example:
"LIVE"
ID of the realm.
Example:
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of the organization.
Example:
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
ID of the organization's account.
Example:
"66f2a1c7b4d3e80012c9a0b4"
ID of the wallet that receives the money.
Example:
"66f2a3d1b4d3e80012c9a0d2"
ID of the authorization this charge belongs to.
Example:
"6729f3e1b4d3e80012c9a7c1"
Amount of the charge, in cents.
Example:
18990
Where the charge stands:
CREATED— waiting. A recurring charge is sent to the payer's bank between 2 and 10 days beforescheduledTo, once the payer has granted the authorization; until then you can change its amount. The first payment goes with the authorization itself and is charged when the payer grants it. A recurring charge stillCREATEDafter its date: withoutexternal.scheduleId, the payer's bank most likely refused it when it was sent (its history has aSCHEDULE_ATTEMPT_FAILEDevent) — in rare cases the bank accepted it and the confirmation was lost, so confirm with support before charging it another way; with one, the bank is still processing it — wait for the outcome.SCHEDULED— sent to the payer's bank, which debits it onscheduledTo.PAID— paid; the money is in the wallet.FAILED— the payer's bank couldn't debit it and it won't be tried again: a final refusal (for example, the payer's limit for the period was reached) or the new attempts ran out.errorsays why.SCHEDULE_ERROR— it couldn't be sent to the payer's bank and won't be.errorsays why; treat it likeFAILED.CANCELED— canceled, by you or because the authorization was canceled or revoked.EXPIRED— the payer never granted the authorization.RETRY— not used today.
Available options:
CREATED, SCHEDULED, CANCELED, EXPIRED, FAILED, SCHEDULE_ERROR, PAID, RETRY Example:
"SCHEDULED"
Day the charge is debited, at midnight UTC: its due date, or the date of the latest new attempt after a failure.
Example:
"2026-12-10T00:00:00.000Z"
The attempts to debit the charge, oldest first: the first, on scheduledTo, then each new attempt asked for after the payer's bank failed to debit it.
Show child attributes
Show child attributes
When the charge was created.
Example:
"2026-11-05T14:20:31.655Z"
When the charge last changed.
Example:
"2026-12-03T03:30:12.904Z"
Description of the charge.
Example:
"Mensalidade Academia Movimento"
true for the first payment, absent for a recurring charge.
Example:
true
References at the payment institution, once the charge is sent to the payer's bank.
Show child attributes
Show child attributes
Why the charge failed, when it did.
Show child attributes
Show child attributes
Internal revision counter of the record.
Example:
0