curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}"
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}/transfer-requests/{transferRequestId}', 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}/transfer-requests/{transferRequestId}",
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}/transfer-requests/{transferRequestId}"
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}/transfer-requests/{transferRequestId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}")
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": "6720d4f1b4d3e80012c9a2e7",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"environment": "LIVE",
"destinationCategory": "FLEX_NATIONAL",
"amount": 250000,
"requester": {
"email": "mariana.costa@acme.com.br",
"userId": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"name": "Mariana Costa",
"id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99"
},
"status": "REQUESTED",
"createdAt": "2026-11-02T13:10:22.000Z",
"updatedAt": "2026-11-02T13:10:22.000Z",
"walletName": "Marketing",
"defaultWalletId": "66f2a1d0b4d3e80012c9a0b9",
"txnCurrency": "986",
"description": "Verba de eventos — novembro",
"policyRequestId": "4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a",
"autoResolutionRequestedAt": "2026-11-02T13:12:05.000Z",
"scheduledAt": "2026-11-10T00:00:00.000Z",
"scheduledTimeZone": "America/Sao_Paulo",
"scheduleId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"approvalExpiresAt": "2026-11-03T00:00:00.000Z",
"confirmedAt": "2026-11-02T13:12:07.000Z",
"canceledAt": "2026-11-02T15:40:00.000Z",
"failureReason": "INSUFFICIENT_FUNDS",
"customFields": {
"cost-center": "CC-1020"
},
"decision": {},
"deniedAt": "2025-11-20T18:05:00.000Z",
"originAccountId": "66f2a1c7b4d3e80012c9a0b4",
"originWalletId": "66f2a1d0b4d3e80012c9a0b9",
"sourceCategory": "FLEX_INTERNATIONAL"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}{
"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 transfer request
Returns a transfer request of the wallet.
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}"
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}/transfer-requests/{transferRequestId}', 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}/transfer-requests/{transferRequestId}",
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}/transfer-requests/{transferRequestId}"
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}/transfer-requests/{transferRequestId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}")
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": "6720d4f1b4d3e80012c9a2e7",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"walletId": "66f2a3d1b4d3e80012c9a0d2",
"environment": "LIVE",
"destinationCategory": "FLEX_NATIONAL",
"amount": 250000,
"requester": {
"email": "mariana.costa@acme.com.br",
"userId": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"name": "Mariana Costa",
"id": "e3553bc1-5e20-4e17-b22a-a796fda0aa99"
},
"status": "REQUESTED",
"createdAt": "2026-11-02T13:10:22.000Z",
"updatedAt": "2026-11-02T13:10:22.000Z",
"walletName": "Marketing",
"defaultWalletId": "66f2a1d0b4d3e80012c9a0b9",
"txnCurrency": "986",
"description": "Verba de eventos — novembro",
"policyRequestId": "4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a",
"autoResolutionRequestedAt": "2026-11-02T13:12:05.000Z",
"scheduledAt": "2026-11-10T00:00:00.000Z",
"scheduledTimeZone": "America/Sao_Paulo",
"scheduleId": "8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"approvalExpiresAt": "2026-11-03T00:00:00.000Z",
"confirmedAt": "2026-11-02T13:12:07.000Z",
"canceledAt": "2026-11-02T15:40:00.000Z",
"failureReason": "INSUFFICIENT_FUNDS",
"customFields": {
"cost-center": "CC-1020"
},
"decision": {},
"deniedAt": "2025-11-20T18:05:00.000Z",
"originAccountId": "66f2a1c7b4d3e80012c9a0b4",
"originWalletId": "66f2a1d0b4d3e80012c9a0b9",
"sourceCategory": "FLEX_INTERNATIONAL"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}{
"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"
}
]
}EXPIRED. Send x-environment: LIVE for production wallets.
Organization admins can read every wallet’s requests; other users only those of the wallets shared with them, in any role.Headers
Environment of the wallet: LIVE (production) or TEST (sandbox). When you omit it, the request runs in TEST; any other value is rejected.
LIVE, TEST Path Parameters
ID of your realm.
Format: UUID
ID of the organization the wallet belongs to.
Format: UUID
ID of the organization's account (24 hexadecimal characters).
^[0-9a-fA-F]{24}$ID of the wallet the transfer request belongs to (24 hexadecimal characters).
^[0-9a-fA-F]{24}$ID of the transfer request (24 hexadecimal characters).
^[0-9a-fA-F]{24}$Response
Successful response
A transfer request: a wallet asking the organization's main wallet for money — or sending money back to it — that moves only once the request is confirmed, after approval when the organization's business policies require it.
ID of the transfer request.
"6720d4f1b4d3e80012c9a2e7"
ID of the realm.
"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"
ID of the organization.
"c4bd3f21-dfbd-44e8-8055-68ba15bed410"
ID of the account both wallets belong to.
"66f2a1c7b4d3e80012c9a0b4"
ID of the wallet that receives the money — or sends it back, when amount is negative.
"66f2a3d1b4d3e80012c9a0d2"
Environment of the request: LIVE (production) or TEST (sandbox).
LIVE, TEST "LIVE"
Balance category of walletId the transfer moves: where the money lands when amount is positive, and where it is taken from when amount is negative. The main wallet always uses FLEX_INTERNATIONAL.
FLEX_NATIONAL, FLEX_INTERNATIONAL, FOOD, GAS, MOBILITY, TOLL, FLEX_NATIONAL_WITHOUT_WITHDRAWALS, ADS, SAAS, HOTEL, AIRLINES, TRAVEL, BLOCKED, CASHBACK "FLEX_NATIONAL"
Amount in cents, never zero. Positive moves money from the organization's main wallet into walletId; negative sends it from walletId back to the main wallet.
250000
Who created the request.
Show child attributes
Show child attributes
Status of the request:
REQUESTED— created; it can still be edited, sent for approval or confirmed.PENDING_APPROVAL— waiting for the approvers the business policy names.CONFIRMED— the money moved.SCHEDULED— confirmed for a future day; the money moves onscheduledAt.CANCELLED— cancelled before the money moved.EXPIRED— the approval deadline passed before it was approved.FAILED— the transfer was refused, for the reason infailureReason.DENIED— only on a few requests from the first version of transfer requests.
PENDING_APPROVAL, REQUESTED, CONFIRMED, CANCELLED, EXPIRED, FAILED, SCHEDULED, DENIED "REQUESTED"
When the request was created.
"2026-11-02T13:10:22.000Z"
When the request last changed.
"2026-11-02T13:10:22.000Z"
Name of that wallet when the request was created. Absent when the wallet had no name.
"Marketing"
ID of the organization's main wallet when the request was created: the other side of the transfer. Absent only on a few requests from the first version of transfer requests, which carry originWalletId instead.
"66f2a1d0b4d3e80012c9a0b9"
Currency of the amount, as an ISO 4217 numeric code: 986 (Brazilian real).
"986"
Description of the transfer. Absent when none was given.
"Verba de eventos — novembro"
ID of the approval request opened when the request was sent for approval, or of the automatic approval that confirmed it. Absent otherwise.
"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a"
When a confirmation first asked for the automatic approval of the matching business policy. Absent when no confirmation needed it.
"2026-11-02T13:12:05.000Z"
Day the transfer is scheduled for. Absent when it transfers as soon as it is confirmed.
"2026-11-10T00:00:00.000Z"
Time zone scheduledAt was read in — America/Sao_Paulo, the only one supported. Present only with scheduledAt.
"America/Sao_Paulo"
ID of the schedule created when a request for a future day was confirmed. Cancel the request to cancel it.
"8c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f"
Deadline for the approval: 21:00 (São Paulo time) of the day the transfer is for, and at least one hour after the request was sent for approval. Present once it was sent for approval.
"2026-11-03T00:00:00.000Z"
When the money moved.
"2026-11-02T13:12:07.000Z"
When the request was cancelled.
"2026-11-02T15:40:00.000Z"
Why the transfer failed, as an error code — for example INSUFFICIENT_FUNDS, ACCOUNT_BLOCKED or BANKING_PROVIDER_UNAVAILABLE. Only on FAILED requests.
"INSUFFICIENT_FUNDS"
Values of the organization's transaction custom fields, keyed by each field's slug. Absent when the request has none.
Example: {"cost-center":"CC-1020"}
Show child attributes
Show child attributes
{ "cost-center": "CC-1020" }
Decision recorded on a few requests from the first version of transfer requests.
Show child attributes
Show child attributes
When the request was denied, on a few requests from the first version of transfer requests.
"2025-11-20T18:05:00.000Z"
Account the money came from, on a few requests from the first version of transfer requests.
"66f2a1c7b4d3e80012c9a0b4"
Wallet the money came from, on a few requests from the first version of transfer requests.
"66f2a1d0b4d3e80012c9a0b9"
Balance category the money came from, on a few requests from the first version of transfer requests.
FLEX_NATIONAL, FLEX_INTERNATIONAL, FOOD, GAS, MOBILITY, TOLL, FLEX_NATIONAL_WITHOUT_WITHDRAWALS, ADS, SAAS, HOTEL, AIRLINES, TRAVEL, BLOCKED, CASHBACK "FLEX_INTERNATIONAL"