Get a schedule
curl --request GET \
--url https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}import requests
url = "https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}', 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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}",
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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}"
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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}")
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": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b",
"amount": 150000,
"scheduledAt": "2026-11-05T03:00:00.000Z",
"type": "PIX_TRANSFER",
"status": "SCHEDULED",
"organization": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"account": "6702b1e4a9c3d80012f4a7b1",
"wallet": "6702b1e4a9c3d80012f4a7b5",
"createdAt": "2026-10-20T14:32:10.512Z",
"updatedAt": "2026-10-20T14:32:10.512Z",
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"additionalInfos": {
"currency": "BRL",
"allowAmountChange": false,
"discountAmount": null,
"interestAmount": null,
"fineAmount": null,
"originalAmount": 150000,
"amount": 150000,
"description": "Office rent — November",
"dueDate": null,
"status": "REQUESTED",
"expiresAt": null,
"confirmedAmount": null,
"payee": "Imobiliária Exemplo Ltda",
"payeeDocument": "12345678000190",
"payer": "Empresa Exemplo S.A.",
"payerDocument": "98765432000110",
"bankSlip": {
"digitableLine": "23793381286000000000900000000000184340000150000",
"minAmount": null,
"maxAmount": null,
"issuer": "Banco Exemplo S.A.",
"type": "GENERIC"
},
"pix": {
"endToEndId": null,
"transactionType": "TRANSFER",
"withdrawalAmount": null,
"pixCopyPaste": null,
"qrCodeType": null,
"pixKey": "financeiro@imobiliariaexemplo.com.br",
"purchaseAmount": null,
"initiationType": "DICT",
"creditParty": {
"bankIspb": "60701190",
"document": "12345678000190",
"name": "Imobiliária Exemplo Ltda"
},
"debitParty": {
"accountNumber": "123456",
"accountType": "CACC",
"bankIspb": "13140088",
"branch": "0001",
"document": "98765432000110",
"name": "Empresa Exemplo S.A."
}
},
"p2pTransfer": {
"payeeRealmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"payeeOrganizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"payeeWalletId": "6702b1e4a9c3d80012f4a7b9",
"payeeAccountId": "6702b1e4a9c3d80012f4a7b1",
"payeeCategory": "FLEX_NATIONAL"
}
},
"description": "Office rent — November",
"retryCount": null,
"category": "FLEX_NATIONAL",
"cancelledBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"cancelledAt": "2026-10-22T11:05:41.207Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "SCHEDULING_ADMIN_REQUIRED",
"origin": "SCHEDULING",
"message": "Organization admin required"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TRANSACTION_SCHEDULE_NOT_FOUND",
"origin": "SCHEDULING",
"message": "Transaction schedule not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "SCHEDULING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "scheduleId",
"message": "Invalid UUID",
"code": "SCHEDULEID_UUID"
}
]
}Get a schedule
Returns a schedule and the payment behind it.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
schedules
/
{scheduleId}
Get a schedule
curl --request GET \
--url https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}import requests
url = "https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}', 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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}",
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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}"
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.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scheduling.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}")
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": "3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b",
"amount": 150000,
"scheduledAt": "2026-11-05T03:00:00.000Z",
"type": "PIX_TRANSFER",
"status": "SCHEDULED",
"organization": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"realm": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"account": "6702b1e4a9c3d80012f4a7b1",
"wallet": "6702b1e4a9c3d80012f4a7b5",
"createdAt": "2026-10-20T14:32:10.512Z",
"updatedAt": "2026-10-20T14:32:10.512Z",
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"additionalInfos": {
"currency": "BRL",
"allowAmountChange": false,
"discountAmount": null,
"interestAmount": null,
"fineAmount": null,
"originalAmount": 150000,
"amount": 150000,
"description": "Office rent — November",
"dueDate": null,
"status": "REQUESTED",
"expiresAt": null,
"confirmedAmount": null,
"payee": "Imobiliária Exemplo Ltda",
"payeeDocument": "12345678000190",
"payer": "Empresa Exemplo S.A.",
"payerDocument": "98765432000110",
"bankSlip": {
"digitableLine": "23793381286000000000900000000000184340000150000",
"minAmount": null,
"maxAmount": null,
"issuer": "Banco Exemplo S.A.",
"type": "GENERIC"
},
"pix": {
"endToEndId": null,
"transactionType": "TRANSFER",
"withdrawalAmount": null,
"pixCopyPaste": null,
"qrCodeType": null,
"pixKey": "financeiro@imobiliariaexemplo.com.br",
"purchaseAmount": null,
"initiationType": "DICT",
"creditParty": {
"bankIspb": "60701190",
"document": "12345678000190",
"name": "Imobiliária Exemplo Ltda"
},
"debitParty": {
"accountNumber": "123456",
"accountType": "CACC",
"bankIspb": "13140088",
"branch": "0001",
"document": "98765432000110",
"name": "Empresa Exemplo S.A."
}
},
"p2pTransfer": {
"payeeRealmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"payeeOrganizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"payeeWalletId": "6702b1e4a9c3d80012f4a7b9",
"payeeAccountId": "6702b1e4a9c3d80012f4a7b1",
"payeeCategory": "FLEX_NATIONAL"
}
},
"description": "Office rent — November",
"retryCount": null,
"category": "FLEX_NATIONAL",
"cancelledBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"cancelledAt": "2026-10-22T11:05:41.207Z"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "SCHEDULING_ADMIN_REQUIRED",
"origin": "SCHEDULING",
"message": "Organization admin required"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "TRANSACTION_SCHEDULE_NOT_FOUND",
"origin": "SCHEDULING",
"message": "Transaction schedule not found"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "SCHEDULING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "scheduleId",
"message": "Invalid UUID",
"code": "SCHEDULEID_UUID"
}
]
}additionalInfos is read live from the payment when you ask: the Pix or bank slip as it stands now (amounts, due date, who pays and who receives), or the receiving wallet of a transfer between wallets. Use the schedule’s status to know whether it already ran. Only an organization admin can read it.Path Parameters
ID of your realm.
Format: UUID
ID of the organization the wallet belongs to.
Format: UUID
ID of the account (24 hexadecimal characters).
Pattern:
^[0-9a-fA-F]{24}$ID of the wallet the schedule pays from (24 hexadecimal characters).
Pattern:
^[0-9a-fA-F]{24}$ID of the schedule.
Format: UUID
Response
Successful response
A scheduled payment, with the payment behind it.
ID of the schedule.
Example:
"3b9f7c2e-5d41-4e8a-9a6f-1c2d3e4f5a6b"
Amount to pay, in cents (BRL).
Example:
150000
When the payment is due to run.
Example:
"2026-11-05T03:00:00.000Z"
What the schedule pays: a Pix to a key (PIX_TRANSFER), a Pix QR code (PIX_PAYMENT), a bank slip (BANK_SLIP_PAYMENT) or a transfer to another wallet of the same account (P2P_TRANSFER).
Available options:
BANK_SLIP_PAYMENT, PIX_PAYMENT, P2P_TRANSFER, PIX_TRANSFER Example:
"PIX_TRANSFER"
Where the schedule is: waiting for its day (SCHEDULED), running (PROCESSING), paid (DONE), failed (FAILED) or cancelled (CANCELLED).
Available options:
SCHEDULED, PROCESSING, CANCELLED, FAILED, DONE Example:
"SCHEDULED"
ID of the organization the schedule belongs to.
Example:
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
ID of the realm the schedule belongs to.
Example:
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of the account that pays.
Example:
"6702b1e4a9c3d80012f4a7b1"
ID of the wallet that pays.
Example:
"6702b1e4a9c3d80012f4a7b5"
When the schedule was created.
Example:
"2026-10-20T14:32:10.512Z"
When the schedule was last changed.
Example:
"2026-10-20T14:32:10.512Z"
ID of the user who created the schedule.
Example:
"e3553bc1-5e20-4e17-b22a-a796fda0aa99"
ID of the user who last changed the schedule.
Example:
"e3553bc1-5e20-4e17-b22a-a796fda0aa99"
The payment behind the schedule.
Show child attributes
Show child attributes
Description given when the schedule was created.
Example:
"Office rent — November"
Number of execution attempts that failed. Absent or null before any failure.
Example:
null
Balance category of the wallet the amount is taken from.
Available options:
FLEX_NATIONAL, FLEX_INTERNATIONAL, FOOD, GAS, MOBILITY, TOLL, FLEX_NATIONAL_WITHOUT_WITHDRAWALS, ADS, SAAS, HOTEL, AIRLINES, TRAVEL, BLOCKED, CASHBACK Example:
"FLEX_NATIONAL"
ID of the user who cancelled the schedule. Present only on a cancelled schedule.
Example:
"e3553bc1-5e20-4e17-b22a-a796fda0aa99"
When the schedule was cancelled. Present only on a cancelled schedule.
Example:
"2026-10-22T11:05:41.207Z"