curl --request POST \ --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction \ --header 'Content-Type: application/json' \ --data '{ "reason": "REFUND_REQUEST", "situationType": "SCAM", "reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."}'
import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction"
payload = {
"reason": "REFUND_REQUEST",
"situationType": "SCAM",
"reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
reason: 'REFUND_REQUEST',
situationType: 'SCAM',
reportDetails: 'A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.'
})
};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction', 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}/transactions/{transactionId}/pix-infraction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'REFUND_REQUEST',
'situationType' => 'SCAM',
'reportDetails' => 'A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction"
payload := strings.NewReader("{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}"
response = http.request(request)
puts response.read_body
{ "_id": "6728e0a4b4d3e80012c9a6b1", "environment": "LIVE", "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b", "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410", "accountId": "66f2a1c7b4d3e80012c9a0b4", "walletId": "66f2a3d1b4d3e80012c9a0d2", "transactionId": "6726b1c2b4d3e80012c9a4f7", "direction": "SENT", "reason": "REFUND_REQUEST", "situationType": "SCAM", "reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.", "external": { "infractionId": "3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63", "fraudMarkerId": "b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48" }, "status": "CREATED", "analysisResult": "PENDING", "analysisDetails": "", "effectiveAt": "2026-11-04T14:02:37.115Z", "changedAt": "2026-11-04T14:02:37.115Z", "createdAt": "2026-11-04T14:02:37.120Z", "updatedAt": "2026-11-04T14:02:37.120Z", "__v": 0, "endToEndId": "E12345678202611031022p9Q8r7S6t5U", "reportParticipant": { "id": "", "bankIspb": "12345678", "name": "Mariana Souza", "email": "", "phone": "" }, "counterpartyParticipant": { "id": "", "bankIspb": "87654321", "name": "Gráfica Aurora Ltda" }}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_REQUEST",
"origin": "BANKING",
"message": "Request failed with status code 401"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "USER_NOT_HAVE_WALLET_PERMISSION",
"origin": "BANKING",
"message": "You do not have permission to perform this action"
}
{
"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": "reason",
"message": "Invalid option: expected one of \"REFUND_REQUEST\"|\"REFUND_CANCELLED\"",
"code": "REASON_ONE_OF",
"values": [
"REFUND_REQUEST",
"REFUND_CANCELLED"
]
}
]
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_REQUEST",
"origin": "BANKING",
"message": "Request failed with status code 429"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 500"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 502"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 503"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 504"
}
Report a Pix as a fraud
Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
transactions
/
{transactionId}
/
pix-infraction
Report a Pix as a fraud
curl --request POST \ --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction \ --header 'Content-Type: application/json' \ --data '{ "reason": "REFUND_REQUEST", "situationType": "SCAM", "reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."}'
import requests
url = "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction"
payload = {
"reason": "REFUND_REQUEST",
"situationType": "SCAM",
"reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
reason: 'REFUND_REQUEST',
situationType: 'SCAM',
reportDetails: 'A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.'
})
};
fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction', 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}/transactions/{transactionId}/pix-infraction",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'reason' => 'REFUND_REQUEST',
'situationType' => 'SCAM',
'reportDetails' => 'A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction"
payload := strings.NewReader("{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.post("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}")
.asString();
require 'uri'
require 'net/http'
url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"reason\": \"REFUND_REQUEST\",\n \"situationType\": \"SCAM\",\n \"reportDetails\": \"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.\"\n}"
response = http.request(request)
puts response.read_body
{ "_id": "6728e0a4b4d3e80012c9a6b1", "environment": "LIVE", "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b", "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410", "accountId": "66f2a1c7b4d3e80012c9a0b4", "walletId": "66f2a3d1b4d3e80012c9a0d2", "transactionId": "6726b1c2b4d3e80012c9a4f7", "direction": "SENT", "reason": "REFUND_REQUEST", "situationType": "SCAM", "reportDetails": "A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.", "external": { "infractionId": "3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63", "fraudMarkerId": "b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48" }, "status": "CREATED", "analysisResult": "PENDING", "analysisDetails": "", "effectiveAt": "2026-11-04T14:02:37.115Z", "changedAt": "2026-11-04T14:02:37.115Z", "createdAt": "2026-11-04T14:02:37.120Z", "updatedAt": "2026-11-04T14:02:37.120Z", "__v": 0, "endToEndId": "E12345678202611031022p9Q8r7S6t5U", "reportParticipant": { "id": "", "bankIspb": "12345678", "name": "Mariana Souza", "email": "", "phone": "" }, "counterpartyParticipant": { "id": "", "bankIspb": "87654321", "name": "Gráfica Aurora Ltda" }}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_REQUEST",
"origin": "BANKING",
"message": "Request failed with status code 401"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "USER_NOT_HAVE_WALLET_PERMISSION",
"origin": "BANKING",
"message": "You do not have permission to perform this action"
}
{
"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": "reason",
"message": "Invalid option: expected one of \"REFUND_REQUEST\"|\"REFUND_CANCELLED\"",
"code": "REASON_ONE_OF",
"values": [
"REFUND_REQUEST",
"REFUND_CANCELLED"
]
}
]
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_REQUEST",
"origin": "BANKING",
"message": "Request failed with status code 429"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 500"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 502"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 503"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "ERR_BAD_RESPONSE",
"origin": "BANKING",
"message": "Request failed with status code 504"
}
The transaction must be a Pix the wallet sent, with an end-to-end ID, and it can be reported only once. The report goes to the bank with situationType and reportDetails, and the answer is the infraction as recorded: directionSENT, statusCREATED, with the bank’s references in external. From then on the bank keeps it up to date — status moves to OPEN, ACKNOWLEDGED and finally CLOSED (with the conclusion in analysisResult) or CANCELLED, and the two sides appear in reportParticipant and counterpartyParticipant. Follow it with GET .../transactions/{transactionId}/pix-infraction. Opening the report doesn’t move money: when the money is returned, it arrives as a Pix credited to the wallet.When the bank refuses the report — or refuses Portão 3’s sign-in to it — nothing is recorded and the answer carries the bank’s own HTTP status, with the code ERR_BAD_REQUEST (a 4xx) or ERR_BAD_RESPONSE (a 5xx) and, unless the bank gave a message, Request failed with status code and the status: the bank answers 422 when it doesn’t find the Pix. When the bank doesn’t answer at all, the answer is a 500 whose code is the system’s network error — ECONNABORTED when it took too long, ECONNREFUSED, ENOTFOUND, a certificate error such as CERT_HAS_EXPIRED, or another: that status’s code is not limited to the listed ones. After a 5xx, a dropped connection or a timeout, the bank may still have opened the report: it then shows up on the transaction once the bank updates it, so check GET .../transactions/{transactionId}/pix-infraction before sending it again.Use default as walletId for the organization’s main wallet.Only Portão 3’s own services and back office can open a Pix infraction report.
Why the report is opened: send REFUND_REQUEST — it asks for the money back. REFUND_CANCELLED is accepted too but cancels nothing. Either is kept on the infraction until the bank's first update, which sets the reason itself (REFUND_CANCELLED once the report is cancelled).
What happened: SCAM — the payer was deceived into paying; ACCOUNT_TAKEOVER — someone took over the payer's account; COERCION — the payer was forced to pay; FRAUDULENT_ACCESS — someone used the payer's account without permission; OTHER — anything else. UNKNOWN is reported as OTHER.
What happened, in your words — 1 to 2,000 characters. It goes with the report to the institution that received the Pix.
Required string length: 1 - 2000
Example:
"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."
Response
Successful response
A Pix infraction report (MED — the Central Bank's special refund mechanism): a claim that a Pix was a fraud, opened by the payer's institution against the receiver's so the money can be blocked and returned. direction says which side the wallet is on.
Which side the wallet is on: RECEIVED — another institution reported a Pix the wallet received (the payer says it was a fraud); SENT — Portão 3 reported a Pix the wallet sent, at the organization's request.
REFUND_REQUEST — the report asks for the money back; REFUND_CANCELLED — the bank marked the request as cancelled. On a report Portão 3 just opened, until the bank's first update, it is the value sent with it, and cancels nothing. Some older cancelled reports still say REFUND_REQUEST. Read status to know whether a report was cancelled.
What the report says happened: SCAM — the payer was deceived into paying; ACCOUNT_TAKEOVER — someone took over the payer's account; COERCION — the payer was forced to pay; FRAUDULENT_ACCESS — someone used the payer's account without permission; OTHER — anything else, or not stated. UNKNOWN appears only on a report you just opened with it, until the bank's first update (it is reported as OTHER).
Where the report stands: CREATED — just opened by Portão 3, until the bank's first update; OPEN — opened, waiting for the receiver's institution; ACKNOWLEDGED — the receiver's institution is analyzing it; CLOSED — the analysis is over (see analysisResult); CANCELLED — the report was withdrawn. CLOSED and CANCELLED are final.
The receiver's institution's conclusion: AGREED — it agrees the Pix was a fraud; DISAGREED — it doesn't; PENDING — no conclusion recorded. Final only once status is CLOSED: on a report you received it can already say AGREED while the report is OPEN or ACKNOWLEDGED.
When the report was opened at the bank (ISO 8601, UTC). Not always the bank's time: on a report Portão 3 just opened (until the bank's first update) and on the records written when a wallet is blocked for fraud, it is when the record was written — on some older ones, a moment before it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Portão 3","colors":{"primary":"#43418E","light":"#8D8AE0","dark":"#302E65"},"logo":{"light":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9","dark":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/dark.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=47b0ed7a3645b0b5460c05d8b107963e"},"favicon":"https://mintcdn.com/porto3/dSTOaRKpfB0RS1lU/favicon.ico?fit=max\u0026auto=format\u0026n=dSTOaRKpfB0RS1lU\u0026q=85\u0026s=194badfbfde2e6414d74da0762416602","navbar":{"links":[{"href":"mailto:suporte@portao3.com.br","label":"Support"}],"primary":{"type":"button","label":"portao3.com.br","href":"https://portao3.com.br"}},"footer":{"socials":{"website":"https://portao3.com.br"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"pt-BR","href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"porto3","hasAudioNarration":false,"actualSubdomain":"porto3","customDomains":["developers.portao3.com.br"],"gitSource":{"type":"github","owner":"portao-3","repo":"portao3-backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4bba6d11-5abe-4a52-ad77-08bba6b8d5c1","liveDeploymentHistoryId":"6aebdbb6f69d5497a3c3861b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebdbb6f69d5497a3c3861b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6aebdbb6f69d5497a3c3861b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":426},{"language":"default","tag":"Banking","count":158},{"language":"default","tag":"Platform","count":92},{"language":"default","tag":"Billing","count":38},{"language":"default","tag":"Travel","count":32},{"language":"default","tag":"Wallets","count":29},{"language":"default","tag":"Identity","count":29},{"language":"default","tag":"Cards","count":27},{"language":"default","tag":"Registry","count":24},{"language":"default","tag":"Transactions \u0026 Statements","count":18},{"language":"en","tag":"Guides","count":15},{"language":"pt-BR","tag":"Guias","count":15},{"language":"en","tag":"PIX \u0026 payments","count":7},{"language":"pt-BR","tag":"PIX e pagamentos","count":7},{"language":"en","tag":"Cards","count":3},{"language":"pt-BR","tag":"Cartões","count":3},{"language":"en","tag":"API Reference","count":2},{"language":"en","tag":"Overview","count":2},{"language":"en","tag":"Getting Started","count":2},{"language":"pt-BR","tag":"Referência da API","count":2},{"language":"pt-BR","tag":"Visão geral","count":2},{"language":"pt-BR","tag":"Primeiros passos","count":2},{"language":"en","tag":"Integration guides","count":1},{"language":"en","tag":"Accounts \u0026 wallets","count":1},{"language":"en","tag":"Building your integration","count":1},{"language":"pt-BR","tag":"Guias de integração","count":1},{"language":"pt-BR","tag":"Contas e carteiras","count":1},{"language":"pt-BR","tag":"Construindo sua integração","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"api-reference.css","content":"[class*=\"param-field\"]>.py-6>.mt-4{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4>*+*{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4 .prose>p,[class*=\"param-field\"]>.py-6>.mt-4 .prose p.whitespace-pre-line{margin-top:0!important;margin-bottom:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.mt-6,.api-section .whitespace-pre-wrap.prose-sm.mt-6{margin-top:0!important}html[data-current-path^=\"/api-reference/\"] div.mt-2.text-lg.prose{font-size:1rem!important;line-height:1.5rem!important;margin-bottom:1.5rem!important}h4.api-section-heading-title{font-size:1.5rem!important;line-height:2rem!important}.api-section-heading>.border-b{border-bottom-width:0!important;padding-bottom:0!important}.api-section-heading div.font-mono.text-xs:not(:has(button)){display:none!important}.api-section-heading div.relative:has(>button[disabled]){display:none!important}html[data-current-path^=\"/api-reference/\"] .mdx-content.prose{font-size:1rem!important;line-height:1.5rem!important}[class*=\"param-field\"]>.py-6>.mt-4{display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child{display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr+p{order:99!important}[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr){display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child:has(>.space-y-4:first-child>hr),[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child:has(>hr){display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr+p{order:99!important;margin-top:0.75rem!important}.param-head[id^=\"response-\"] [data-component-part=\"field-required-pill\"]{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4:has(>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre),[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre){display:none!important}"}],"page":{"pagePath":"api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","slug":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","pageMetadata":{"title":"Report a Pix as a fraud","description":"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`The transaction must be a Pix the wallet sent, with an end-to-end ID, and it can be reported only once. The report goes to the bank with `,_jsx(_components.code,{children:`situationType`}),` and `,_jsx(_components.code,{children:`reportDetails`}),`, and the answer is the infraction as recorded: `,_jsx(_components.code,{children:`direction`}),` `,_jsx(_components.code,{children:`SENT`}),`, `,_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`CREATED`}),`, with the bank’s references in `,_jsx(_components.code,{children:`external`}),`. From then on the bank keeps it up to date — `,_jsx(_components.code,{children:`status`}),` moves to `,_jsx(_components.code,{children:`OPEN`}),`, `,_jsx(_components.code,{children:`ACKNOWLEDGED`}),` and finally `,_jsx(_components.code,{children:`CLOSED`}),` (with the conclusion in `,_jsx(_components.code,{children:`analysisResult`}),`) or `,_jsx(_components.code,{children:`CANCELLED`}),`, and the two sides appear in `,_jsx(_components.code,{children:`reportParticipant`}),` and `,_jsx(_components.code,{children:`counterpartyParticipant`}),`. Follow it with `,_jsx(_components.code,{children:`GET .../transactions/{transactionId}/pix-infraction`}),`. Opening the report doesn’t move money: when the money is returned, it arrives as a Pix credited to the wallet.`]}),`\n`,_jsxs(_components.p,{children:[`When the bank refuses the report — or refuses Portão 3’s sign-in to it — nothing is recorded and the answer carries the bank’s own HTTP status, with the code `,_jsx(_components.code,{children:`ERR_BAD_REQUEST`}),` (a `,_jsx(_components.code,{children:`4xx`}),`) or `,_jsx(_components.code,{children:`ERR_BAD_RESPONSE`}),` (a `,_jsx(_components.code,{children:`5xx`}),`) and, unless the bank gave a message, `,_jsx(_components.code,{children:`Request failed with status code`}),` and the status: the bank answers `,_jsx(_components.code,{children:`422`}),` when it doesn’t find the Pix. When the bank doesn’t answer at all, the answer is a `,_jsx(_components.code,{children:`500`}),` whose code is the system’s network error — `,_jsx(_components.code,{children:`ECONNABORTED`}),` when it took too long, `,_jsx(_components.code,{children:`ECONNREFUSED`}),`, `,_jsx(_components.code,{children:`ENOTFOUND`}),`, a certificate error such as `,_jsx(_components.code,{children:`CERT_HAS_EXPIRED`}),`, or another: that status’s `,_jsx(_components.code,{children:`code`}),` is not limited to the listed ones. After a `,_jsx(_components.code,{children:`5xx`}),`, a dropped connection or a timeout, the bank may still have opened the report: it then shows up on the transaction once the bank updates it, so check `,_jsx(_components.code,{children:`GET .../transactions/{transactionId}/pix-infraction`}),` before sending it again.`]}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`default`}),` as `,_jsx(_components.code,{children:`walletId`}),` for the organization’s main wallet.`]}),`\n`,_jsx(_components.p,{children:`Only Portão 3’s own services and back office can open a Pix infraction report.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Report a Pix as a fraud","description":"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdPixInfraction","summary":"Report a Pix as a fraud","tags":["PIX Infractions (MED)"],"x-p3-sidebar-order":6,"description":"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.","x-mint":{"content":"The transaction must be a Pix the wallet sent, with an end-to-end ID, and it can be reported only once. The report goes to the bank with `situationType` and `reportDetails`, and the answer is the infraction as recorded: `direction` `SENT`, `status` `CREATED`, with the bank's references in `external`. From then on the bank keeps it up to date — `status` moves to `OPEN`, `ACKNOWLEDGED` and finally `CLOSED` (with the conclusion in `analysisResult`) or `CANCELLED`, and the two sides appear in `reportParticipant` and `counterpartyParticipant`. Follow it with `GET .../transactions/{transactionId}/pix-infraction`. Opening the report doesn't move money: when the money is returned, it arrives as a Pix credited to the wallet.\n\nWhen the bank refuses the report — or refuses Portão 3's sign-in to it — nothing is recorded and the answer carries the bank's own HTTP status, with the code `ERR_BAD_REQUEST` (a `4xx`) or `ERR_BAD_RESPONSE` (a `5xx`) and, unless the bank gave a message, `Request failed with status code` and the status: the bank answers `422` when it doesn't find the Pix. When the bank doesn't answer at all, the answer is a `500` whose code is the system's network error — `ECONNABORTED` when it took too long, `ECONNREFUSED`, `ENOTFOUND`, a certificate error such as `CERT_HAS_EXPIRED`, or another: that status's `code` is not limited to the listed ones. After a `5xx`, a dropped connection or a timeout, the bank may still have opened the report: it then shows up on the transaction once the bank updates it, so check `GET .../transactions/{transactionId}/pix-infraction` before sending it again.\n\nUse `default` as `walletId` for the organization's main wallet.\n\nOnly Portão 3's own services and back office can open a Pix infraction report."},"parameters":["58009e46-f141-4e20-b24c-fbd59ad2b34b","b42ecc30-a554-491f-b15b-94730521acf4","58ab3639-9482-4c0b-a838-fd9b0d1fe803","7ffc51fa-5022-4d68-9a0d-6c09a83e6583","968d60c8-7f3d-47bd-ba77-fc9e46442843","e287715b-c856-4e47-87aa-c3e6b13056b6"],"requestBody":"95648969-97d2-482a-a38f-92cc716d7db6","responses":{"200":"85dc4822-e09e-45c5-91e7-85c9dbe85db7","400":"a1b47860-b6fb-4c4a-bc12-648aa9cbdb7b","401":"250cb78b-de02-42d6-bb68-755cabe1e0fc","403":"c5d2f29a-0831-4ccb-9c36-721c2606fe3a","404":"52eee35e-4c77-479c-aa2f-7a829d3ca4f1","409":"d3c2e557-5880-4961-a08a-182cf1e304cd","422":"5e687063-2ebe-46c6-b7fd-b81ce04db49d","429":"20131d24-e67c-4dba-a73c-5262a15b907e","500":"171a5187-a3ad-4cc4-b063-68185cb6da7c","502":"ee499fd2-4305-4fca-a76f-d57463c42cbc","503":"5ecf089c-0bff-43ae-b64e-78b7ceb7f337","504":"a28f5d9d-b3d5-4ed5-a33d-531c583c6ded"},"x-p3-confidence":{"response":"generated:typed","request":"generated:typed","parameters":"generated:typed"},"method":"post","type":"path","servers":["504b00e5-7d7a-4410-8cf8-61e77110dc43","602acb2b-75bc-4c7d-a310-ef850a3fc860"],"security":[],"path":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","baseUrlOptions":["https://api.banking.v2.portao3.com.br/","https://api.banking.dev.3pers.com.br/"],"title":"Report a Pix as a fraud","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"58009e46-f141-4e20-b24c-fbd59ad2b34b":{"name":"realmId","in":"path","required":true,"description":"ID of the realm.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the realm.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"},"b42ecc30-a554-491f-b15b-94730521acf4":{"name":"organizationId","in":"path","required":true,"description":"ID of the organization.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the organization.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410"},"58ab3639-9482-4c0b-a838-fd9b0d1fe803":{"name":"accountId","in":"path","required":true,"description":"ID of the organization's account (24 hexadecimal characters).","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"ID of the organization's account (24 hexadecimal characters).","uniqueKey":"","typeLabel":"string"},"example":"66f2a1c7b4d3e80012c9a0b4"},"7ffc51fa-5022-4d68-9a0d-6c09a83e6583":{"name":"walletId","in":"path","required":true,"description":"ID of the wallet that sent the Pix (24 hexadecimal characters), or `default` for the organization's main wallet.","schema":{"type":"string","pattern":"^([0-9a-fA-F]{24}|default)$","isRequired":true,"description":"ID of the wallet that sent the Pix (24 hexadecimal characters), or `default` for the organization's main wallet.","uniqueKey":"","typeLabel":"string"},"example":"66f2a3d1b4d3e80012c9a0d2"},"968d60c8-7f3d-47bd-ba77-fc9e46442843":{"name":"transactionId","in":"path","required":true,"description":"ID of the outgoing Pix in the wallet's statement — the transaction's `_id` (24 hexadecimal characters).","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"ID of the outgoing Pix in the wallet's statement — the transaction's `_id` (24 hexadecimal characters).","uniqueKey":"","typeLabel":"string"},"example":"6726b1c2b4d3e80012c9a4f7"},"e287715b-c856-4e47-87aa-c3e6b13056b6":{"name":"x-environment","in":"header","required":false,"description":"Environment of the transaction: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected.","schema":{"type":"string","enum":["LIVE","TEST"],"isRequired":false,"description":"Environment of the transaction: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"LIVE"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","enum":["REFUND_REQUEST","REFUND_CANCELLED"],"description":"Why the report is opened: send `REFUND_REQUEST` — it asks for the money back. `REFUND_CANCELLED` is accepted too but cancels nothing. Either is kept on the infraction until the bank's first update, which sets the reason itself (`REFUND_CANCELLED` once the report is cancelled).","example":"REFUND_REQUEST","isRequired":true,"uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"situationType":{"type":"string","enum":["SCAM","ACCOUNT_TAKEOVER","COERCION","FRAUDULENT_ACCESS","OTHER","UNKNOWN"],"description":"What happened: `SCAM` — the payer was deceived into paying; `ACCOUNT_TAKEOVER` — someone took over the payer's account; `COERCION` — the payer was forced to pay; `FRAUDULENT_ACCESS` — someone used the payer's account without permission; `OTHER` — anything else. `UNKNOWN` is reported as `OTHER`.","example":"SCAM","isRequired":true,"uniqueKey":"situationType","typeLabel":"enum\u003cstring>"},"reportDetails":{"type":"string","minLength":1,"maxLength":2000,"description":"What happened, in your words — 1 to 2,000 characters. It goes with the report to the institution that received the Pix.","example":"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.","isRequired":true,"uniqueKey":"reportDetails","typeLabel":"string"}},"required":["reason","situationType","reportDetails"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"reason":"REFUND_REQUEST","situationType":"SCAM","reportDetails":"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde."}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"85dc4822-e09e-45c5-91e7-85c9dbe85db7":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the infraction (24 hexadecimal characters).","example":"6728e0a4b4d3e80012c9a6b1","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"environment":{"type":"string","enum":["LIVE","TEST"],"description":"Environment of the infraction: `LIVE` (production) or `TEST` (sandbox).","example":"LIVE","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"realmId":{"type":"string","description":"ID of the realm.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","isRequired":true,"uniqueKey":"realmId","typeLabel":"string"},"organizationId":{"type":"string","description":"ID of the organization.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string"},"accountId":{"type":"string","description":"ID of the organization's account.","example":"66f2a1c7b4d3e80012c9a0b4","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"walletId":{"type":"string","description":"ID of the wallet that sent or received the Pix.","example":"66f2a3d1b4d3e80012c9a0d2","isRequired":true,"uniqueKey":"walletId","typeLabel":"string"},"transactionId":{"type":"string","description":"ID of the Pix transaction in the wallet's statement.","example":"6726b1c2b4d3e80012c9a4f7","isRequired":true,"uniqueKey":"transactionId","typeLabel":"string"},"direction":{"type":"string","enum":["SENT","RECEIVED"],"description":"Which side the wallet is on: `RECEIVED` — another institution reported a Pix the wallet received (the payer says it was a fraud); `SENT` — Portão 3 reported a Pix the wallet sent, at the organization's request.","example":"SENT","isRequired":true,"uniqueKey":"direction","typeLabel":"enum\u003cstring>"},"reason":{"type":"string","enum":["REFUND_REQUEST","REFUND_CANCELLED"],"description":"`REFUND_REQUEST` — the report asks for the money back; `REFUND_CANCELLED` — the bank marked the request as cancelled. On a report Portão 3 just opened, until the bank's first update, it is the value sent with it, and cancels nothing. Some older cancelled reports still say `REFUND_REQUEST`. Read `status` to know whether a report was cancelled.","example":"REFUND_REQUEST","isRequired":true,"uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"situationType":{"type":"string","enum":["SCAM","ACCOUNT_TAKEOVER","COERCION","FRAUDULENT_ACCESS","OTHER","UNKNOWN"],"description":"What the report says happened: `SCAM` — the payer was deceived into paying; `ACCOUNT_TAKEOVER` — someone took over the payer's account; `COERCION` — the payer was forced to pay; `FRAUDULENT_ACCESS` — someone used the payer's account without permission; `OTHER` — anything else, or not stated. `UNKNOWN` appears only on a report you just opened with it, until the bank's first update (it is reported as `OTHER`).","example":"SCAM","isRequired":true,"uniqueKey":"situationType","typeLabel":"enum\u003cstring>"},"reportDetails":{"oneOf":[{"type":"string","description":"What happened, in the reporter's words. Empty or `null` on some older reports.","example":"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.","isRequired":true,"uniqueKey":"reportDetails.oneOf.0","typeLabel":"string"},{"type":"null","description":"What happened, in the reporter's words. Empty or `null` on some older reports.","example":"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.","isRequired":true,"uniqueKey":"reportDetails.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"reportDetails","typeLabel":"string | null"},"external":{"type":"object","properties":{"infractionId":{"type":"string","description":"The bank's ID of the report. Empty on some older reports.","example":"3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63","isRequired":true,"uniqueKey":"external.infractionId","typeLabel":"string"},"fraudMarkerId":{"type":"string","description":"A second reference the bank gives the report. Empty when the bank sent none.","example":"b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48","isRequired":true,"uniqueKey":"external.fraudMarkerId","typeLabel":"string"}},"required":["infractionId","fraudMarkerId"],"description":"References of the report at the bank.","isRequired":true,"uniqueKey":"external","typeLabel":"object"},"status":{"type":"string","enum":["OPEN","ACKNOWLEDGED","CLOSED","CANCELLED","CREATED"],"description":"Where the report stands: `CREATED` — just opened by Portão 3, until the bank's first update; `OPEN` — opened, waiting for the receiver's institution; `ACKNOWLEDGED` — the receiver's institution is analyzing it; `CLOSED` — the analysis is over (see `analysisResult`); `CANCELLED` — the report was withdrawn. `CLOSED` and `CANCELLED` are final.","example":"CREATED","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"analysisResult":{"type":"string","enum":["AGREED","DISAGREED","PENDING"],"description":"The receiver's institution's conclusion: `AGREED` — it agrees the Pix was a fraud; `DISAGREED` — it doesn't; `PENDING` — no conclusion recorded. Final only once `status` is `CLOSED`: on a report you received it can already say `AGREED` while the report is `OPEN` or `ACKNOWLEDGED`.","example":"PENDING","isRequired":true,"uniqueKey":"analysisResult","typeLabel":"enum\u003cstring>"},"analysisDetails":{"type":"string","description":"Notes of the analysis, when the receiver's institution wrote any. Empty otherwise.","example":"","isRequired":true,"uniqueKey":"analysisDetails","typeLabel":"string"},"effectiveAt":{"type":"string","description":"When the report was opened at the bank (ISO 8601, UTC). Not always the bank's time: on a report Portão 3 just opened (until the bank's first update) and on the records written when a wallet is blocked for fraud, it is when the record was written — on some older ones, a moment before it.","example":"2026-11-04T14:02:37.115Z","isRequired":true,"uniqueKey":"effectiveAt","typeLabel":"string"},"changedAt":{"type":"string","description":"When the report's last change was recorded (ISO 8601, UTC). On a few older reports that never recorded one, the time of your request.","example":"2026-11-04T14:02:37.115Z","isRequired":true,"uniqueKey":"changedAt","typeLabel":"string"},"createdAt":{"type":"string","description":"When the infraction was recorded (ISO 8601, UTC).","example":"2026-11-04T14:02:37.120Z","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"When the infraction was last updated (ISO 8601, UTC).","example":"2026-11-04T14:02:37.120Z","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"__v":{"type":"number","description":"Internal version of the record.","example":0,"isRequired":true,"uniqueKey":"__v","typeLabel":"number"},"endToEndId":{"type":"string","description":"End-to-end ID of the Pix (32 characters). Absent or empty on a few older reports.","example":"E12345678202611031022p9Q8r7S6t5U","uniqueKey":"endToEndId","typeLabel":"string"},"reportParticipant":{"type":"object","properties":{"id":{"type":"string","description":"Code of the institution that opened the report, as the bank sent it on some older reports (without leading zeros). Empty or absent on the others — read `bankIspb`.","example":"","uniqueKey":"reportParticipant.id","typeLabel":"string"},"bankIspb":{"type":"string","description":"ISPB (8 digits) of the payer's institution.","example":"12345678","uniqueKey":"reportParticipant.bankIspb","typeLabel":"string"},"name":{"type":"string","description":"Name of the payer.","example":"Mariana Souza","uniqueKey":"reportParticipant.name","typeLabel":"string"},"email":{"type":"string","description":"Contact e-mail of the institution that opened the report, on some older reports only. Empty or absent on the others.","example":"","uniqueKey":"reportParticipant.email","typeLabel":"string"},"phone":{"type":"string","description":"Contact phone of the institution that opened the report, as that institution wrote it (not in a standard format), on some older reports only. Empty or absent on the others.","example":"","uniqueKey":"reportParticipant.phone","typeLabel":"string"}},"description":"The side that opened the report (the payer's).","uniqueKey":"reportParticipant","typeLabel":"object"},"counterpartyParticipant":{"type":"object","properties":{"id":{"type":"string","description":"Code of the receiving institution, as the bank sent it on some older reports. Empty or absent on the others.","example":"","uniqueKey":"counterpartyParticipant.id","typeLabel":"string"},"bankIspb":{"type":"string","description":"ISPB (8 digits) of the receiver's institution, when known.","example":"87654321","uniqueKey":"counterpartyParticipant.bankIspb","typeLabel":"string"},"name":{"type":"string","description":"Name of the receiver, when known. Often empty.","example":"Gráfica Aurora Ltda","uniqueKey":"counterpartyParticipant.name","typeLabel":"string"}},"description":"The side the report is against (the receiver's).","uniqueKey":"counterpartyParticipant","typeLabel":"object"}},"required":["_id","environment","realmId","organizationId","accountId","walletId","transactionId","direction","reason","situationType","reportDetails","external","status","analysisResult","analysisDetails","effectiveAt","changedAt","createdAt","updatedAt","__v"],"description":"A Pix infraction report (MED — the Central Bank's special refund mechanism): a claim that a Pix was a fraud, opened by the payer's institution against the receiver's so the money can be blocked and returned. `direction` says which side the wallet is on.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"6728e0a4b4d3e80012c9a6b1","environment":"LIVE","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"66f2a3d1b4d3e80012c9a0d2","transactionId":"6726b1c2b4d3e80012c9a4f7","direction":"SENT","reason":"REFUND_REQUEST","situationType":"SCAM","reportDetails":"A cliente pagou um falso fornecedor que se passou pela Gráfica Aurora. O recebedor não entregou nada e não responde.","external":{"infractionId":"3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63","fraudMarkerId":"b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48"},"status":"CREATED","analysisResult":"PENDING","analysisDetails":"","effectiveAt":"2026-11-04T14:02:37.115Z","changedAt":"2026-11-04T14:02:37.115Z","createdAt":"2026-11-04T14:02:37.120Z","updatedAt":"2026-11-04T14:02:37.120Z","__v":0,"endToEndId":"E12345678202611031022p9Q8r7S6t5U","reportParticipant":{"id":"","bankIspb":"12345678","name":"Mariana Souza","email":"","phone":""},"counterpartyParticipant":{"id":"","bankIspb":"87654321","name":"Gráfica Aurora Ltda"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a1b47860-b6fb-4c4a-bc12-648aa9cbdb7b":{"description":"`PIX_INFRACTION_INVALID_TRANSACTION` — The transaction isn't a Pix the wallet sent, or it has no end-to-end ID.\n\n`ERR_BAD_REQUEST` — The bank rejected the report's data. Nothing is recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["PIX_INFRACTION_INVALID_TRANSACTION","ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"PIX_INFRACTION_INVALID_TRANSACTION","origin":"BANKING","message":"Pix Infraction invalid transaction"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"PIX_INFRACTION_INVALID_TRANSACTION","origin":"BANKING","message":"Pix Infraction invalid transaction"}}},"exampleType":"examples"}},"exampleType":"examples"},"250cb78b-de02-42d6-bb68-755cabe1e0fc":{"description":"`ERR_BAD_REQUEST` — The bank didn't accept Portão 3's sign-in. Nothing is recorded; retry.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_REQUEST","origin":"BANKING","message":"Request failed with status code 401"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_REQUEST","origin":"BANKING","message":"Request failed with status code 401"}}},"exampleType":"examples"}},"exampleType":"examples"},"c5d2f29a-0831-4ccb-9c36-721c2606fe3a":{"description":"`USER_NOT_HAVE_WALLET_PERMISSION` — You are not a Portão 3 service or back-office operator.\n\n`ERR_BAD_REQUEST` — The bank refused Portão 3's access (the message may be the bank's own). Nothing is recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["USER_NOT_HAVE_WALLET_PERMISSION","ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"USER_NOT_HAVE_WALLET_PERMISSION","origin":"BANKING","message":"You do not have permission to perform this action"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"USER_NOT_HAVE_WALLET_PERMISSION","origin":"BANKING","message":"You do not have permission to perform this action"}}},"exampleType":"examples"}},"exampleType":"examples"},"52eee35e-4c77-479c-aa2f-7a829d3ca4f1":{"description":"`ACCOUNT_NOT_FOUND` — No account with this ID exists in the organization.\n\n`WALLET_NOT_FOUND` — No wallet with this ID exists in the account and environment — or, with `walletId` `default`, the account has no main wallet in this environment.\n\n`TRANSACTION_NOT_FOUND` — The wallet has no transaction with this ID in this environment.\n\n`ERR_BAD_REQUEST` — The bank answered that something it needs wasn't found. Nothing is recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ACCOUNT_NOT_FOUND","WALLET_NOT_FOUND","TRANSACTION_NOT_FOUND","ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ACCOUNT_NOT_FOUND","origin":"BANKING","message":"Account not found"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ACCOUNT_NOT_FOUND","origin":"BANKING","message":"Account not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"d3c2e557-5880-4961-a08a-182cf1e304cd":{"description":"`PIX_INFRACTION_ALREADY_EXISTS` — The transaction already has an infraction. Nothing is sent to the bank.\n\n`ERR_BAD_REQUEST` — The bank refused the report as a conflict. Nothing is recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["PIX_INFRACTION_ALREADY_EXISTS","ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"PIX_INFRACTION_ALREADY_EXISTS","origin":"BANKING","message":"Pix Infraction already exists"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"PIX_INFRACTION_ALREADY_EXISTS","origin":"BANKING","message":"Pix Infraction already exists"}}},"exampleType":"examples"}},"exampleType":"examples"},"5e687063-2ebe-46c6-b7fd-b81ce04db49d":{"description":"`BAD_REQUEST` — A path or body field is invalid — for example an unknown `situationType` or an empty `reportDetails`; `fields` lists each one.\n\n`ERR_BAD_REQUEST` — The bank refused the report — for example, it didn't find the Pix. Nothing is recorded.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST","ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"oneOf":[{"type":"array","description":"One entry per invalid request field (validation errors only); `null` on an error relayed as-is from upstream.","items":{"type":"object","properties":{"field":{"type":"string","description":"Path of the invalid field, e.g. `label` or `values[0].value`.","example":"label","isRequired":true,"uniqueKey":"fields.oneOf.0.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Why the field was rejected.","example":"label is required","isRequired":true,"uniqueKey":"fields.oneOf.0.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"`\u003cFIELD>_\u003cREASON>` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.","example":"LABEL_REQUIRED","isRequired":true,"uniqueKey":"fields.oneOf.0.items.[INDEX].code","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"fields.oneOf.0.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"description":"The accepted values, when the field is an enumeration.","uniqueKey":"fields.oneOf.0.items.[INDEX].values","typeLabel":"string[]"}},"required":["field","message","code"],"uniqueKey":"fields.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"One entry per invalid request field (validation errors only); `null` on an error relayed as-is from upstream.","items":{"type":"object","properties":{"field":{"type":"string","description":"Path of the invalid field, e.g. `label` or `values[0].value`.","example":"label"},"message":{"type":"string","description":"Why the field was rejected.","example":"label is required"},"code":{"type":"string","description":"`\u003cFIELD>_\u003cREASON>` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.","example":"LABEL_REQUIRED"},"values":{"type":"array","items":{"type":"string"},"description":"The accepted values, when the field is an enumeration."}},"required":["field","message","code"]},"uniqueKey":"fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"fields","typeLabel":"object[] | null"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"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":"reason","message":"Invalid option: expected one of \"REFUND_REQUEST\"|\"REFUND_CANCELLED\"","code":"REASON_ONE_OF","values":["REFUND_REQUEST","REFUND_CANCELLED"]}]},"examples":{"Example":{"title":"Example","value":{"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":"reason","message":"Invalid option: expected one of \"REFUND_REQUEST\"|\"REFUND_CANCELLED\"","code":"REASON_ONE_OF","values":["REFUND_REQUEST","REFUND_CANCELLED"]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"20131d24-e67c-4dba-a73c-5262a15b907e":{"description":"`ERR_BAD_REQUEST` — Too many requests reached the bank — the report or Portão 3's sign-in to it. Nothing is recorded; retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ERR_BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_REQUEST","origin":"BANKING","message":"Request failed with status code 429"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_REQUEST","origin":"BANKING","message":"Request failed with status code 429"}}},"exampleType":"examples"}},"exampleType":"examples"},"171a5187-a3ad-4cc4-b063-68185cb6da7c":{"description":"`ERR_BAD_RESPONSE` — The bank failed while handling the report or Portão 3's sign-in (the message may be the bank's own). It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.\n\n`ECONNABORTED` — The bank didn't answer in time; the message gives the time waited. It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.\n\n`ECONNRESET` — The connection to the bank dropped. It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.\n\n`EPIPE` — The connection to the bank broke while the report was being sent. It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.\n\n`ETIMEDOUT` — The connection to the bank timed out. It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.\n\n`ECONNREFUSED` — The bank refused the connection. Nothing was sent; retry.\n\n`ENOTFOUND` — The bank's address couldn't be resolved. Nothing was sent; retry.\n\n`EAI_AGAIN` — The bank's address couldn't be resolved for now. Nothing was sent; retry.\n\n`EHOSTUNREACH` — The bank couldn't be reached. Nothing was sent; retry.\n\n`ENETUNREACH` — The network to the bank was unreachable. Nothing was sent; retry.\n\n`CERT_HAS_EXPIRED` — The bank's security certificate had expired, so the connection was refused. Nothing was sent; retry later.\n\n`ERR_TLS_CERT_ALTNAME_INVALID` — The bank's security certificate didn't match its address, so the connection was refused. Nothing was sent; retry later.\n\n`INTERNAL_SERVER_ERROR` — An unexpected failure on Portão 3's side — for example, signing in to the bank took too long. The report may have reached the bank: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again. If it persists, contact support with the `traceId`.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Branch on this, never on `message`. On a network failure relayed as-is, the system's own error code: one of those this response lists, or another.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 500"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 500"}}},"exampleType":"examples"}},"exampleType":"examples"},"ee499fd2-4305-4fca-a76f-d57463c42cbc":{"description":"`ERR_BAD_RESPONSE` — The bank was unavailable while handling the report or Portão 3's sign-in (the message may be the bank's own). It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ERR_BAD_RESPONSE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 502"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 502"}}},"exampleType":"examples"}},"exampleType":"examples"},"5ecf089c-0bff-43ae-b64e-78b7ceb7f337":{"description":"`ERR_BAD_RESPONSE` — The bank was unavailable while handling the report or Portão 3's sign-in (the message may be the bank's own). It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ERR_BAD_RESPONSE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 503"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 503"}}},"exampleType":"examples"}},"exampleType":"examples"},"a28f5d9d-b3d5-4ed5-a33d-531c583c6ded":{"description":"`ERR_BAD_RESPONSE` — The bank timed out while handling the report or Portão 3's sign-in (the message may be the bank's own). It may still have opened the report: check `GET .../transactions/{transactionId}/pix-infraction` later before sending it again.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ERR_BAD_RESPONSE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 504"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ERR_BAD_RESPONSE","origin":"BANKING","message":"Request failed with status code 504"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"504b00e5-7d7a-4410-8cf8-61e77110dc43":{"url":"https://api.banking.v2.portao3.com.br/","description":"production"},"602acb2b-75bc-4c7d-a310-ef850a3fc860":{"url":"https://api.banking.dev.3pers.com.br/","description":"development"}}},"originalFileLocation":"api-reference/banking.openapi.json"},"subdomain":"porto3","siteName":"Portão 3","title":"Report a Pix as a fraud - Portão 3","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","matchLevel":0},"pt-BR":{"href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud","matchLevel":0}}},"lastModified":"2026-11-05T01:29:31.206Z","originalFileLocation":"api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Report a Pix as a fraud - Portão 3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Portão 3\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://porto3.mintlify.app/_mintlify/api/og/v2?division=PIX+Infractions+%28MED%29\u0026amp;title=Report+a+Pix+as+a+fraud\u0026amp;description=Opens+a+Pix+infraction+report+%28MED%29+about+a+Pix+the+wallet+sent%3A+it+tells+the+institution+that+received+the+money+that+the+Pix+was+a+fraud+%E2%80%94+for+example%2C+the+or\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=c3aafb1da427f6debfe2439089272dab412a8c562d17747ec7a8c580afdaef50\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Report a Pix as a fraud - Portão 3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://porto3.mintlify.app/_mintlify/api/og/v2?division=PIX+Infractions+%28MED%29\u0026amp;title=Report+a+Pix+as+a+fraud\u0026amp;description=Opens+a+Pix+infraction+report+%28MED%29+about+a+Pix+the+wallet+sent%3A+it+tells+the+institution+that+received+the+money+that+the+Pix+was+a+fraud+%E2%80%94+for+example%2C+the+or\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=c3aafb1da427f6debfe2439089272dab412a8c562d17747ec7a8c580afdaef50\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#43418E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.portao3.com.br/#organization\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.portao3.com.br#website\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud#webpage\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud\",\"name\":\"Report a Pix as a fraud\",\"description\":\"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\",\"dateModified\":\"2026-11-05T01:29:31.206Z\",\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Banking\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/accounts/list-the-realms-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"PIX Infractions (MED)\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Report a Pix as a fraud\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud#apireference\",\"headline\":\"Report a Pix as a fraud\",\"name\":\"Report a Pix as a fraud\",\"description\":\"Opens a Pix infraction report (MED) about a Pix the wallet sent: it tells the institution that received the money that the Pix was a fraud — for example, the organization paid a scammer — so that institution can analyze it, block the money and return it.\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud\",\"mainEntityOfPage\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud#webpage\"},\"dateModified\":\"2026-11-05T01:29:31.206Z\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portão 3\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Portão 3","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Pagination","href":"/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","description":"Returns the Pix infraction (MED) of a transaction of the wallet: the report another institution opened against a Pix the wallet received, or the one Portão 3 opened about a Pix it sent. Use `default` as `walletId` for the organization's main wallet.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/get-a-transactions-pix-infraction"},{"title":"Report a Pix as a fraud","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud"}]},{"group":"Boleto Payments","pages":[{"title":"List the realm's boleto payments","description":"Lists the boleto payments of every organization in your realm, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto","href":"/api-reference/banking/boleto-payments/list-the-realms-boleto-payments"},{"title":"List an organization's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-organizations-boleto-payments"},{"title":"List an account's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-accounts-boleto-payments"},{"title":"List a wallet's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/list-a-wallets-boleto-payments"},{"title":"Create a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/create-a-boleto-payment"},{"title":"Get a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/get-a-boleto-payment"},{"title":"Set a boleto payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/set-a-boleto-payments-details"},{"title":"Send a boleto payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request","href":"/api-reference/banking/boleto-payments/send-a-boleto-payment-for-approval"},{"title":"Confirm a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm","href":"/api-reference/banking/boleto-payments/confirm-a-boleto-payment"},{"title":"Cancel a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel","href":"/api-reference/banking/boleto-payments/cancel-a-boleto-payment"}]},{"group":"Boleto Charges","pages":[{"title":"/realms/{realmId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-downloadpdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-boleto-billing"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions"}]},{"group":"Policy Evaluations","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-evaluations","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-evaluations","href":"/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations"}]},{"group":"Policy Requests","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Referência da API","href":"/pt-BR/api-reference/overview"},{"title":"Paginação","href":"/pt-BR/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","description":"Returns the Pix infraction (MED) of a transaction of the wallet: the report another institution opened against a Pix the wallet received, or the one Portão 3 opened about a Pix it sent. Use `default` as `walletId` for the organization's main wallet.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/get-a-transactions-pix-infraction"},{"title":"Report a Pix as a fraud","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/report-a-pix-as-a-fraud"}]},{"group":"Boleto Payments","pages":[{"title":"List the realm's boleto payments","description":"Lists the boleto payments of every organization in your realm, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto","href":"/api-reference/banking/boleto-payments/list-the-realms-boleto-payments"},{"title":"List an organization's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-organizations-boleto-payments"},{"title":"List an account's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto","href":"/api-reference/banking/boleto-payments/list-an-accounts-boleto-payments"},{"title":"List a wallet's boleto payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/list-a-wallets-boleto-payments"},{"title":"Create a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto","href":"/api-reference/banking/boleto-payments/create-a-boleto-payment"},{"title":"Get a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/get-a-boleto-payment"},{"title":"Set a boleto payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}","href":"/api-reference/banking/boleto-payments/set-a-boleto-payments-details"},{"title":"Send a boleto payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request","href":"/api-reference/banking/boleto-payments/send-a-boleto-payment-for-approval"},{"title":"Confirm a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm","href":"/api-reference/banking/boleto-payments/confirm-a-boleto-payment"},{"title":"Cancel a boleto payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel","href":"/api-reference/banking/boleto-payments/cancel-a-boleto-payment"}]},{"group":"Boleto Charges","pages":[{"title":"/realms/{realmId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-downloadpdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-boleto-billing"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions"}]},{"group":"Policy Evaluations","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-evaluations","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-evaluations","href":"/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations"}]},{"group":"Policy Requests","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]}]},"basePath":"","title":"Report a Pix as a fraud - Portão 3","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}