{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "POLICY_REQUEST_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to perform this action"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "policyRequestId",
"message": "Invalid UUID",
"code": "POLICYREQUESTID_UUID"
}
]
}
Get a policy request
Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
policy-requests
/
{policyRequestId}
Get a policy request
curl --request GET \ --url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "POLICY_REQUEST_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to perform this action"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "policyRequestId",
"message": "Invalid UUID",
"code": "POLICYREQUESTID_UUID"
}
]
}
Organization admins can read any request of the organization. Any other member can read only a request they created or take part in approving.Read it to follow an approval: status leaves REQUESTED once it is approved, denied, cancelled or expired, and executionStatus tells what happened after an approval.
ID of the policy request. A payment or transfer request sent for approval carries it as policyRequestId.
Format: UUID
Response
Successful response
A policy request: the approval request of a payment, a transfer request or a reviewed transaction, waiting for the decisions a business policy requires.
The subject as it was when the request was opened — what the policies evaluated and what the approvers are approving. A payment's approved amount and balance category are in confirmation.
Example: {"amount":123000,"description":"Folders da campanha de novembro","creditParty":{"name":"Gráfica Aurora Ltda"},"confirmation":{"amount":123000,"category":"FLEX_INTERNATIONAL"}}
Status of the request. REQUESTED — waiting for decisions. APPROVED — every required approval was given (or an admin force-approved it). DENIED — an approver or an admin denied it. CANCELED — the requester, an admin or Portão 3 cancelled it. EXPIRED — approvalDeadline passed while it was waiting. Every status but REQUESTED is final.
What happens after the approval: the policy's top-up, if any, then the subject is carried out (the payment is confirmed, the transfer request confirmed, the spend review approved). WAITING — not started: a request that is not approved stays WAITING, and an approved one goes back to it while a temporary problem is retried. PROCESSING — running. EXECUTED — done. FAILED — stopped, with the reason in executionFailReason.
When the request expires if it is still waiting for decisions. Set by whoever opened the request — for a Pix or boleto payment, 21:00 (São Paulo time) of the day the payment is for, and at least one hour after it was sent.
AUTO when the policy approves on its own: the request was created already APPROVED, with no approvers, to run the policy's top-up. Absent on a request that went through approvers.
Why the execution failed, or why it is being retried — a code such as MOVE_BALANCE_SOURCE_MISSING for a problem detected before any money moved, otherwise the error of the step that failed (up to 200 characters).
true on the one request per subject that took charge of topping up its wallet. It is set before the top-up runs and kept even if the top-up then fails, so it does not mean the money moved — fundedAt does. Absent otherwise.
How many times the execution was retried after a temporary problem that happened before any money moved. Absent when it was never retried.
Example:
1
{"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":"8240fd59-003e-4df3-a100-77d17155da54","liveDeploymentHistoryId":"6aeccdac5e64435eef0355f8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeccdac5e64435eef0355f8"},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6aed388a8fb923e00d310522","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":415},{"language":"default","tag":"Banking","count":148},{"language":"default","tag":"Platform","count":92},{"language":"default","tag":"Billing","count":38},{"language":"default","tag":"Travel","count":32},{"language":"default","tag":"Identity","count":29},{"language":"default","tag":"Wallets","count":28},{"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":16},{"language":"pt-BR","tag":"Guias","count":16},{"language":"en","tag":"PIX \u0026 payments","count":8},{"language":"pt-BR","tag":"PIX e pagamentos","count":8},{"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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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/ruleengine/policy-requests/get-a-policy-request","slug":"/api-reference/ruleengine/policy-requests/get-a-policy-request","pageMetadata":{"title":"Get a policy request","description":"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request","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: \"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\"\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:[_jsx(_components.p,{children:`Organization admins can read any request of the organization. Any other member can read only a request they created or take part in approving.`}),`\n`,_jsxs(_components.p,{children:[`Read it to follow an approval: `,_jsx(_components.code,{children:`status`}),` leaves `,_jsx(_components.code,{children:`REQUESTED`}),` once it is approved, denied, cancelled or expired, and `,_jsx(_components.code,{children:`executionStatus`}),` tells what happened after an approval.`]})]})}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":"Get a policy request","description":"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getRealmsByRealmIdOrganizationsByOrganizationIdPolicyRequestsByPolicyRequestId","summary":"Get a policy request","tags":["Policy Requests"],"x-p3-sidebar-order":2,"description":"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.","x-mint":{"content":"Organization admins can read any request of the organization. Any other member can read only a request they created or take part in approving.\n\nRead it to follow an approval: `status` leaves `REQUESTED` once it is approved, denied, cancelled or expired, and `executionStatus` tells what happened after an approval."},"parameters":["de9dd178-2ec6-4f7e-b9f7-3364b57f58a9","b5cb4ab1-5916-48a6-8e40-cecd0a900137","b9d9cae4-9321-4b94-af8d-3c92252ce3df"],"responses":{"200":"4c2a563e-296c-4412-9c20-d66982aed2b3","403":"db9bf097-33db-4688-a35f-7c0b43675b88","404":"47f06b78-cf27-40e0-ac56-4504d912ed57","422":"db2f610d-1e99-4dc8-b389-3d3dddf47568"},"x-p3-confidence":{"response":"generated:typed"},"method":"get","type":"path","servers":["9ebf5f3d-02bc-4c84-ae89-2f4826a2b66d","35deee0d-d6c8-428a-a4ad-64f8a5400b8c"],"security":[],"path":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","baseUrlOptions":["https://api.ruleengine.v2.portao3.com.br/","https://api.ruleengine.dev.3pers.com.br/"],"title":"Get a policy request","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"de9dd178-2ec6-4f7e-b9f7-3364b57f58a9":{"name":"realmId","in":"path","required":true,"description":"ID of your realm.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of your realm.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"},"b5cb4ab1-5916-48a6-8e40-cecd0a900137":{"name":"organizationId","in":"path","required":true,"description":"ID of the organization the policy request belongs to.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the organization the policy request belongs to.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410"},"b9d9cae4-9321-4b94-af8d-3c92252ce3df":{"name":"policyRequestId","in":"path","required":true,"description":"ID of the policy request. A payment or transfer request sent for approval carries it as `policyRequestId`.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the policy request. A payment or transfer request sent for approval carries it as `policyRequestId`.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a"}},"responses":{"4c2a563e-296c-4412-9c20-d66982aed2b3":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID of the policy request.","example":"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"realmId":{"type":"string","description":"ID of the realm the request belongs to.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","format":"uuid","isRequired":true,"uniqueKey":"realmId","typeLabel":"string\u003cuuid>"},"organizationId":{"type":"string","description":"ID of the organization the request belongs to.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","format":"uuid","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string\u003cuuid>"},"accountId":{"type":"string","description":"ID of the account that holds `walletId`.","example":"66f2a1c7b4d3e80012c9a0b4","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"walletId":{"type":"string","description":"ID of the subject's wallet — the paying wallet of a payment, the transaction's wallet in a spend review.","example":"6710b8e4c9e77b0012a4d6f3","isRequired":true,"uniqueKey":"walletId","typeLabel":"string"},"context":{"type":"string","enum":["PAYMENT","SPEND_REVIEW","TRAVEL"],"description":"Which policies govern the subject: `PAYMENT`, `SPEND_REVIEW` or `TRAVEL`.","example":"PAYMENT","isRequired":true,"uniqueKey":"context","typeLabel":"enum\u003cstring>"},"subjectType":{"type":"string","description":"What is being approved: `PIX`, `BOLETO`, `WALLET_TRANSFER_REQUEST` (a transfer request between wallets) or `TRANSACTION` (a spend review).","example":"PIX","isRequired":true,"uniqueKey":"subjectType","typeLabel":"string"},"subjectId":{"type":"string","description":"ID of the subject — the payment's `_id`, the transfer request's or the transaction's ID.","example":"6726a4f1b4d3e80012c9a3f1","isRequired":true,"uniqueKey":"subjectId","typeLabel":"string"},"requester":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user who asked for the subject.","example":"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d","isRequired":true,"uniqueKey":"requester.userId","typeLabel":"string"},"name":{"type":"string","description":"The requester's full name when the request was opened.","example":"Ana Souza","isRequired":true,"uniqueKey":"requester.name","typeLabel":"string"},"email":{"type":"string","description":"The requester's e-mail when the request was opened.","example":"ana.souza@example.com","isRequired":true,"uniqueKey":"requester.email","typeLabel":"string"}},"required":["userId","name","email"],"description":"Who asked for the subject.","isRequired":true,"uniqueKey":"requester","typeLabel":"object"},"body":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"body.additionalProperties","typeLabel":"any"},"description":"The subject as it was when the request was opened — what the policies evaluated and what the approvers are approving. A payment's approved amount and balance category are in `confirmation`.\n\n---\n\nExample: `{\"amount\":123000,\"description\":\"Folders da campanha de novembro\",\"creditParty\":{\"name\":\"Gráfica Aurora Ltda\"},\"confirmation\":{\"amount\":123000,\"category\":\"FLEX_INTERNATIONAL\"}}`","example":{"amount":123000,"description":"Folders da campanha de novembro","creditParty":{"name":"Gráfica Aurora Ltda"},"confirmation":{"amount":123000,"category":"FLEX_INTERNATIONAL"}},"isRequired":true,"uniqueKey":"body","typeLabel":"object"},"policyId":{"type":"string","description":"ID of the business policy that required the approval.","example":"3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f","format":"uuid","isRequired":true,"uniqueKey":"policyId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["REQUESTED","APPROVED","DENIED","CANCELED","EXPIRED"],"description":"Status of the request. `REQUESTED` — waiting for decisions. `APPROVED` — every required approval was given (or an admin force-approved it). `DENIED` — an approver or an admin denied it. `CANCELED` — the requester, an admin or Portão 3 cancelled it. `EXPIRED` — `approvalDeadline` passed while it was waiting. Every status but `REQUESTED` is final.","example":"REQUESTED","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"executionStatus":{"type":"string","enum":["WAITING","PROCESSING","EXECUTED","FAILED"],"description":"What happens after the approval: the policy's top-up, if any, then the subject is carried out (the payment is confirmed, the transfer request confirmed, the spend review approved). `WAITING` — not started: a request that is not approved stays `WAITING`, and an approved one goes back to it while a temporary problem is retried. `PROCESSING` — running. `EXECUTED` — done. `FAILED` — stopped, with the reason in `executionFailReason`.","example":"WAITING","isRequired":true,"uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"},"approvalDeadline":{"type":"string","description":"When the request expires if it is still waiting for decisions. Set by whoever opened the request — for a Pix or boleto payment, 21:00 (São Paulo time) of the day the payment is for, and at least one hour after it was sent.","example":"2026-11-07T00:00:00.000Z","format":"date-time","isRequired":true,"uniqueKey":"approvalDeadline","typeLabel":"string\u003cdate-time>"},"approvalHierarchy":{"type":"boolean","description":"`true` — the approval steps open one at a time, in order. `false` — they are all open at once.","example":false,"isRequired":true,"uniqueKey":"approvalHierarchy","typeLabel":"boolean"},"approvals":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["USER","GROUP"],"description":"`USER` — this one user decides. `GROUP` — any one member of the group decides for it.","example":"USER","isRequired":true,"uniqueKey":"approvals.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"ID of the user (`type: USER`) or of the group (`type: GROUP`).","example":"0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b","isRequired":true,"uniqueKey":"approvals.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Name of the user or group when the request was opened. An organization admin's force-approve or force-deny adds a step of its own, named after the admin.","example":"Rafael Lima","isRequired":true,"uniqueKey":"approvals.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["WAITING","REQUESTED","APPROVED","DENIED","CANCELED"],"description":"Status of the step. `WAITING` — not open yet: with `approvalHierarchy`, steps open one at a time, in order. `REQUESTED` — waiting for a decision. `APPROVED` / `DENIED` — decided. `CANCELED` — no longer needed, because the request was denied, cancelled, expired or decided by an admin.","example":"REQUESTED","isRequired":true,"uniqueKey":"approvals.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"users":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user.","example":"0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b","isRequired":true,"uniqueKey":"approvals.items.[INDEX].users.items.[INDEX].userId","typeLabel":"string"},"userName":{"type":"string","description":"The user's full name when the request was opened; empty if they had none.","example":"Rafael Lima","isRequired":true,"uniqueKey":"approvals.items.[INDEX].users.items.[INDEX].userName","typeLabel":"string"},"userEmail":{"type":"string","description":"The user's e-mail when the request was opened.","example":"rafael.lima@example.com","isRequired":true,"uniqueKey":"approvals.items.[INDEX].users.items.[INDEX].userEmail","typeLabel":"string"},"status":{"type":"string","enum":["WAITING","REQUESTED","APPROVED","DENIED","CANCELED"],"description":"This user's own decision status. `REQUESTED` means their decision is awaited; `CANCELED` means they no longer need to decide — another member of the group decided first, or the request was closed.","example":"REQUESTED","isRequired":true,"uniqueKey":"approvals.items.[INDEX].users.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["userId","userName","userEmail","status"],"description":"One person who can decide an approval step.","uniqueKey":"approvals.items.[INDEX].users.items.[INDEX]","typeLabel":"object"},"description":"Who can decide this step — one entry for a user, one per member for a group.","isRequired":true,"uniqueKey":"approvals.items.[INDEX].users","typeLabel":"object[]"},"createdAt":{"type":"string","description":"When the step was created.","example":"2026-11-06T13:42:10.512Z","format":"date-time","uniqueKey":"approvals.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"requestedAt":{"type":"string","description":"When the step opened for a decision. Absent while it is `WAITING`.","example":"2026-11-06T13:42:10.512Z","format":"date-time","uniqueKey":"approvals.items.[INDEX].requestedAt","typeLabel":"string\u003cdate-time>"},"decisionAt":{"type":"string","description":"When the step was decided.","example":"2026-11-06T15:03:44.207Z","format":"date-time","uniqueKey":"approvals.items.[INDEX].decisionAt","typeLabel":"string\u003cdate-time>"},"decisionReason":{"type":"string","description":"The reason the decider gave, when they gave one.","example":"Fora do orçamento do trimestre","uniqueKey":"approvals.items.[INDEX].decisionReason","typeLabel":"string"}},"required":["type","id","name","status","users"],"description":"One approval step: a user or a group whose decision the policy requires.","uniqueKey":"approvals.items.[INDEX]","typeLabel":"object"},"description":"The approval steps, in the policy's order. Empty on an `AUTO` request.","isRequired":true,"uniqueKey":"approvals","typeLabel":"object[]"},"createdAt":{"type":"string","description":"When the request was opened.","example":"2026-11-06T13:42:10.512Z","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"When the request last changed.","example":"2026-11-06T13:42:10.512Z","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"walletName":{"type":"string","description":"Name of the wallet when the request was opened. Absent on older requests.","example":"Marketing","uniqueKey":"walletName","typeLabel":"string"},"cardName":{"type":"string","description":"Name of the card, for a reviewed card transaction. Absent otherwise.","example":"Cartão Marketing","uniqueKey":"cardName","typeLabel":"string"},"denialReason":{"type":"string","description":"The reason given by whoever denied the request. Only on a `DENIED` request, and only when a reason was given.","example":"Fora do orçamento do trimestre","uniqueKey":"denialReason","typeLabel":"string"},"resolution":{"type":"string","enum":["AUTO"],"description":"`AUTO` when the policy approves on its own: the request was created already `APPROVED`, with no approvers, to run the policy's top-up. Absent on a request that went through approvers.","example":"AUTO","uniqueKey":"resolution","typeLabel":"enum\u003cstring>"},"executionMode":{"type":"string","enum":["MOVE_BALANCE_ONLY"],"description":"`MOVE_BALANCE_ONLY` when only the policy's top-up runs after the approval and the subject is carried out separately. Absent otherwise.","example":"MOVE_BALANCE_ONLY","uniqueKey":"executionMode","typeLabel":"enum\u003cstring>"},"executionFailReason":{"type":"string","description":"Why the execution failed, or why it is being retried — a code such as `MOVE_BALANCE_SOURCE_MISSING` for a problem detected before any money moved, otherwise the error of the step that failed (up to 200 characters).","example":"MOVE_BALANCE_SOURCE_MISSING","uniqueKey":"executionFailReason","typeLabel":"string"},"executionMoveBalance":{"type":"object","properties":{"addBalance":{"type":"boolean","description":"`true` when the policy tops up the subject's wallet with the subject's amount, from the wallet below, before the subject is carried out.","example":true,"isRequired":true,"uniqueKey":"executionMoveBalance.addBalance","typeLabel":"boolean"},"fromAccountId":{"type":"string","description":"ID of the account the top-up is taken from.","example":"66f2a1c7b4d3e80012c9a0b4","uniqueKey":"executionMoveBalance.fromAccountId","typeLabel":"string"},"fromWalletId":{"type":"string","description":"ID of the wallet the top-up is taken from.","example":"66f2a1c7b4d3e80012c9a0b9","uniqueKey":"executionMoveBalance.fromWalletId","typeLabel":"string"}},"required":["addBalance"],"description":"The top-up the matched policy runs after the approval. Absent when it has none.","uniqueKey":"executionMoveBalance","typeLabel":"object"},"fundingClaimedAt":{"type":"string","description":"When this request took charge of topping up the subject's wallet — just before the top-up ran. Only on the one request per subject that does it.","example":"2026-11-06T15:03:45.031Z","format":"date-time","uniqueKey":"fundingClaimedAt","typeLabel":"string\u003cdate-time>"},"fundedAt":{"type":"string","description":"When the top-up for this subject completed. Absent while it has not completed, or when this request moved no money.","example":"2026-11-06T15:03:46.418Z","format":"date-time","uniqueKey":"fundedAt","typeLabel":"string\u003cdate-time>"},"fundingClaim":{"type":"boolean","description":"`true` on the one request per subject that took charge of topping up its wallet. It is set before the top-up runs and kept even if the top-up then fails, so it does not mean the money moved — `fundedAt` does. Absent otherwise.","example":true,"uniqueKey":"fundingClaim","typeLabel":"boolean"},"executionAttempts":{"type":"number","description":"How many times the execution was retried after a temporary problem that happened before any money moved. Absent when it was never retried.","example":1,"uniqueKey":"executionAttempts","typeLabel":"number"}},"required":["id","realmId","organizationId","accountId","walletId","context","subjectType","subjectId","requester","body","policyId","status","executionStatus","approvalDeadline","approvalHierarchy","approvals","createdAt","updatedAt"],"description":"A policy request: the approval request of a payment, a transfer request or a reviewed transaction, waiting for the decisions a business policy requires.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"6710b8e4c9e77b0012a4d6f3","context":"PAYMENT","subjectType":"PIX","subjectId":"6726a4f1b4d3e80012c9a3f1","requester":{"userId":"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d","name":"Ana Souza","email":"ana.souza@example.com"},"body":{"amount":123000,"description":"Folders da campanha de novembro","creditParty":{"name":"Gráfica Aurora Ltda"},"confirmation":{"amount":123000,"category":"FLEX_INTERNATIONAL"}},"policyId":"3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f","status":"REQUESTED","executionStatus":"WAITING","approvalDeadline":"2026-11-07T00:00:00.000Z","approvalHierarchy":false,"approvals":[{"type":"USER","id":"0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b","name":"Rafael Lima","status":"REQUESTED","users":[{"userId":"0b6f2c1e-8d4a-4f3b-9a7e-5c2d1e0f9a8b","userName":"Rafael Lima","userEmail":"rafael.lima@example.com","status":"REQUESTED"}],"createdAt":"2026-11-06T13:42:10.512Z","requestedAt":"2026-11-06T13:42:10.512Z","decisionAt":"2026-11-06T15:03:44.207Z","decisionReason":"Fora do orçamento do trimestre"}],"createdAt":"2026-11-06T13:42:10.512Z","updatedAt":"2026-11-06T13:42:10.512Z","walletName":"Marketing","cardName":"Cartão Marketing","denialReason":"Fora do orçamento do trimestre","resolution":"AUTO","executionMode":"MOVE_BALANCE_ONLY","executionFailReason":"MOVE_BALANCE_SOURCE_MISSING","executionMoveBalance":{"addBalance":true,"fromAccountId":"66f2a1c7b4d3e80012c9a0b4","fromWalletId":"66f2a1c7b4d3e80012c9a0b9"},"fundingClaimedAt":"2026-11-06T15:03:45.031Z","fundedAt":"2026-11-06T15:03:46.418Z","fundingClaim":true,"executionAttempts":1}}},"exampleType":"generated"}},"exampleType":"generated"},"db9bf097-33db-4688-a35f-7c0b43675b88":{"description":"`POLICY_REQUEST_FORBIDDEN` — You are not a member of the organization, or you neither created the request nor take part in approving it and are not an organization admin.","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":["POLICY_REQUEST_FORBIDDEN"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["RULE_ENGINE"],"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":"POLICY_REQUEST_FORBIDDEN","origin":"RULE_ENGINE","message":"You do not have permission to perform this action"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"POLICY_REQUEST_FORBIDDEN","origin":"RULE_ENGINE","message":"You do not have permission to perform this action"}}},"exampleType":"examples"}},"exampleType":"examples"},"47f06b78-cf27-40e0-ac56-4504d912ed57":{"description":"`POLICY_REQUEST_NOT_FOUND` — No policy request with this ID exists in the organization.","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":["POLICY_REQUEST_NOT_FOUND"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["RULE_ENGINE"],"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":"POLICY_REQUEST_NOT_FOUND","origin":"RULE_ENGINE","message":"Policy request not found"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"POLICY_REQUEST_NOT_FOUND","origin":"RULE_ENGINE","message":"Policy request not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"db2f610d-1e99-4dc8-b389-3d3dddf47568":{"description":"`BAD_REQUEST` — A path parameter is not a valid ID; `fields` lists each one.","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"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["RULE_ENGINE"],"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":{"type":"array","description":"One entry per invalid request field (validation errors only).","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.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Why the field was rejected.","example":"label is required","isRequired":true,"uniqueKey":"fields.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.items.[INDEX].code","typeLabel":"string"},"values":{"type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"description":"The accepted values, when the field is an enumeration.","uniqueKey":"fields.items.[INDEX].values","typeLabel":"string[]"}},"required":["field","message","code"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"fields","typeLabel":"object[]"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BAD_REQUEST","origin":"RULE_ENGINE","message":"Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.","fields":[{"field":"policyRequestId","message":"Invalid UUID","code":"POLICYREQUESTID_UUID"}]},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BAD_REQUEST","origin":"RULE_ENGINE","message":"Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.","fields":[{"field":"policyRequestId","message":"Invalid UUID","code":"POLICYREQUESTID_UUID"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"9ebf5f3d-02bc-4c84-ae89-2f4826a2b66d":{"url":"https://api.ruleengine.v2.portao3.com.br/","description":"production"},"35deee0d-d6c8-428a-a4ad-64f8a5400b8c":{"url":"https://api.ruleengine.dev.3pers.com.br/","description":"development"}}},"originalFileLocation":"api-reference/ruleengine.openapi.json"},"subdomain":"porto3","siteName":"Portão 3","title":"Get a policy request - Portão 3","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/ruleengine/policy-requests/get-a-policy-request","matchLevel":0},"pt-BR":{"href":"/api-reference/ruleengine/policy-requests/get-a-policy-request","matchLevel":0}}},"lastModified":"2026-11-06T02:17:39.995Z","originalFileLocation":"api-reference/ruleengine/policy-requests/get-a-policy-request.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=\"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\">\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=\"Get a policy request - Portão 3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\">\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/ruleengine/policy-requests/get-a-policy-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://porto3.mintlify.site/_mintlify/api/og/v2?division=Policy+Requests\u0026amp;title=Get+a+policy+request\u0026amp;description=Gets+a+policy+request+%E2%80%94+the+approval+request+of+a+payment%2C+a+transfer+request+or+a+reviewed+transaction+%E2%80%94+with+every+approval+step+and+who+decided+what.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=5fcec0457e70c2abc9b8603093a83e16b83da45f2122ef0b689f6dcaaf0f5ce7\">\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=\"Get a policy request - Portão 3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://porto3.mintlify.site/_mintlify/api/og/v2?division=Policy+Requests\u0026amp;title=Get+a+policy+request\u0026amp;description=Gets+a+policy+request+%E2%80%94+the+approval+request+of+a+payment%2C+a+transfer+request+or+a+reviewed+transaction+%E2%80%94+with+every+approval+step+and+who+decided+what.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=5fcec0457e70c2abc9b8603093a83e16b83da45f2122ef0b689f6dcaaf0f5ce7\">\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/ruleengine/policy-requests/get-a-policy-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ruleengine/policy-requests/get-a-policy-request.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/ruleengine/policy-requests/get-a-policy-request#webpage\",\"url\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request\",\"name\":\"Get a policy request\",\"description\":\"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\",\"dateModified\":\"2026-11-06T02:17:39.995Z\",\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Rule Engine\",\"item\":\"https://developers.portao3.com.br/api-reference/ruleengine/business-policies/realms-organizations-business-policies\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Policy Requests\",\"item\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/list-an-organizations-policy-requests\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a policy request\",\"item\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request#apireference\",\"headline\":\"Get a policy request\",\"name\":\"Get a policy request\",\"description\":\"Gets a policy request — the approval request of a payment, a transfer request or a reviewed transaction — with every approval step and who decided what.\",\"url\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request\",\"mainEntityOfPage\":{\"@id\":\"https://developers.portao3.com.br/api-reference/ruleengine/policy-requests/get-a-policy-request#webpage\"},\"dateModified\":\"2026-11-06T02:17:39.995Z\",\"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"}]},{"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 Billing","pages":[{"title":"List the realm's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-billing/list-the-realms-pix-charges"},{"title":"List an organization's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-organizations-pix-charges"},{"title":"List an account's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-accounts-pix-charges"},{"title":"List a wallet's Pix charges","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-billing/list-a-wallets-pix-charges"},{"title":"Create a Pix charge","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-billing/create-a-pix-charge"},{"title":"Get a Pix charge","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-billing/get-a-pix-charge"},{"title":"Cancel a Pix charge","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-billing/cancel-a-pix-charge"},{"title":"Get a Pix charge for its payment page","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge-for-its-payment-page"}]},{"group":"PIX Automatic","pages":[{"title":"List the realm's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-the-realms-pix-automatic-authorizations"},{"title":"List an organization's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-organizations-pix-automatic-authorizations"},{"title":"List an account's Pix Automatic authorizations","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/list-an-accounts-pix-automatic-authorizations"},{"title":"List a wallet's Pix Automatic authorizations","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/list-a-wallets-pix-automatic-authorizations"},{"title":"Create a Pix Automatic authorization","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/create-a-pix-automatic-authorization"},{"title":"List a wallet's Pix Automatic charges","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/list-a-wallets-pix-automatic-charges"},{"title":"Get a Pix Automatic authorization","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/get-a-pix-automatic-authorization"},{"title":"Cancel a Pix Automatic authorization","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/cancel-a-pix-automatic-authorization"},{"title":"List an authorization's charges","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/list-an-authorizations-charges"},{"title":"Get a Pix Automatic charge","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/get-a-pix-automatic-charge"},{"title":"Update a Pix Automatic charge","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/update-a-pix-automatic-charge"},{"title":"Cancel a Pix Automatic charge","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/cancel-a-pix-automatic-charge"},{"title":"List an authorization's 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/list-an-authorizations-history"}]},{"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","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","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 Billing","pages":[{"title":"List the realm's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-the-realms-boleto-charges"},{"title":"List an organization's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-organizations-boleto-charges"},{"title":"List an account's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-accounts-boleto-charges"},{"title":"List a wallet's boleto charges","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-billing/list-a-wallets-boleto-charges"},{"title":"Create a boleto charge","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-billing/create-a-boleto-charge"},{"title":"Get a boleto charge","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-billing/get-a-boleto-charge"},{"title":"Download a boleto charge's 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-billing/download-a-boleto-charges-pdf"}]},{"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 Requests","pages":[{"title":"List an organization's policy requests","description":"Lists the organization's policy requests — the approval requests opened when a business policy requires approval for a payment, a transfer request or a reviewed transaction.","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/list-an-organizations-policy-requests"},{"title":"Get a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request"},{"title":"Approve a policy request","description":"Approves a policy request with your decision as one of its approvers.","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/approve-a-policy-request"},{"title":"Deny a policy request","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/deny-a-policy-request"},{"title":"Cancel a policy request","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/cancel-a-policy-request"},{"title":"Force-approve a policy request","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/force-approve-a-policy-request"},{"title":"Force-deny a policy request","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/force-deny-a-policy-request"}]}]},{"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"},{"title":"Cancel a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/cancel","href":"/api-reference/scheduling/schedules/cancel-a-schedule"}]}]},{"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"}]},{"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 Billing","pages":[{"title":"List the realm's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-billing/list-the-realms-pix-charges"},{"title":"List an organization's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-organizations-pix-charges"},{"title":"List an account's Pix charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-billing/list-an-accounts-pix-charges"},{"title":"List a wallet's Pix charges","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-billing/list-a-wallets-pix-charges"},{"title":"Create a Pix charge","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-billing/create-a-pix-charge"},{"title":"Get a Pix charge","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-billing/get-a-pix-charge"},{"title":"Cancel a Pix charge","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-billing/cancel-a-pix-charge"},{"title":"Get a Pix charge for its payment page","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-billing/get-a-pix-charge-for-its-payment-page"}]},{"group":"PIX Automatic","pages":[{"title":"List the realm's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-the-realms-pix-automatic-authorizations"},{"title":"List an organization's Pix Automatic authorizations","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/list-an-organizations-pix-automatic-authorizations"},{"title":"List an account's Pix Automatic authorizations","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/list-an-accounts-pix-automatic-authorizations"},{"title":"List a wallet's Pix Automatic authorizations","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/list-a-wallets-pix-automatic-authorizations"},{"title":"Create a Pix Automatic authorization","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/create-a-pix-automatic-authorization"},{"title":"List a wallet's Pix Automatic charges","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/list-a-wallets-pix-automatic-charges"},{"title":"Get a Pix Automatic authorization","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/get-a-pix-automatic-authorization"},{"title":"Cancel a Pix Automatic authorization","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/cancel-a-pix-automatic-authorization"},{"title":"List an authorization's charges","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/list-an-authorizations-charges"},{"title":"Get a Pix Automatic charge","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/get-a-pix-automatic-charge"},{"title":"Update a Pix Automatic charge","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/update-a-pix-automatic-charge"},{"title":"Cancel a Pix Automatic charge","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/cancel-a-pix-automatic-charge"},{"title":"List an authorization's 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/list-an-authorizations-history"}]},{"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","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","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 Billing","pages":[{"title":"List the realm's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-the-realms-boleto-charges"},{"title":"List an organization's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-organizations-boleto-charges"},{"title":"List an account's boleto charges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-billing/list-an-accounts-boleto-charges"},{"title":"List a wallet's boleto charges","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-billing/list-a-wallets-boleto-charges"},{"title":"Create a boleto charge","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-billing/create-a-boleto-charge"},{"title":"Get a boleto charge","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-billing/get-a-boleto-charge"},{"title":"Download a boleto charge's 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-billing/download-a-boleto-charges-pdf"}]},{"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 Requests","pages":[{"title":"List an organization's policy requests","description":"Lists the organization's policy requests — the approval requests opened when a business policy requires approval for a payment, a transfer request or a reviewed transaction.","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/list-an-organizations-policy-requests"},{"title":"Get a policy request","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/get-a-policy-request"},{"title":"Approve a policy request","description":"Approves a policy request with your decision as one of its approvers.","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/approve-a-policy-request"},{"title":"Deny a policy request","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/deny-a-policy-request"},{"title":"Cancel a policy request","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/cancel-a-policy-request"},{"title":"Force-approve a policy request","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/force-approve-a-policy-request"},{"title":"Force-deny a policy request","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/force-deny-a-policy-request"}]}]},{"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"},{"title":"Cancel a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/cancel","href":"/api-reference/scheduling/schedules/cancel-a-schedule"}]}]},{"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":"Get a policy request - Portão 3","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}