{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "WALLET_NOT_ACTIVE",
"origin": "BANKING",
"message": "Wallet is not active"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "type",
"message": "Invalid option: expected one of \"EVP\"|\"CNPJ\"|\"CPF\"|\"EMAIL\"|\"PHONE\"",
"code": "TYPE_ONE_OF",
"values": [
"EVP",
"CNPJ",
"CPF",
"EMAIL",
"PHONE"
]
}
]
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider did not respond in time, please retry"
}
Register a Pix key
Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "WALLET_NOT_ACTIVE",
"origin": "BANKING",
"message": "Wallet is not active"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "FORBIDDEN_WALLET",
"origin": "BANKING",
"message": "You do not have permission to perform this action on this wallet"
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "BANKING",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "type",
"message": "Invalid option: expected one of \"EVP\"|\"CNPJ\"|\"CPF\"|\"EMAIL\"|\"PHONE\"",
"code": "TYPE_ONE_OF",
"values": [
"EVP",
"CNPJ",
"CPF",
"EMAIL",
"PHONE"
]
}
]
}
{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BANKING_PROVIDER_UNAVAILABLE",
"origin": "BANKING",
"message": "Banking provider did not respond in time, please retry"
}
Send the key’s type and — for every type but a random key (EVP) — its value. The key usually comes back ACTIVE, ready to receive. When the phone number or e-mail address must be proven yours, it comes back PENDING_CONFIRMATION: request a confirmation code, then confirm the key with it. A wallet can hold more than one key. Use default as walletId for the organization’s main wallet.When registering fails, the error is returned and the attempt stays in the wallet’s list as a FAILED key, with the reason in failReason. When the bank refused the key (a 422), nothing was registered: fix the cause and register it again. When the bank failed or didn’t answer in time (a 5xx), the key may have been registered anyway — registering the same CNPJ, CPF, e-mail or phone again then usually answers ENTRY_ALREADY_EXISTS; contact support to have it reconciled. If the bank throttles the request, you get a 429: wait and retry.You need to be an organization admin, or have the wallet shared with you as OWNER or USER.
Kind of key: EVP (a random key the bank generates), CNPJ or CPF (the account holder's document), EMAIL or PHONE. A document key must be the account holder's own CPF or CNPJ.
The key to register. Required for every type but EVP, whose key is generated for you — a value sent with EVP is ignored. Formats: CPF, 11 digits; CNPJ, 14 characters (12 letters or digits, then 2 digits) without punctuation; EMAIL, a lowercase e-mail address; PHONE, + and the country code, area code and number, digits only (+5511987654321). At most 77 characters, and some words used in scams are refused.
Example:
"financeiro@horizontelog.com.br"
Response
Successful response
A Pix key of a wallet: an alias (a random key, a CPF or CNPJ, an e-mail address or a phone number) registered in the Pix directory so that payers can send Pix to the wallet without its bank details.
ACTIVE — registered: Pix sent to the key reach the wallet.
PENDING_CONFIRMATION — waiting for the confirmation code sent to the phone number or e-mail address (request one with request-otp, then confirm it).
REMOVED — removed from the wallet, or claimed by another institution. A removed key stays listed.
FAILED — registering failed; failReason says why. When the bank refused the key, nothing was registered; when it failed or didn't answer in time, the key may have been registered anyway.
The key: a lowercase UUID for EVP, digits only for CPF and CNPJ (a CNPJ may carry letters in its first 12 positions), a lowercase e-mail address, or a phone number as + and digits (+5511987654321). On a FAILED key, what was sent — empty for an EVP that was never generated.
Why the registration was refused, as <code> | <message> — for example ENTRY_KEY_OWNED_BY_DIFFERENT_PERSON | The key already exists in the provider, but is linked to another person. Only on FAILED keys.
Example:
"ENTRY_KEY_OWNED_BY_DIFFERENT_PARTICIPANT | The key is linked to another institution."
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Portão 3","colors":{"primary":"#43418E","light":"#8D8AE0","dark":"#302E65"},"logo":{"light":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9","dark":"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/dark.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=47b0ed7a3645b0b5460c05d8b107963e"},"favicon":"https://mintcdn.com/porto3/dSTOaRKpfB0RS1lU/favicon.ico?fit=max\u0026auto=format\u0026n=dSTOaRKpfB0RS1lU\u0026q=85\u0026s=194badfbfde2e6414d74da0762416602","navbar":{"links":[{"href":"mailto:suporte@portao3.com.br","label":"Support"}],"primary":{"type":"button","label":"portao3.com.br","href":"https://portao3.com.br"}},"footer":{"socials":{"website":"https://portao3.com.br"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"pt-BR","href":"pt-BR"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"porto3","hasAudioNarration":false,"actualSubdomain":"porto3","customDomains":["developers.portao3.com.br"],"gitSource":{"type":"github","owner":"portao-3","repo":"portao3-backend","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4bba6d11-5abe-4a52-ad77-08bba6b8d5c1","liveDeploymentHistoryId":"6aebdbb6f69d5497a3c3861b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebdbb6f69d5497a3c3861b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6aebdbb6f69d5497a3c3861b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":426},{"language":"default","tag":"Banking","count":158},{"language":"default","tag":"Platform","count":92},{"language":"default","tag":"Billing","count":38},{"language":"default","tag":"Travel","count":32},{"language":"default","tag":"Wallets","count":29},{"language":"default","tag":"Identity","count":29},{"language":"default","tag":"Cards","count":27},{"language":"default","tag":"Registry","count":24},{"language":"default","tag":"Transactions \u0026 Statements","count":18},{"language":"en","tag":"Guides","count":15},{"language":"pt-BR","tag":"Guias","count":15},{"language":"en","tag":"PIX \u0026 payments","count":7},{"language":"pt-BR","tag":"PIX e pagamentos","count":7},{"language":"en","tag":"Cards","count":3},{"language":"pt-BR","tag":"Cartões","count":3},{"language":"en","tag":"API Reference","count":2},{"language":"en","tag":"Overview","count":2},{"language":"en","tag":"Getting Started","count":2},{"language":"pt-BR","tag":"Referência da API","count":2},{"language":"pt-BR","tag":"Visão geral","count":2},{"language":"pt-BR","tag":"Primeiros passos","count":2},{"language":"en","tag":"Integration guides","count":1},{"language":"en","tag":"Accounts \u0026 wallets","count":1},{"language":"en","tag":"Building your integration","count":1},{"language":"pt-BR","tag":"Guias de integração","count":1},{"language":"pt-BR","tag":"Contas e carteiras","count":1},{"language":"pt-BR","tag":"Construindo sua integração","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"api-reference.css","content":"[class*=\"param-field\"]>.py-6>.mt-4{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4>*+*{margin-top:0!important}[class*=\"param-field\"]>.py-6>.mt-4 .prose>p,[class*=\"param-field\"]>.py-6>.mt-4 .prose p.whitespace-pre-line{margin-top:0!important;margin-bottom:0!important}[class*=\"param-field\"]>.py-6>.mt-4>.mt-6,.api-section .whitespace-pre-wrap.prose-sm.mt-6{margin-top:0!important}html[data-current-path^=\"/api-reference/\"] div.mt-2.text-lg.prose{font-size:1rem!important;line-height:1.5rem!important;margin-bottom:1.5rem!important}h4.api-section-heading-title{font-size:1.5rem!important;line-height:2rem!important}.api-section-heading>.border-b{border-bottom-width:0!important;padding-bottom:0!important}.api-section-heading div.font-mono.text-xs:not(:has(button)){display:none!important}.api-section-heading div.relative:has(>button[disabled]){display:none!important}html[data-current-path^=\"/api-reference/\"] .mdx-content.prose{font-size:1rem!important;line-height:1.5rem!important}[class*=\"param-field\"]>.py-6>.mt-4{display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child{display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>.space-y-4:first-child>hr+p{order:99!important}[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr){display:flex!important;flex-direction:column!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child:has(>.space-y-4:first-child>hr),[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child:has(>hr){display:contents!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4>div>div:first-child>.space-y-4:first-child>hr+p{order:99!important;margin-top:0.75rem!important}.param-head[id^=\"response-\"] [data-component-part=\"field-required-pill\"]{display:none!important}[class*=\"param-field\"]>.py-6>.mt-4:has(>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre),[class*=\"param-field\"]>.py-6>.mt-4>div:has(>div:first-child>.space-y-4:first-child>hr)>.mt-6:has(>span+div pre){display:none!important}"}],"page":{"pagePath":"api-reference/banking/pix-keys/register-a-pix-key","slug":"/api-reference/banking/pix-keys/register-a-pix-key","pageMetadata":{"title":"Register a Pix key","description":"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.","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","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: \"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\"\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={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Send the key’s `,_jsx(_components.code,{children:`type`}),` and — for every type but a random key (`,_jsx(_components.code,{children:`EVP`}),`) — its `,_jsx(_components.code,{children:`value`}),`. The key usually comes back `,_jsx(_components.code,{children:`ACTIVE`}),`, ready to receive. When the phone number or e-mail address must be proven yours, it comes back `,_jsx(_components.code,{children:`PENDING_CONFIRMATION`}),`: `,_jsx(_components.a,{href:`/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code`,children:`request a confirmation code`}),`, then `,_jsx(_components.a,{href:`/api-reference/banking/pix-keys/confirm-a-pix-key`,children:`confirm the key`}),` with it. A wallet can hold more than one key. Use `,_jsx(_components.code,{children:`default`}),` as `,_jsx(_components.code,{children:`walletId`}),` for the organization’s main wallet.`]}),`\n`,_jsxs(_components.p,{children:[`When registering fails, the error is returned and the attempt stays in the wallet’s list as a `,_jsx(_components.code,{children:`FAILED`}),` key, with the reason in `,_jsx(_components.code,{children:`failReason`}),`. When the bank refused the key (a `,_jsx(_components.code,{children:`422`}),`), nothing was registered: fix the cause and register it again. When the bank failed or didn’t answer in time (a `,_jsx(_components.code,{children:`5xx`}),`), the key may have been registered anyway — registering the same CNPJ, CPF, e-mail or phone again then usually answers `,_jsx(_components.code,{children:`ENTRY_ALREADY_EXISTS`}),`; contact support to have it reconciled. If the bank throttles the request, you get a `,_jsx(_components.code,{children:`429`}),`: wait and retry.`]}),`\n`,_jsxs(_components.p,{children:[`You need to be an organization admin, or have the wallet shared with you as `,_jsx(_components.code,{children:`OWNER`}),` or `,_jsx(_components.code,{children:`USER`}),`.`]})]})}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":"Register a Pix key","description":"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDict","summary":"Register a Pix key","tags":["Pix Keys"],"x-p3-sidebar-order":5,"description":"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.","x-mint":{"content":"Send the key's `type` and — for every type but a random key (`EVP`) — its `value`. The key usually comes back `ACTIVE`, ready to receive. When the phone number or e-mail address must be proven yours, it comes back `PENDING_CONFIRMATION`: [request a confirmation code](/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code), then [confirm the key](/api-reference/banking/pix-keys/confirm-a-pix-key) with it. A wallet can hold more than one key. Use `default` as `walletId` for the organization's main wallet.\n\nWhen registering fails, the error is returned and the attempt stays in the wallet's list as a `FAILED` key, with the reason in `failReason`. When the bank refused the key (a `422`), nothing was registered: fix the cause and register it again. When the bank failed or didn't answer in time (a `5xx`), the key may have been registered anyway — registering the same CNPJ, CPF, e-mail or phone again then usually answers `ENTRY_ALREADY_EXISTS`; contact support to have it reconciled. If the bank throttles the request, you get a `429`: wait and retry.\n\nYou need to be an organization admin, or have the wallet shared with you as `OWNER` or `USER`."},"parameters":["5f1cef22-e4fd-4724-ba65-8e58a1c0835b","e6f3d3c6-e4a6-407d-bc87-3dcdf73da707","595e0e33-c8ba-4a73-9eec-583af5a1a68a","4f34019a-e403-4a1f-8b8f-6245d2c94419","6a81e7bc-26da-40e4-840b-ba98bdf076ad"],"requestBody":"74a12806-7c21-455a-b8d2-e1d2b1b3ea01","responses":{"201":"ea20cfda-ab2d-4912-962c-d4aa9c3acd7f","400":"2e0e8337-10bd-4e70-a30b-b57e98e7df9d","403":"28ed7d6a-c8cd-4889-9f24-4e7174318c65","404":"1d73d29d-5b95-4bb4-ad05-ba5a468273fa","422":"a4f7acde-c6f3-4f69-af62-d7a1c3489c7d","500":"d1bb739e-bad8-47cc-9215-3760c4d35633","502":"5273dad8-5c57-4e35-a412-770e23dbab1b","503":"298c9c1a-0c24-41d3-bd58-49d1a8acfe98","504":"e1c91389-6421-45b4-af4a-751ded8417b2"},"x-p3-confidence":{"response":"generated:typed","request":"generated:typed","parameters":"generated:typed","note":"`.superRefine(…)` constraint not represented (runtime-dependent value)"},"method":"post","type":"path","servers":["504b00e5-7d7a-4410-8cf8-61e77110dc43","602acb2b-75bc-4c7d-a310-ef850a3fc860"],"security":[],"path":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","baseUrlOptions":["https://api.banking.v2.portao3.com.br/","https://api.banking.dev.3pers.com.br/"],"title":"Register a Pix key","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5f1cef22-e4fd-4724-ba65-8e58a1c0835b":{"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"},"e6f3d3c6-e4a6-407d-bc87-3dcdf73da707":{"name":"organizationId","in":"path","required":true,"description":"ID of the organization.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the organization.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410"},"595e0e33-c8ba-4a73-9eec-583af5a1a68a":{"name":"accountId","in":"path","required":true,"description":"ID of the organization's account (24 hexadecimal characters).","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"ID of the organization's account (24 hexadecimal characters).","uniqueKey":"","typeLabel":"string"},"example":"66f2a1c7b4d3e80012c9a0b4"},"4f34019a-e403-4a1f-8b8f-6245d2c94419":{"name":"walletId","in":"path","required":true,"description":"ID of the wallet that receives the key (24 hexadecimal characters), or `default` for the organization's main wallet.","schema":{"type":"string","pattern":"^([0-9a-fA-F]{24}|default)$","isRequired":true,"description":"ID of the wallet that receives the key (24 hexadecimal characters), or `default` for the organization's main wallet.","uniqueKey":"","typeLabel":"string"},"example":"66f2a3d1b4d3e80012c9a0d2"},"6a81e7bc-26da-40e4-840b-ba98bdf076ad":{"name":"x-environment","in":"header","required":false,"description":"Environment of the wallet: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected.","schema":{"type":"string","enum":["LIVE","TEST"],"isRequired":false,"description":"Environment of the wallet: `LIVE` (production) or `TEST` (sandbox). When you omit it, `TEST` is used; any other value is rejected.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"LIVE"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["EVP","CNPJ","CPF","EMAIL","PHONE"],"description":"Kind of key: `EVP` (a random key the bank generates), `CNPJ` or `CPF` (the account holder's document), `EMAIL` or `PHONE`. A document key must be the account holder's own CPF or CNPJ.","example":"EMAIL","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"value":{"description":"The key to register. Required for every type but `EVP`, whose key is generated for you — a value sent with `EVP` is ignored. Formats: `CPF`, 11 digits; `CNPJ`, 14 characters (12 letters or digits, then 2 digits) without punctuation; `EMAIL`, a lowercase e-mail address; `PHONE`, `+` and the country code, area code and number, digits only (`+5511987654321`). At most 77 characters, and some words used in scams are refused.","example":"financeiro@horizontelog.com.br","type":"string","uniqueKey":"value","typeLabel":"string"}},"required":["type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"EMAIL","value":"financeiro@horizontelog.com.br"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"ea20cfda-ab2d-4912-962c-d4aa9c3acd7f":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the Pix key — use it as `pixDictId`.","example":"6728b1e2b4d3e80012c9a5a1","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"realmId":{"type":"string","description":"ID of the realm.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","isRequired":true,"uniqueKey":"realmId","typeLabel":"string"},"organizationId":{"type":"string","description":"ID of the organization.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string"},"accountId":{"type":"string","description":"ID of the organization's account.","example":"66f2a1c7b4d3e80012c9a0b4","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"walletId":{"type":"string","description":"ID of the wallet that holds the key.","example":"66f2a3d1b4d3e80012c9a0d2","isRequired":true,"uniqueKey":"walletId","typeLabel":"string"},"environment":{"type":"string","enum":["LIVE","TEST"],"description":"Environment of the key: `LIVE` or `TEST`.","example":"LIVE","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"account":{"type":"object","properties":{"bankIspb":{"type":"string","description":"ISPB code of Portão 3's banking partner, which holds the account (8 digits). `failed` when the key could not be registered.","example":"12345678","isRequired":true,"uniqueKey":"account.bankIspb","typeLabel":"string"},"branch":{"type":"string","description":"Branch of the account. `failed` when the key could not be registered.","example":"001","isRequired":true,"uniqueKey":"account.branch","typeLabel":"string"},"number":{"type":"number","description":"Number of the account. `-1` when the key could not be registered.","example":10023456,"isRequired":true,"uniqueKey":"account.number","typeLabel":"number"},"type":{"type":"string","enum":["CACC","SLRY","SVGS","TRAN"],"description":"Type of the account: `TRAN` (payment account) for the wallets' keys. `CACC` when the key could not be registered.","example":"TRAN","isRequired":true,"uniqueKey":"account.type","typeLabel":"enum\u003cstring>"}},"required":["bankIspb","branch","number","type"],"description":"The bank account the key points to.","isRequired":true,"uniqueKey":"account","typeLabel":"object"},"external":{"type":"object","properties":{"entryId":{"type":"string","description":"ID of the key's entry in the Pix directory. `failed` when the key could not be registered.","example":"b6f1d2c3-4e5a-4b7c-9d8e-1f2a3b4c5d6e","uniqueKey":"external.entryId","typeLabel":"string"}},"description":"The key's identifiers in the Pix directory.","isRequired":true,"uniqueKey":"external","typeLabel":"object"},"status":{"type":"string","enum":["ACTIVE","PENDING_CONFIRMATION","REMOVED","FAILED"],"description":"Status of the key:\n- `ACTIVE` — registered: Pix sent to the key reach the wallet.\n- `PENDING_CONFIRMATION` — waiting for the confirmation code sent to the phone number or e-mail address (request one with `request-otp`, then confirm it).\n- `REMOVED` — removed from the wallet, or claimed by another institution. A removed key stays listed.\n- `FAILED` — registering failed; `failReason` says why. When the bank refused the key, nothing was registered; when it failed or didn't answer in time, the key may have been registered anyway.","example":"ACTIVE","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["PHONE","EMAIL","CPF","CNPJ","EVP"],"description":"Kind of key: `EVP` (random key), `CNPJ`, `CPF`, `EMAIL` or `PHONE`.","example":"EVP","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The key: a lowercase UUID for `EVP`, digits only for `CPF` and `CNPJ` (a CNPJ may carry letters in its first 12 positions), a lowercase e-mail address, or a phone number as `+` and digits (`+5511987654321`). On a `FAILED` key, what was sent — empty for an `EVP` that was never generated.","example":"9f1c2e7a-4b3d-4e8f-a6c1-2d5b7e9f0a13","isRequired":true,"uniqueKey":"value","typeLabel":"string"},"createdAt":{"type":"string","description":"When the key was created (ISO 8601).","example":"2026-11-04T14:05:12.348Z","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the key was last updated (ISO 8601).","example":"2026-11-04T14:05:12.348Z","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"__v":{"type":"number","description":"Internal version of the record.","example":0,"isRequired":true,"uniqueKey":"__v","typeLabel":"number"},"failReason":{"type":"string","description":"Why the registration was refused, as `\u003ccode> | \u003cmessage>` — for example `ENTRY_KEY_OWNED_BY_DIFFERENT_PERSON | The key already exists in the provider, but is linked to another person.` Only on `FAILED` keys.","example":"ENTRY_KEY_OWNED_BY_DIFFERENT_PARTICIPANT | The key is linked to another institution.","uniqueKey":"failReason","typeLabel":"string"}},"required":["_id","realmId","organizationId","accountId","walletId","environment","account","external","status","type","value","createdAt","updatedAt","__v"],"description":"A Pix key of a wallet: an alias (a random key, a CPF or CNPJ, an e-mail address or a phone number) registered in the Pix directory so that payers can send Pix to the wallet without its bank details.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"6728b1e2b4d3e80012c9a5a1","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"66f2a3d1b4d3e80012c9a0d2","environment":"LIVE","account":{"bankIspb":"12345678","branch":"001","number":10023456,"type":"TRAN"},"external":{"entryId":"b6f1d2c3-4e5a-4b7c-9d8e-1f2a3b4c5d6e"},"status":"ACTIVE","type":"EVP","value":"9f1c2e7a-4b3d-4e8f-a6c1-2d5b7e9f0a13","createdAt":"2026-11-04T14:05:12.348Z","updatedAt":"2026-11-04T14:05:12.348Z","__v":0,"failReason":"ENTRY_KEY_OWNED_BY_DIFFERENT_PARTICIPANT | The key is linked to another institution."}}},"exampleType":"generated"}},"exampleType":"generated"},"2e0e8337-10bd-4e70-a30b-b57e98e7df9d":{"description":"`WALLET_NOT_ACTIVE` — The wallet isn't `ACTIVE`.","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":["WALLET_NOT_ACTIVE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"WALLET_NOT_ACTIVE","origin":"BANKING","message":"Wallet is not active"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"WALLET_NOT_ACTIVE","origin":"BANKING","message":"Wallet is not active"}}},"exampleType":"examples"}},"exampleType":"examples"},"28ed7d6a-c8cd-4889-9f24-4e7174318c65":{"description":"`FORBIDDEN_WALLET` — You aren't an organization admin and the wallet isn't shared with you as `OWNER` or `USER`.","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":["FORBIDDEN_WALLET"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"FORBIDDEN_WALLET","origin":"BANKING","message":"You do not have permission to perform this action on this wallet"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"FORBIDDEN_WALLET","origin":"BANKING","message":"You do not have permission to perform this action on this wallet"}}},"exampleType":"examples"}},"exampleType":"examples"},"1d73d29d-5b95-4bb4-ad05-ba5a468273fa":{"description":"`ACCOUNT_NOT_FOUND` — No account with this ID exists in the organization.\n\n`WALLET_NOT_FOUND` — The account has no wallet with this ID in this environment — or, with `walletId` `default`, no main wallet.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ACCOUNT_NOT_FOUND","WALLET_NOT_FOUND"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ACCOUNT_NOT_FOUND","origin":"BANKING","message":"Account not found"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"ACCOUNT_NOT_FOUND","origin":"BANKING","message":"Account not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"a4f7acde-c6f3-4f69-af62-d7a1c3489c7d":{"description":"`BAD_REQUEST` — A path or body field is invalid — for example `value` missing, or in the wrong format for `type`; `fields` lists each one.\n\n`ENTRY_KEY_OWNED_BY_DIFFERENT_PERSON` — Another person or company holds this key.\n\n`ENTRY_KEY_OWNED_BY_DIFFERENT_PARTICIPANT` — The key is registered at another bank or payment institution. Remove it there before registering it here.\n\n`ENTRY_ALREADY_EXISTS` — The key is already registered for this account.\n\n`EXCEEDED_ENTRIES_LIMIT` — The account already holds as many keys as it can.\n\n`KYC_NOT_APPROVED` — The account holder's registration isn't approved yet.\n\n`entry_locked_by_claim` — The key has an open claim (a portability or ownership claim) and can't be registered until it is settled.\n\n`BANKING_PROVIDER_VALIDATION_ERROR` — The bank refused a field of the key; `fields` names it.","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","ENTRY_KEY_OWNED_BY_DIFFERENT_PERSON","ENTRY_KEY_OWNED_BY_DIFFERENT_PARTICIPANT","ENTRY_ALREADY_EXISTS","EXCEEDED_ENTRIES_LIMIT","KYC_NOT_APPROVED","entry_locked_by_claim","BANKING_PROVIDER_VALIDATION_ERROR"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"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":"BANKING","message":"Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.","fields":[{"field":"type","message":"Invalid option: expected one of \"EVP\"|\"CNPJ\"|\"CPF\"|\"EMAIL\"|\"PHONE\"","code":"TYPE_ONE_OF","values":["EVP","CNPJ","CPF","EMAIL","PHONE"]}]},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BAD_REQUEST","origin":"BANKING","message":"Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.","fields":[{"field":"type","message":"Invalid option: expected one of \"EVP\"|\"CNPJ\"|\"CPF\"|\"EMAIL\"|\"PHONE\"","code":"TYPE_ONE_OF","values":["EVP","CNPJ","CPF","EMAIL","PHONE"]}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d1bb739e-bad8-47cc-9215-3760c4d35633":{"description":"`BANKING_PROVIDER_UNAVAILABLE` — The bank answered with a server error. The key may or may not have been registered: retrying a CNPJ, CPF, e-mail or phone is safe (`ENTRY_ALREADY_EXISTS` means it was); retrying an `EVP` registers another random key.\n\n`BANKING_PROVIDER_INTEGRATION_ERROR` — The bank answered with an error this API doesn't recognize. The key may or may not have been registered.","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":["BANKING_PROVIDER_UNAVAILABLE","BANKING_PROVIDER_INTEGRATION_ERROR"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"}}},"exampleType":"examples"}},"exampleType":"examples"},"5273dad8-5c57-4e35-a412-770e23dbab1b":{"description":"`BANKING_PROVIDER_UNAVAILABLE` — The bank's gateway failed. The key may or may not have been registered: retrying a CNPJ, CPF, e-mail or phone is safe (`ENTRY_ALREADY_EXISTS` means it was); retrying an `EVP` registers another random key.","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":["BANKING_PROVIDER_UNAVAILABLE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"}}},"exampleType":"examples"}},"exampleType":"examples"},"298c9c1a-0c24-41d3-bd58-49d1a8acfe98":{"description":"`BANKING_PROVIDER_UNAVAILABLE` — The bank was unavailable. The key may or may not have been registered: retrying a CNPJ, CPF, e-mail or phone is safe (`ENTRY_ALREADY_EXISTS` means it was); retrying an `EVP` registers another random key.","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":["BANKING_PROVIDER_UNAVAILABLE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider temporarily unavailable, please retry"}}},"exampleType":"examples"}},"exampleType":"examples"},"e1c91389-6421-45b4-af4a-751ded8417b2":{"description":"`BANKING_PROVIDER_UNAVAILABLE` — The bank didn't answer in time (its gateway's own timeout says \"Banking provider temporarily unavailable, please retry\"). The key may or may not have been registered: retrying a CNPJ, CPF, e-mail or phone is safe (`ENTRY_ALREADY_EXISTS` means it was); retrying an `EVP` registers another random key.","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":["BANKING_PROVIDER_UNAVAILABLE"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["BANKING"],"description":"Service that produced the error.","isRequired":true,"uniqueKey":"origin","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation. Its wording may change without notice.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["traceId","code","origin","message"],"uniqueKey":"","typeLabel":"object"},"example":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider did not respond in time, please retry"},"examples":{"Example":{"title":"Example","value":{"traceId":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","code":"BANKING_PROVIDER_UNAVAILABLE","origin":"BANKING","message":"Banking provider did not respond in time, please retry"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{},"servers":{"504b00e5-7d7a-4410-8cf8-61e77110dc43":{"url":"https://api.banking.v2.portao3.com.br/","description":"production"},"602acb2b-75bc-4c7d-a310-ef850a3fc860":{"url":"https://api.banking.dev.3pers.com.br/","description":"development"}}},"originalFileLocation":"api-reference/banking.openapi.json"},"subdomain":"porto3","siteName":"Portão 3","title":"Register a Pix key - Portão 3","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/banking/pix-keys/register-a-pix-key","matchLevel":0},"pt-BR":{"href":"/api-reference/banking/pix-keys/register-a-pix-key","matchLevel":0}}},"lastModified":"2026-11-05T01:29:30.631Z","originalFileLocation":"api-reference/banking/pix-keys/register-a-pix-key.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=\"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\">\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=\"Register a Pix key - Portão 3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Portão 3\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://porto3.mintlify.app/_mintlify/api/og/v2?division=Pix+Keys\u0026amp;title=Register+a+Pix+key\u0026amp;description=Registers+a+Pix+key+on+the+wallet%2C+so+that+payers+can+send+Pix+to+it+without+its+bank+details.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=c915d72eca01862e386e13abfaea3d22e46590d9a3967ac3b55ebc2a982e699b\">\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=\"Register a Pix key - Portão 3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://porto3.mintlify.app/_mintlify/api/og/v2?division=Pix+Keys\u0026amp;title=Register+a+Pix+key\u0026amp;description=Registers+a+Pix+key+on+the+wallet%2C+so+that+payers+can+send+Pix+to+it+without+its+bank+details.\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=c915d72eca01862e386e13abfaea3d22e46590d9a3967ac3b55ebc2a982e699b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#43418E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/banking/pix-keys/register-a-pix-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.portao3.com.br/#organization\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/porto3/3Aj_9owRqGmzn2ph/logo/light.svg?fit=max\u0026auto=format\u0026n=3Aj_9owRqGmzn2ph\u0026q=85\u0026s=9a15f0d9bfb0f9aeefa58cc02e0274c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.portao3.com.br#website\",\"name\":\"Portão 3\",\"url\":\"https://developers.portao3.com.br\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key#webpage\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key\",\"name\":\"Register a Pix key\",\"description\":\"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\",\"dateModified\":\"2026-11-05T01:29:30.631Z\",\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Banking\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/accounts/list-the-realms-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Pix Keys\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/list-the-realms-pix-keys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Register a Pix key\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key#apireference\",\"headline\":\"Register a Pix key\",\"name\":\"Register a Pix key\",\"description\":\"Registers a Pix key on the wallet, so that payers can send Pix to it without its bank details.\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key\",\"mainEntityOfPage\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/pix-keys/register-a-pix-key#webpage\"},\"dateModified\":\"2026-11-05T01:29:30.631Z\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portão 3\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Portão 3","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Pagination","href":"/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","description":"Lists the 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","description":"Sends a confirmation code to the phone number or e-mail address of a key waiting for confirmation (`PENDING_CONFIRMATION`). Then [confirm the key](/api-reference/banking/pix-keys/confirm-a-pix-key) with the code. Request a new code if it didn't arrive or expired. Send no body. If the bank throttles the request, you get a `429`: wait and retry.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","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 Charges","pages":[{"title":"/realms/{realmId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-downloadpdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-boleto-billing"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions"}]},{"group":"Policy Evaluations","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-evaluations","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-evaluations","href":"/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations"}]},{"group":"Policy Requests","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Referência da API","href":"/pt-BR/api-reference/overview"},{"title":"Paginação","href":"/pt-BR/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","description":"Lists the 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","description":"Sends a confirmation code to the phone number or e-mail address of a key waiting for confirmation (`PENDING_CONFIRMATION`). Then [confirm the key](/api-reference/banking/pix-keys/confirm-a-pix-key) with the code. Request a new code if it didn't arrive or expired. Send no body. If the bank throttles the request, you get a `429`: wait and retry.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","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 Charges","pages":[{"title":"/realms/{realmId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf","href":"/api-reference/banking/boleto-charges/realms-organizations-accounts-wallets-boleto-billing-downloadpdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/boleto-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/boleto-billing","href":"/api-reference/banking/boleto-charges/realms-organizations-boleto-billing"}]},{"group":"TED Payments","pages":[{"title":"List the realm's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/ted","href":"/api-reference/banking/ted-payments/list-the-realms-ted-payments"},{"title":"List an organization's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/ted","href":"/api-reference/banking/ted-payments/list-an-organizations-ted-payments"},{"title":"List an account's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted","href":"/api-reference/banking/ted-payments/list-an-accounts-ted-payments"},{"title":"List a wallet's TED payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/list-a-wallets-ted-payments"},{"title":"Create a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted","href":"/api-reference/banking/ted-payments/create-a-ted-payment"},{"title":"Get a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}","href":"/api-reference/banking/ted-payments/get-a-ted-payment"},{"title":"Confirm a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm","href":"/api-reference/banking/ted-payments/confirm-a-ted-payment"},{"title":"Cancel a TED payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel","href":"/api-reference/banking/ted-payments/cancel-a-ted-payment"}]},{"group":"Transactions","pages":[{"title":"List an account's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions","href":"/api-reference/banking/transactions/list-an-accounts-transactions"},{"title":"Get an account's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary","href":"/api-reference/banking/transactions/get-an-accounts-transaction-totals"},{"title":"Chart an account's weekly spending","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions","href":"/api-reference/banking/transactions/chart-an-accounts-weekly-spending"},{"title":"Export an account's transactions by e-mail","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async","href":"/api-reference/banking/transactions/export-an-accounts-transactions-by-e-mail"},{"title":"List a wallet's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions","href":"/api-reference/banking/transactions/list-a-wallets-transactions"},{"title":"Get a wallet's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary","href":"/api-reference/banking/transactions/get-a-wallets-transaction-totals"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/banking/transactions/get-a-transaction"},{"title":"Update a transaction's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions"}]},{"group":"Policy Evaluations","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-evaluations","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-evaluations","href":"/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations"}]},{"group":"Policy Requests","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]}]},"basePath":"","title":"Register a Pix key - Portão 3","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}