Get a Pix Automatic authorization
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}"
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}', 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}",
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}"
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}")
.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}")
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": "6729f3e1b4d3e80012c9a7c1",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixDict": "financeiro@academiamovimento.com.br",
"status": "SCHEDULED",
"debitParty": {
"type": "INDIVIDUAL",
"name": "Juliana Ribeiro",
"email": "juliana.ribeiro@exemplo.com.br",
"document": "12345678909"
},
"paymentUrl": "https://pay.portao3.com.br/2d902e74-7ca0-4f6c-9c83-4b5e6f708192",
"schedule": {
"type": "MONTHLY",
"minAmount": 18990,
"maxAmount": 18990,
"startDate": "2026-12-08T00:00:00.000Z",
"endDate": "2027-11-11T00:00:00.000Z"
},
"external": {
"customerId": "0b7e0c52-5a8e-4d4a-9a61-2f3c4d5e6f70",
"recipientId": "1c8f1d63-6b9f-4e5b-8b72-3a4d5e6f7081",
"requestId": "2d902e74-7ca0-4f6c-9c83-4b5e6f708192"
},
"createdAt": "2026-11-05T14:20:31.402Z",
"updatedAt": "2026-11-05T14:31:07.118Z",
"schedules": [
{
"_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
}
],
"description": "Mensalidade Academia Movimento",
"paymentLinkValidity": "2027-11-11T03:00:00.000Z",
"firstPayment": {
"_id": "6729f3e1b4d3e80012c9a7c2",
"amount": 18990,
"date": "2026-11-10T00:00:00.000Z",
"description": "Primeira mensalidade"
},
"__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 authorization
Returns a Pix Automático authorization with all its charges in schedules: the first payment (isFirstPayment true) and each recurring charge, with its status.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
pix-billing-automatic
/
{pixBillingAutomaticId}
Get a Pix Automatic authorization
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}"
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}', 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}",
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}"
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}")
.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}")
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": "6729f3e1b4d3e80012c9a7c1",
"environment": "LIVE",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"pixDict": "financeiro@academiamovimento.com.br",
"status": "SCHEDULED",
"debitParty": {
"type": "INDIVIDUAL",
"name": "Juliana Ribeiro",
"email": "juliana.ribeiro@exemplo.com.br",
"document": "12345678909"
},
"paymentUrl": "https://pay.portao3.com.br/2d902e74-7ca0-4f6c-9c83-4b5e6f708192",
"schedule": {
"type": "MONTHLY",
"minAmount": 18990,
"maxAmount": 18990,
"startDate": "2026-12-08T00:00:00.000Z",
"endDate": "2027-11-11T00:00:00.000Z"
},
"external": {
"customerId": "0b7e0c52-5a8e-4d4a-9a61-2f3c4d5e6f70",
"recipientId": "1c8f1d63-6b9f-4e5b-8b72-3a4d5e6f7081",
"requestId": "2d902e74-7ca0-4f6c-9c83-4b5e6f708192"
},
"createdAt": "2026-11-05T14:20:31.402Z",
"updatedAt": "2026-11-05T14:31:07.118Z",
"schedules": [
{
"_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
}
],
"description": "Mensalidade Academia Movimento",
"paymentLinkValidity": "2027-11-11T03:00:00.000Z",
"firstPayment": {
"_id": "6729f3e1b4d3e80012c9a7c2",
"amount": 18990,
"date": "2026-11-10T00:00:00.000Z",
"description": "Primeira mensalidade"
},
"__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 it to follow the authorization after you create it:
status moves from CREATED to INITIATED and SCHEDULED as the payer grants it, and each charge from CREATED to SCHEDULED and PAID. 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}$Response
Successful response
An authorization with all its charges.
ID of the authorization. Use it as {pixBillingAutomaticId}.
Example:
"6729f3e1b4d3e80012c9a7c1"
Environment of the authorization: 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"
The wallet's Pix key the payments go to.
Example:
"financeiro@academiamovimento.com.br"
Where the authorization stands:
CREATED— waiting for the payer to openpaymentUrland grant it in their bank.INITIATED— the payer started the authorization.SCHEDULED— the payer granted it; the charges followschedules. It staysSCHEDULEDafter the last charge.CANCELED— you canceled it.REVOKED— the payer revoked it in their bank; the pending charges were canceled.EXPIRED— the payer didn't grant it before the first charges were due.FAILED— not used today.
Available options:
CREATED, INITIATED, SCHEDULED, CANCELED, EXPIRED, REVOKED, FAILED Example:
"SCHEDULED"
The payer.
Show child attributes
Show child attributes
Link where the payer reviews the authorization and grants it in their bank. Send it to the payer.
Example:
"https://pay.portao3.com.br/2d902e74-7ca0-4f6c-9c83-4b5e6f708192"
The recurrence the payer authorizes.
Show child attributes
Show child attributes
References at the payment institution.
Show child attributes
Show child attributes
When the authorization was created.
Example:
"2026-11-05T14:20:31.402Z"
When the authorization last changed.
Example:
"2026-11-05T14:31:07.118Z"
Every charge of the authorization: the first payment and each recurring charge.
Show child attributes
Show child attributes
Description of the authorization, shown to the payer. It is also the description of each recurring charge.
Example:
"Mensalidade Academia Movimento"
Until when paymentUrl can be used — the end of the authorization. null when it isn't known.
Example:
"2027-11-11T03:00:00.000Z"
The first payment, when you asked for one.
Show child attributes
Show child attributes
Internal revision counter of the record.
Example:
0