curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/walletsimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets"
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', 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",
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"
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")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets")
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": "66f2a3d1b4d3e80012c9a0d2",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"environment": "LIVE",
"currency": "986",
"status": "ACTIVE",
"role": "CHECKING",
"isSuper": false,
"createdAt": "2024-10-01T12:30:05.000Z",
"updatedAt": "2024-10-01T12:34:41.000Z",
"external": {
"balanceAccountGroupId": "4f6b0e1d-2b3a-4c5d-8e9f-0a1b2c3d4e5f",
"accountNumber": 10023456,
"branch": "0001",
"accountType": "PREPAID"
},
"customFields": {
"cost-center": "CC-1020"
},
"walletProduct": "NORMAL",
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"accountType": "PREPAID",
"__v": 0
}
],
"next": "NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy"
}{
"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": "ids",
"message": "Too big: expected array to have <=100 items",
"code": "IDS_MAX"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}List an account's wallets
Lists the wallets of an account, newest first.
curl --request GET \
--url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/walletsimport requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets"
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', 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",
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"
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")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets")
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": "66f2a3d1b4d3e80012c9a0d2",
"realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
"organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
"accountId": "66f2a1c7b4d3e80012c9a0b4",
"environment": "LIVE",
"currency": "986",
"status": "ACTIVE",
"role": "CHECKING",
"isSuper": false,
"createdAt": "2024-10-01T12:30:05.000Z",
"updatedAt": "2024-10-01T12:34:41.000Z",
"external": {
"balanceAccountGroupId": "4f6b0e1d-2b3a-4c5d-8e9f-0a1b2c3d4e5f",
"accountNumber": 10023456,
"branch": "0001",
"accountType": "PREPAID"
},
"customFields": {
"cost-center": "CC-1020"
},
"walletProduct": "NORMAL",
"createdBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"updatedBy": "e3553bc1-5e20-4e17-b22a-a796fda0aa99",
"accountType": "PREPAID",
"__v": 0
}
],
"next": "NjZmMmEzZDFiNGQzZTgwMDEyYzlhMGQy"
}{
"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": "ids",
"message": "Too big: expected array to have <=100 items",
"code": "IDS_MAX"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider temporarily unavailable, please retry"
}status and type, which take their values comma-separated (?status=ACTIVE,BLOCKED), and page with limit + next. Wallets of the other environment are not listed, so send x-environment: LIVE for production wallets.
Two parameters answer a plain array of wallets instead of a page. ids reads those wallets — each with its name, users, settings, kind and live balances (totalBalance, balances); a listed wallet that can’t be read is left out, but the first one must exist and its balance must be readable. forceBalanceResponse=true adds the live balances of the page’s ACTIVE wallets, leaves out a wallet whose balance can’t be read at that moment, and has no next page.
Any member of the organization can list its wallets.Headers
Environment whose wallets you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST wallets; any other value is rejected.
LIVE, TEST Path Parameters
ID of your realm.
Format: UUID
ID of the organization the account belongs to.
Format: UUID
ID of the organization's account (24 hexadecimal characters).
^[0-9a-fA-F]{24}$Query Parameters
Only wallets in these statuses (case-insensitive): PENDING, ACTIVE, BLOCKED, CANCELLING, CANCELLED, REPROVED, FRAUD_ANALYSIS or FRAUD_CONFIRMED. Other values match no wallet.
Example (comma-separated list): ?status=ACTIVE,BLOCKED
64Only wallets of these kinds (case-insensitive): ORGANIZATION, SHARED, PERSONAL or VEHICLE. Other values match no wallet.
Example (comma-separated list): ?type=SHARED,PERSONAL
64Read these wallets, with their balances, instead of listing. The response is then a plain array of wallets, not a page.
Example (comma-separated list): ?ids=66f2a3d1b4d3e80012c9a0d2,66f2a1d0b4d3e80012c9a0b9
100^[0-9a-fA-F]{24}$true adds the balances of the page's ACTIVE wallets. The response is then a plain array of wallets, not a page.
true, false Cursor returned as next by the previous page. Omit it for the first page.
Page size. Defaults to 15.
x > 0