{
"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": "details",
"message": "Invalid option: expected one of \"true\"|\"false\"",
"code": "DETAILS_ONE_OF"
}
]
}
Get a transaction
Returns one of the wallet’s transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.
GET
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
accounts
/
{accountId}
/
wallets
/
{walletId}
/
transactions
/
{transactionId}
Get a transaction
curl --request GET \ --url https://api.banking.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}
{
"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": "details",
"message": "Invalid option: expected one of \"true\"|\"false\"",
"code": "DETAILS_ONE_OF"
}
]
}
For a Pix sent, a boleto paid or a card transaction, paymentInfo adds the status and references of the Pix payment, boleto payment or card behind it; with details=true, the whole record instead. Use default as walletId for the organization’s main wallet, and send x-environment: LIVE for production wallets.Organization admins can read every wallet’s transactions; other users only those of the wallets shared with them, in any role.
true to get, in paymentInfo, the whole Pix payment, boleto payment or card behind the transaction instead of its status and external references (or, for a card, its masked number). Defaults to false.
Available options:
true,
false
Response
Successful response
A transaction, with what the payment or card behind it says.
Effect on the balance: DEBIT (money out), CREDIT (money in) or NONE (no effect — a declined or authorization-only card transaction, a failed transfer).
Result code. 0 is success; for a card, a few other codes are approvals too (such as 10, partially approved) and the rest are decline reasons, such as 51 (insufficient funds). Use financialImpactType to know whether money moved.
Operation type: for a card, ISO 8583 codes such as 0 (purchase) or 14 (return); for the others, 12 (credit), 13 (debit), 36 (Pix received), 39 (Pix or boleto paid) or 27 (a refund).
Balance category of the wallet the amount was taken from or added to, such as FLEX_INTERNATIONAL, FLEX_NATIONAL, ADS, TRAVEL, HOTEL, AIRLINES, GAS, FOOD or CASHBACK.
Values of the organization's transaction custom fields, keyed by each field's slug. Absent when the transaction has none. On a few older transactions it is still an array of custom field entries, from before values were keyed by slug.
On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with details=true, that whole Pix payment (as GET .../pix/{pixId} returns it), boleto payment or card. null when that record is gone; absent on any other transaction.
Option 1
Option 2
Option 3
Option 4
Show child attributes
{"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/transactions/get-a-transaction","slug":"/api-reference/banking/transactions/get-a-transaction","pageMetadata":{"title":"Get a transaction","description":"Returns one of the wallet's transactions in full: its details sub-document (`cardTransaction`, `pixTransaction`, `boletoTransaction`, `tedTransaction`, `p2pTransaction` or `feeTransaction`), its custom fields and, once it was submitted for an expense review, its `spendReview`.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one of the wallet’s transactions in full: its details sub-document (\", _jsx(_components.code, {\n children: \"cardTransaction\"\n }), \", \", _jsx(_components.code, {\n children: \"pixTransaction\"\n }), \", \", _jsx(_components.code, {\n children: \"boletoTransaction\"\n }), \", \", _jsx(_components.code, {\n children: \"tedTransaction\"\n }), \", \", _jsx(_components.code, {\n children: \"p2pTransaction\"\n }), \" or \", _jsx(_components.code, {\n children: \"feeTransaction\"\n }), \"), its custom fields and, once it was submitted for an expense review, its \", _jsx(_components.code, {\n children: \"spendReview\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`For a Pix sent, a boleto paid or a card transaction, `,_jsx(_components.code,{children:`paymentInfo`}),` adds the status and references of the Pix payment, boleto payment or card behind it; with `,_jsx(_components.code,{children:`details=true`}),`, the whole record instead. Use `,_jsx(_components.code,{children:`default`}),` as `,_jsx(_components.code,{children:`walletId`}),` for the organization’s main wallet, and send `,_jsx(_components.code,{children:`x-environment: LIVE`}),` for production wallets.`]}),`\n`,_jsx(_components.p,{children:`Organization admins can read every wallet’s transactions; other users only those of the wallets shared with them, in any role.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a transaction","description":"Returns one of the wallet's transactions in full: its details sub-document (`cardTransaction`, `pixTransaction`, `boletoTransaction`, `tedTransaction`, `p2pTransaction` or `feeTransaction`), its custom fields and, once it was submitted for an expense review, its `spendReview`.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionId","summary":"Get a transaction","tags":["Transactions"],"x-p3-sidebar-order":7,"description":"Returns one of the wallet's transactions in full: its details sub-document (`cardTransaction`, `pixTransaction`, `boletoTransaction`, `tedTransaction`, `p2pTransaction` or `feeTransaction`), its custom fields and, once it was submitted for an expense review, its `spendReview`.","x-mint":{"content":"For a Pix sent, a boleto paid or a card transaction, `paymentInfo` adds the status and references of the Pix payment, boleto payment or card behind it; with `details=true`, the whole record instead. Use `default` as `walletId` for the organization's main wallet, and send `x-environment: LIVE` for production wallets.\n\nOrganization admins can read every wallet's transactions; other users only those of the wallets shared with them, in any role."},"parameters":["1c4963e5-4556-433b-b358-e064ddbe45fc","9fa599a7-4bdb-4bd9-bcd0-681564e54088","7de95625-53cc-473e-ad55-8c324038ec13","8b633b0f-91df-46c2-aae9-fee05a2337fe","2675e8f9-1b3b-4b1e-af68-22574a6a8fdd","ee4fc034-cac2-4062-9cbb-155377aeb00e","2208c8f4-c4d5-46b3-8fee-9efb37534a27"],"responses":{"200":"e59dbb79-4d72-4e2a-b2d0-772385663bb8","403":"f497919d-4408-4852-929d-d8b5e6212448","404":"18f6b23a-6a7f-4e86-a82f-a2730f0201af","422":"e3e66a50-06a7-4fc6-8a2f-5567ec2ad4ba"},"x-p3-confidence":{"response":"generated:typed","parameters":"generated:typed"},"method":"get","type":"path","servers":["504b00e5-7d7a-4410-8cf8-61e77110dc43","602acb2b-75bc-4c7d-a310-ef850a3fc860"],"security":[],"path":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}","baseUrlOptions":["https://api.banking.v2.portao3.com.br/","https://api.banking.dev.3pers.com.br/"],"title":"Get a transaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1c4963e5-4556-433b-b358-e064ddbe45fc":{"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"},"9fa599a7-4bdb-4bd9-bcd0-681564e54088":{"name":"organizationId","in":"path","required":true,"description":"ID of the organization the wallet belongs to.\n\nFormat: `UUID`","schema":{"type":"string","format":"uuid","isRequired":true,"description":"ID of the organization the wallet belongs to.\n\nFormat: `UUID`","uniqueKey":"","typeLabel":"string\u003cuuid>"},"example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410"},"7de95625-53cc-473e-ad55-8c324038ec13":{"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"},"8b633b0f-91df-46c2-aae9-fee05a2337fe":{"name":"walletId","in":"path","required":true,"description":"ID of the wallet (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 (24 hexadecimal characters), or `default` for the organization's main wallet.","uniqueKey":"","typeLabel":"string"},"example":"66f2a3d1b4d3e80012c9a0d2"},"2675e8f9-1b3b-4b1e-af68-22574a6a8fdd":{"name":"transactionId","in":"path","required":true,"description":"ID of the transaction (24 hexadecimal characters).","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"ID of the transaction (24 hexadecimal characters).","uniqueKey":"","typeLabel":"string"},"example":"66f2a7e9b4d3e80012c9a112"},"ee4fc034-cac2-4062-9cbb-155377aeb00e":{"name":"x-environment","in":"header","required":false,"description":"Environment of the wallet: `LIVE` (production) or `TEST` (sandbox). When you omit it, the request runs in `TEST`; 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, the request runs in `TEST`; any other value is rejected.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"LIVE"},"2208c8f4-c4d5-46b3-8fee-9efb37534a27":{"name":"details","in":"query","required":false,"description":"`true` to get, in `paymentInfo`, the whole Pix payment, boleto payment or card behind the transaction instead of its status and external references (or, for a card, its masked number). Defaults to `false`.","schema":{"type":"string","enum":["true","false"],"isRequired":false,"description":"`true` to get, in `paymentInfo`, the whole Pix payment, boleto payment or card behind the transaction instead of its status and external references (or, for a card, its masked number). Defaults to `false`.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"false"}},"responses":{"e59dbb79-4d72-4e2a-b2d0-772385663bb8":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the transaction.","example":"6710c9a2b4d3e80012c9a1e4","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"environment":{"type":"string","enum":["LIVE","TEST"],"description":"Environment of the transaction: `LIVE` (production) or `TEST` (sandbox).","example":"LIVE","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"realmId":{"type":"string","description":"ID of the realm.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","format":"uuid","isRequired":true,"uniqueKey":"realmId","typeLabel":"string\u003cuuid>"},"organizationId":{"type":"string","description":"ID of the organization.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","format":"uuid","isRequired":true,"uniqueKey":"organizationId","typeLabel":"string\u003cuuid>"},"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.","example":"66f2a3d1b4d3e80012c9a0d2","isRequired":true,"uniqueKey":"walletId","typeLabel":"string"},"availableBalanceBefore":{"oneOf":[{"type":"number","description":"Balance of that category before the transaction, in cents (BRL). Can be `null`.","example":1250000,"isRequired":true,"uniqueKey":"availableBalanceBefore.oneOf.0","typeLabel":"number"},{"type":"null","description":"Balance of that category before the transaction, in cents (BRL). Can be `null`.","example":1250000,"isRequired":true,"uniqueKey":"availableBalanceBefore.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"availableBalanceBefore","typeLabel":"number | null"},"financialImpactType":{"type":"string","enum":["DEBIT","CREDIT","NONE"],"description":"Effect on the balance: `DEBIT` (money out), `CREDIT` (money in) or `NONE` (no effect — a declined or authorization-only card transaction, a failed transfer).","example":"CREDIT","isRequired":true,"uniqueKey":"financialImpactType","typeLabel":"enum\u003cstring>"},"responseCode":{"type":"number","description":"Result code. `0` is success; for a card, a few other codes are approvals too (such as `10`, partially approved) and the rest are decline reasons, such as `51` (insufficient funds). Use `financialImpactType` to know whether money moved.","example":0,"isRequired":true,"uniqueKey":"responseCode","typeLabel":"number"},"msgType":{"type":"number","description":"Kind of message: `1100` (card authorization), `1120` (card settlement or credit), `1400` (card refund), `1420` (card reversal), `1600` (Pix or boleto), `1220` (transfer between wallets, or TED), `1722` (charge), `8900` / `8901` / `8902` (fee).","example":1600,"isRequired":true,"uniqueKey":"msgType","typeLabel":"number"},"txnType":{"type":"number","description":"Operation type: for a card, ISO 8583 codes such as `0` (purchase) or `14` (return); for the others, `12` (credit), `13` (debit), `36` (Pix received), `39` (Pix or boleto paid) or `27` (a refund).","example":36,"isRequired":true,"uniqueKey":"txnType","typeLabel":"number"},"effectiveAt":{"type":"string","description":"When the transaction happened. Lists are ordered by it, and the period filters apply to it.","example":"2026-10-17T13:42:58.000Z","format":"date-time","isRequired":true,"uniqueKey":"effectiveAt","typeLabel":"string\u003cdate-time>"},"billingAmount":{"type":"number","description":"Amount charged to or credited on the wallet, in cents (BRL).","example":15000,"isRequired":true,"uniqueKey":"billingAmount","typeLabel":"number"},"billingAmountAuthorized":{"type":"number","description":"Amount authorized, in cents (BRL). The totals add this one up.","example":15000,"isRequired":true,"uniqueKey":"billingAmountAuthorized","typeLabel":"number"},"createdAt":{"type":"string","description":"When the record was created.","example":"2026-10-17T13:43:01.000Z","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"When the record last changed.","example":"2026-10-17T13:43:01.000Z","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"cardId":{"type":"string","description":"ID of the card, on a card transaction or a fee charged on a card.","example":"66f2a4b8b4d3e80012c9a0e1","uniqueKey":"cardId","typeLabel":"string"},"balanceCategory":{"type":"string","description":"Balance category of the wallet the amount was taken from or added to, such as `FLEX_INTERNATIONAL`, `FLEX_NATIONAL`, `ADS`, `TRAVEL`, `HOTEL`, `AIRLINES`, `GAS`, `FOOD` or `CASHBACK`.","example":"FLEX_INTERNATIONAL","uniqueKey":"balanceCategory","typeLabel":"string"},"billingCurrency":{"type":"string","description":"Currency of the billed amounts, as an ISO 4217 numeric code: `986` (Brazilian real). Absent on a few boleto transactions.","example":"986","uniqueKey":"billingCurrency","typeLabel":"string"},"cardTransaction":{"type":"object","properties":{"localTime":{"type":"string","description":"Date and time of the purchase.","example":"2026-11-02T15:20:31.000Z","format":"date-time","isRequired":true,"uniqueKey":"cardTransaction.localTime","typeLabel":"string\u003cdate-time>"},"txnCurrency":{"type":"string","description":"Currency of the purchase, as an ISO 4217 numeric code (`986` is the Brazilian real).","example":"986","isRequired":true,"uniqueKey":"cardTransaction.txnCurrency","typeLabel":"string"},"txnAmount":{"type":"number","description":"Amount of the purchase, in cents of `txnCurrency`.","example":18990,"isRequired":true,"uniqueKey":"cardTransaction.txnAmount","typeLabel":"number"},"txnAmountAuthorized":{"type":"number","description":"Amount authorized, in cents of `txnCurrency`.","example":18990,"isRequired":true,"uniqueKey":"cardTransaction.txnAmountAuthorized","typeLabel":"number"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"cardTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions: the settlement, a refund, a reversal.","isRequired":true,"uniqueKey":"cardTransaction.linkedTransactions","typeLabel":"object[]"},"_id":{"type":"string","description":"ID of the details record. Absent on some older transactions.","example":"66f2a7e9b4d3e80012c9a115","uniqueKey":"cardTransaction._id","typeLabel":"string"},"acquiringCountryCode":{"oneOf":[{"type":"string","description":"Country of the merchant's acquirer, as an ISO 3166 numeric code. Can be `null`.","example":"076","uniqueKey":"cardTransaction.acquiringCountryCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country of the merchant's acquirer, as an ISO 3166 numeric code. Can be `null`.","example":"076","uniqueKey":"cardTransaction.acquiringCountryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.acquiringCountryCode","typeLabel":"string | null"},"acquiringId":{"oneOf":[{"type":"string","description":"Identifier of the merchant's acquirer. Can be `null`.","example":"012345","uniqueKey":"cardTransaction.acquiringId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of the merchant's acquirer. Can be `null`.","example":"012345","uniqueKey":"cardTransaction.acquiringId.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.acquiringId","typeLabel":"string | null"},"mcc":{"oneOf":[{"type":"string","description":"Merchant category code (MCC) of the merchant. Can be `null`.","example":"5943","uniqueKey":"cardTransaction.mcc.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant category code (MCC) of the merchant. Can be `null`.","example":"5943","uniqueKey":"cardTransaction.mcc.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.mcc","typeLabel":"string | null"},"merchantCity":{"oneOf":[{"type":"string","description":"City of the merchant. Can be `null`.","example":"SAO PAULO","uniqueKey":"cardTransaction.merchantCity.oneOf.0","typeLabel":"string"},{"type":"null","description":"City of the merchant. Can be `null`.","example":"SAO PAULO","uniqueKey":"cardTransaction.merchantCity.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.merchantCity","typeLabel":"string | null"},"merchantCountry":{"oneOf":[{"type":"string","description":"Country of the merchant, as an ISO 3166 alpha-3 code. Can be `null`.","example":"BRA","uniqueKey":"cardTransaction.merchantCountry.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country of the merchant, as an ISO 3166 alpha-3 code. Can be `null`.","example":"BRA","uniqueKey":"cardTransaction.merchantCountry.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.merchantCountry","typeLabel":"string | null"},"merchantId":{"oneOf":[{"type":"string","description":"Identifier of the merchant. Can be `null`.","example":"000000000473921","uniqueKey":"cardTransaction.merchantId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Identifier of the merchant. Can be `null`.","example":"000000000473921","uniqueKey":"cardTransaction.merchantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.merchantId","typeLabel":"string | null"},"merchantName":{"oneOf":[{"type":"string","description":"Name of the merchant. Can be `null`.","example":"PAPELARIA CENTRAL","uniqueKey":"cardTransaction.merchantName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the merchant. Can be `null`.","example":"PAPELARIA CENTRAL","uniqueKey":"cardTransaction.merchantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.merchantName","typeLabel":"string | null"},"expired":{"type":"boolean","description":"Whether the authorization expired without being settled. Absent on older transactions.","example":false,"uniqueKey":"cardTransaction.expired","typeLabel":"boolean"},"cleared":{"type":"boolean","description":"Whether the purchase has been settled. Absent on older transactions.","example":true,"uniqueKey":"cardTransaction.cleared","typeLabel":"boolean"},"overcleared":{"type":"boolean","description":"Whether it was settled for more than was authorized. Absent on older transactions.","example":false,"uniqueKey":"cardTransaction.overcleared","typeLabel":"boolean"},"reversed":{"type":"boolean","description":"Whether the authorization was reversed. Absent on older transactions.","example":false,"uniqueKey":"cardTransaction.reversed","typeLabel":"boolean"},"posEntryMode":{"oneOf":[{"type":"string","description":"How the card was used, such as `E-Commerce` or `Contactless`. Can be `null`.","example":"E-Commerce","uniqueKey":"cardTransaction.posEntryMode.oneOf.0","typeLabel":"string"},{"type":"null","description":"How the card was used, such as `E-Commerce` or `Contactless`. Can be `null`.","example":"E-Commerce","uniqueKey":"cardTransaction.posEntryMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.posEntryMode","typeLabel":"string | null"},"recurring":{"oneOf":[{"type":"boolean","description":"Whether the merchant flagged the purchase as recurring. Absent or `null` when unknown.","example":false,"uniqueKey":"cardTransaction.recurring.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the merchant flagged the purchase as recurring. Absent or `null` when unknown.","example":false,"uniqueKey":"cardTransaction.recurring.oneOf.1","typeLabel":"null"}],"uniqueKey":"cardTransaction.recurring","typeLabel":"boolean | null"},"mobileWalletProvider":{"type":"number","description":"Device wallet the card was used through: `103` (Apple Pay), `216` (Google Pay), `217` (Samsung Pay) or `327` (a card stored by a merchant). Absent when the card was used directly, and on transactions before August 2026.","example":103,"uniqueKey":"cardTransaction.mobileWalletProvider","typeLabel":"number"}},"required":["localTime","txnCurrency","txnAmount","txnAmountAuthorized","linkedTransactions"],"description":"Details of a card purchase, its settlement or refund.","uniqueKey":"cardTransaction","typeLabel":"object"},"pixTransaction":{"type":"object","properties":{"creditParty":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or company.","example":"Papelaria Central Ltda","isRequired":true,"uniqueKey":"pixTransaction.creditParty.name","typeLabel":"string"},"document":{"type":"string","description":"CPF or CNPJ of the person or company, digits only — partially masked when the payer's bank sends it so.","example":"12345678000190","isRequired":true,"uniqueKey":"pixTransaction.creditParty.document","typeLabel":"string"},"_id":{"type":"string","description":"ID of the record. Absent on received Pix.","example":"6710c9a2b4d3e80012c9a1e5","uniqueKey":"pixTransaction.creditParty._id","typeLabel":"string"},"key":{"oneOf":[{"type":"string","description":"Pix key used, when the Pix went to a key. Can be `null`.","example":"financeiro@papelariacentral.com.br","uniqueKey":"pixTransaction.creditParty.key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pix key used, when the Pix went to a key. Can be `null`.","example":"financeiro@papelariacentral.com.br","uniqueKey":"pixTransaction.creditParty.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.creditParty.key","typeLabel":"string | null"},"bankIspb":{"type":"string","description":"ISPB code of the bank (8 digits).","example":"60701190","uniqueKey":"pixTransaction.creditParty.bankIspb","typeLabel":"string"},"branch":{"type":"string","description":"Bank branch, digits only.","example":"0001","uniqueKey":"pixTransaction.creditParty.branch","typeLabel":"string"},"accountNumber":{"type":"string","description":"Account number, digits only.","example":"123456","uniqueKey":"pixTransaction.creditParty.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"Type of the account: `CACC` (checking), `SVGS` (savings), `TRAN` (payment account) or `SLRY` (salary).","example":"CACC","uniqueKey":"pixTransaction.creditParty.accountType","typeLabel":"string"},"street":{"oneOf":[{"type":"string","description":"Street of the address. `null` when present — no address is recorded.","example":null,"uniqueKey":"pixTransaction.creditParty.street.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street of the address. `null` when present — no address is recorded.","example":null,"uniqueKey":"pixTransaction.creditParty.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.creditParty.street","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.creditParty.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.creditParty.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","description":"Postal code of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.creditParty.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.creditParty.postalCode","typeLabel":"string | null"}},"required":["name","document"],"description":"Who received the money.","isRequired":true,"uniqueKey":"pixTransaction.creditParty","typeLabel":"object"},"debitParty":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person or company.","example":"Papelaria Central Ltda","isRequired":true,"uniqueKey":"pixTransaction.debitParty.name","typeLabel":"string"},"document":{"type":"string","description":"CPF or CNPJ of the person or company, digits only — partially masked when the payer's bank sends it so.","example":"12345678000190","isRequired":true,"uniqueKey":"pixTransaction.debitParty.document","typeLabel":"string"},"_id":{"type":"string","description":"ID of the record. Absent on received Pix.","example":"6710c9a2b4d3e80012c9a1e5","uniqueKey":"pixTransaction.debitParty._id","typeLabel":"string"},"key":{"oneOf":[{"type":"string","description":"Pix key used, when the Pix went to a key. Can be `null`.","example":"financeiro@papelariacentral.com.br","uniqueKey":"pixTransaction.debitParty.key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Pix key used, when the Pix went to a key. Can be `null`.","example":"financeiro@papelariacentral.com.br","uniqueKey":"pixTransaction.debitParty.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.debitParty.key","typeLabel":"string | null"},"bankIspb":{"type":"string","description":"ISPB code of the bank (8 digits).","example":"60701190","uniqueKey":"pixTransaction.debitParty.bankIspb","typeLabel":"string"},"branch":{"type":"string","description":"Bank branch, digits only.","example":"0001","uniqueKey":"pixTransaction.debitParty.branch","typeLabel":"string"},"accountNumber":{"type":"string","description":"Account number, digits only.","example":"123456","uniqueKey":"pixTransaction.debitParty.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"Type of the account: `CACC` (checking), `SVGS` (savings), `TRAN` (payment account) or `SLRY` (salary).","example":"CACC","uniqueKey":"pixTransaction.debitParty.accountType","typeLabel":"string"},"street":{"oneOf":[{"type":"string","description":"Street of the address. `null` when present — no address is recorded.","example":null,"uniqueKey":"pixTransaction.debitParty.street.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street of the address. `null` when present — no address is recorded.","example":null,"uniqueKey":"pixTransaction.debitParty.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.debitParty.street","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.debitParty.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.debitParty.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","description":"Postal code of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Postal code of the address. `null` when present.","example":null,"uniqueKey":"pixTransaction.debitParty.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.debitParty.postalCode","typeLabel":"string | null"}},"required":["name","document"],"description":"Who paid.","isRequired":true,"uniqueKey":"pixTransaction.debitParty","typeLabel":"object"},"receipt":{"type":"object","properties":{"endToEndId":{"type":"string","description":"End-to-end ID of the Pix (32 characters) — the identifier both banks know it by.","example":"E60701190202611031520s0a1b2c3d4e","isRequired":true,"uniqueKey":"pixTransaction.receipt.endToEndId","typeLabel":"string"}},"required":["endToEndId"],"description":"The Pix's identifier in the Pix network.","isRequired":true,"uniqueKey":"pixTransaction.receipt","typeLabel":"object"},"txnCurrency":{"type":"string","description":"Currency, as an ISO 4217 numeric code: always `986` (Brazilian real).","example":"986","isRequired":true,"uniqueKey":"pixTransaction.txnCurrency","typeLabel":"string"},"txnOriginalAmount":{"type":"number","description":"Original amount of the charge, in cents.","example":15000,"isRequired":true,"uniqueKey":"pixTransaction.txnOriginalAmount","typeLabel":"number"},"txnDiscountAmount":{"type":"number","description":"Discount applied, in cents.","example":0,"isRequired":true,"uniqueKey":"pixTransaction.txnDiscountAmount","typeLabel":"number"},"txnFineAmount":{"type":"number","description":"Fine charged, in cents.","example":0,"isRequired":true,"uniqueKey":"pixTransaction.txnFineAmount","typeLabel":"number"},"txnInterestAmount":{"type":"number","description":"Interest charged, in cents.","example":0,"isRequired":true,"uniqueKey":"pixTransaction.txnInterestAmount","typeLabel":"number"},"txnPurchaseAmount":{"type":"number","description":"Purchase part of a Pix with change (Pix Troco), in cents. `0` otherwise.","example":0,"isRequired":true,"uniqueKey":"pixTransaction.txnPurchaseAmount","typeLabel":"number"},"txnWithdrawalAmount":{"type":"number","description":"Cash part of a Pix withdrawal or Pix with change, in cents. `0` otherwise.","example":0,"isRequired":true,"uniqueKey":"pixTransaction.txnWithdrawalAmount","typeLabel":"number"},"txnUpdatedAmount":{"type":"number","description":"Amount after discount, fine and interest, in cents.","example":15000,"isRequired":true,"uniqueKey":"pixTransaction.txnUpdatedAmount","typeLabel":"number"},"txnUpdatedAmountAuthorized":{"type":"number","description":"Amount authorized, in cents.","example":15000,"isRequired":true,"uniqueKey":"pixTransaction.txnUpdatedAmountAuthorized","typeLabel":"number"},"initiationType":{"type":"string","description":"How the Pix was started: `DICT` (to a Pix key), `MANUAL` (to bank details), `STATIC_QRCODE`, `DYNAMIC_QRCODE`, `AUTOMATIC_PIX` (a Pix Automático charge) or `REVERSAL` (a refund of an earlier Pix).","example":"DICT","isRequired":true,"uniqueKey":"pixTransaction.initiationType","typeLabel":"string"},"_id":{"type":"string","description":"ID of the details record. Present on Pix sent only.","example":"6710c9a2b4d3e80012c9a1e7","uniqueKey":"pixTransaction._id","typeLabel":"string"},"internalPixId":{"type":"string","description":"ID of the Pix payment behind a Pix SENT — use it with the Pix payment routes. Absent on a Pix received.","example":"6710c8f1b4d3e80012c9a1d0","uniqueKey":"pixTransaction.internalPixId","typeLabel":"string"},"internalPixBillingId":{"type":"string","description":"ID of a Pix charge of the organization. Not set on current transactions.","example":"6710c8f1b4d3e80012c9a1d1","uniqueKey":"pixTransaction.internalPixBillingId","typeLabel":"string"},"payer":{"type":"object","properties":{"document":{"type":"string","description":"CPF or CNPJ of the payer.","example":"12345678909","uniqueKey":"pixTransaction.payer.document","typeLabel":"string"},"name":{"type":"string","description":"Name of the payer.","example":"Mariana Costa","uniqueKey":"pixTransaction.payer.name","typeLabel":"string"}},"description":"Who paid a QR code charge, when the charge recorded it. Rare.","uniqueKey":"pixTransaction.payer","typeLabel":"object"},"withdrawal":{"type":"object","properties":{"agentType":{"oneOf":[{"type":"string","description":"Who provides the cash, for a Pix withdrawal. `null` on a Pix that isn't one.","example":null,"uniqueKey":"pixTransaction.withdrawal.agentType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Who provides the cash, for a Pix withdrawal. `null` on a Pix that isn't one.","example":null,"uniqueKey":"pixTransaction.withdrawal.agentType.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.withdrawal.agentType","typeLabel":"string | null"},"serviceProvider":{"oneOf":[{"type":"string","description":"ISPB of the cash provider, for a Pix withdrawal. `null` on a Pix that isn't one.","example":null,"uniqueKey":"pixTransaction.withdrawal.serviceProvider.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISPB of the cash provider, for a Pix withdrawal. `null` on a Pix that isn't one.","example":null,"uniqueKey":"pixTransaction.withdrawal.serviceProvider.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.withdrawal.serviceProvider","typeLabel":"string | null"}},"description":"Withdrawal details, on a QR code Pix.","uniqueKey":"pixTransaction.withdrawal","typeLabel":"object"},"description":{"oneOf":[{"type":"string","description":"Message the payer attached to the Pix. Can be `null`.","example":"Pedido 1234","uniqueKey":"pixTransaction.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Message the payer attached to the Pix. Can be `null`.","example":"Pedido 1234","uniqueKey":"pixTransaction.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.description","typeLabel":"string | null"},"dueDate":{"oneOf":[{"type":"string","description":"Due date of a QR code charge with one. Can be `null`.","example":null,"format":"date-time","uniqueKey":"pixTransaction.dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Due date of a QR code charge with one. Can be `null`.","example":null,"format":"date-time","uniqueKey":"pixTransaction.dueDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.dueDate","typeLabel":"string\u003cdate-time> | null"},"expiresAt":{"oneOf":[{"type":"string","description":"When the QR code stops accepting payment. Can be `null`.","example":null,"format":"date-time","uniqueKey":"pixTransaction.expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the QR code stops accepting payment. Can be `null`.","example":null,"format":"date-time","uniqueKey":"pixTransaction.expiresAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"pixTransaction.expiresAt","typeLabel":"string\u003cdate-time> | null"},"qrCodeType":{"type":"string","description":"Kind of QR code paid: `STATIC`, `COB` (an immediate charge) or `COBV` (a charge with a due date). Absent when no QR code was used.","example":"COB","uniqueKey":"pixTransaction.qrCodeType","typeLabel":"string"},"pixCopyPaste":{"type":"string","description":"The Pix copy-and-paste code of the QR code paid.","example":"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913PAPELARIA6009SAO PAULO62070503***63041D3D","uniqueKey":"pixTransaction.pixCopyPaste","typeLabel":"string"},"qrQrCodeActive":{"type":"boolean","description":"Whether the QR code was still active.","example":true,"uniqueKey":"pixTransaction.qrQrCodeActive","typeLabel":"boolean"},"errorDescription":{"type":"string","description":"Why a Pix that failed was refused.","example":"Saldo insuficiente","uniqueKey":"pixTransaction.errorDescription","typeLabel":"string"},"cleared":{"type":"boolean","description":"Whether the Pix is settled.","example":true,"uniqueKey":"pixTransaction.cleared","typeLabel":"boolean"},"additionalInfo":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Name of the information.","example":"Pedido","isRequired":true,"uniqueKey":"pixTransaction.additionalInfo.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"Value of the information.","example":"1234","isRequired":true,"uniqueKey":"pixTransaction.additionalInfo.items.[INDEX].value","typeLabel":"string"},"_id":{"type":"string","description":"ID of the record.","example":"6710c9a2b4d3e80012c9a1e6","uniqueKey":"pixTransaction.additionalInfo.items.[INDEX]._id","typeLabel":"string"}},"required":["key","value"],"description":"A key / value pair the recipient's QR code attached to the Pix.","uniqueKey":"pixTransaction.additionalInfo.items.[INDEX]","typeLabel":"object"},"description":"Key / value pairs the recipient's QR code attached. Pix sent only.","uniqueKey":"pixTransaction.additionalInfo","typeLabel":"object[]"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"pixTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions. Pix sent only.","uniqueKey":"pixTransaction.linkedTransactions","typeLabel":"object[]"}},"required":["creditParty","debitParty","receipt","txnCurrency","txnOriginalAmount","txnDiscountAmount","txnFineAmount","txnInterestAmount","txnPurchaseAmount","txnWithdrawalAmount","txnUpdatedAmount","txnUpdatedAmountAuthorized","initiationType"],"description":"Details of a Pix sent or received.","uniqueKey":"pixTransaction","typeLabel":"object"},"boletoTransaction":{"type":"object","properties":{"internalBoletoId":{"type":"string","description":"ID of the boleto payment behind a boleto PAID — use it with the boleto payment routes.","example":"6718b0c4b4d3e80012c9a2a7","isRequired":true,"uniqueKey":"boletoTransaction.internalBoletoId","typeLabel":"string"},"barcode":{"type":"string","description":"The boleto's barcode (44 digits) or digitable line (47 or 48 digits).","example":"34191790010104351004791020150008291070026000","isRequired":true,"uniqueKey":"boletoTransaction.barcode","typeLabel":"string"},"txnCurrency":{"type":"string","description":"Currency, as an ISO 4217 numeric code: always `986` (Brazilian real).","example":"986","isRequired":true,"uniqueKey":"boletoTransaction.txnCurrency","typeLabel":"string"},"txnOriginalAmount":{"type":"number","description":"Amount on the boleto, in cents.","example":26000,"isRequired":true,"uniqueKey":"boletoTransaction.txnOriginalAmount","typeLabel":"number"},"txnDiscountAmount":{"type":"number","description":"Discount, in cents.","example":0,"isRequired":true,"uniqueKey":"boletoTransaction.txnDiscountAmount","typeLabel":"number"},"txnFineAmount":{"type":"number","description":"Fine, in cents.","example":0,"isRequired":true,"uniqueKey":"boletoTransaction.txnFineAmount","typeLabel":"number"},"txnInterestAmount":{"type":"number","description":"Interest, in cents.","example":0,"isRequired":true,"uniqueKey":"boletoTransaction.txnInterestAmount","typeLabel":"number"},"txnUpdatedAmount":{"type":"number","description":"Amount due after discount, fine and interest, in cents.","example":26000,"isRequired":true,"uniqueKey":"boletoTransaction.txnUpdatedAmount","typeLabel":"number"},"txnUpdatedAmountAuthorized":{"type":"number","description":"Amount authorized, in cents.","example":26000,"isRequired":true,"uniqueKey":"boletoTransaction.txnUpdatedAmountAuthorized","typeLabel":"number"},"txnMaxAmount":{"type":"number","description":"Most the boleto accepts, in cents.","example":26000,"isRequired":true,"uniqueKey":"boletoTransaction.txnMaxAmount","typeLabel":"number"},"txnMinAmount":{"type":"number","description":"Least the boleto accepts, in cents.","example":26000,"isRequired":true,"uniqueKey":"boletoTransaction.txnMinAmount","typeLabel":"number"},"issuer":{"type":"string","description":"Bank that issued the boleto.","example":"Banco Itaú","isRequired":true,"uniqueKey":"boletoTransaction.issuer","typeLabel":"string"},"type":{"type":"string","description":"`GENERIC` (a bank boleto) or `UTILITY_BILL` (a utility or tax bill).","example":"GENERIC","isRequired":true,"uniqueKey":"boletoTransaction.type","typeLabel":"string"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"boletoTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions.","isRequired":true,"uniqueKey":"boletoTransaction.linkedTransactions","typeLabel":"object[]"},"_id":{"type":"string","description":"ID of the details record. Absent on some older transactions.","example":"6718b0c4b4d3e80012c9a2a8","uniqueKey":"boletoTransaction._id","typeLabel":"string"},"receipt":{"type":"object","properties":{"authentication":{"oneOf":[{"type":"string","description":"Bank authentication of the payment. Can be `null`.","example":null,"uniqueKey":"boletoTransaction.receipt.authentication.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bank authentication of the payment. Can be `null`.","example":null,"uniqueKey":"boletoTransaction.receipt.authentication.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.receipt.authentication","typeLabel":"string | null"},"authenticationApi":{"type":"string","description":"Authentication code of the payment.","example":"A1B2C3D4E5F60718293A4B5C6D7E8F90","uniqueKey":"boletoTransaction.receipt.authenticationApi","typeLabel":"string"},"receipt":{"oneOf":[{"type":"string","description":"Payment receipt. Can be `null`.","example":null,"uniqueKey":"boletoTransaction.receipt.receipt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Payment receipt. Can be `null`.","example":null,"uniqueKey":"boletoTransaction.receipt.receipt.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.receipt.receipt","typeLabel":"string | null"}},"description":"Authentication of the payment, once paid.","uniqueKey":"boletoTransaction.receipt","typeLabel":"object"},"confirmedAt":{"oneOf":[{"type":"string","description":"When the payment was confirmed. Can be `null`.","example":"2026-10-23T14:02:11.000Z","format":"date-time","uniqueKey":"boletoTransaction.confirmedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When the payment was confirmed. Can be `null`.","example":"2026-10-23T14:02:11.000Z","format":"date-time","uniqueKey":"boletoTransaction.confirmedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.confirmedAt","typeLabel":"string\u003cdate-time> | null"},"dueDate":{"type":"string","description":"Due date of the boleto.","example":"2026-10-25T00:00:00.000Z","format":"date-time","uniqueKey":"boletoTransaction.dueDate","typeLabel":"string\u003cdate-time>"},"finalPaymentAt":{"type":"string","description":"Last day the boleto can be paid.","example":"2026-11-24T00:00:00.000Z","format":"date-time","uniqueKey":"boletoTransaction.finalPaymentAt","typeLabel":"string\u003cdate-time>"},"settleAt":{"type":"string","description":"When the payment settles.","example":"2026-10-23T00:00:00.000Z","format":"date-time","uniqueKey":"boletoTransaction.settleAt","typeLabel":"string\u003cdate-time>"},"payee":{"oneOf":[{"type":"string","description":"Name of the payee (who is paid). Can be `null`.","example":"Papelaria Central Ltda","uniqueKey":"boletoTransaction.payee.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the payee (who is paid). Can be `null`.","example":"Papelaria Central Ltda","uniqueKey":"boletoTransaction.payee.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.payee","typeLabel":"string | null"},"payeeDocument":{"oneOf":[{"type":"string","description":"CPF or CNPJ of the payee. Can be `null`.","example":"12345678000190","uniqueKey":"boletoTransaction.payeeDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"CPF or CNPJ of the payee. Can be `null`.","example":"12345678000190","uniqueKey":"boletoTransaction.payeeDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.payeeDocument","typeLabel":"string | null"},"payer":{"oneOf":[{"type":"string","description":"Name of the payer. Can be `null`.","example":"Acme Comércio Ltda","uniqueKey":"boletoTransaction.payer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the payer. Can be `null`.","example":"Acme Comércio Ltda","uniqueKey":"boletoTransaction.payer.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.payer","typeLabel":"string | null"},"payerDocument":{"oneOf":[{"type":"string","description":"CPF or CNPJ of the payer. Can be `null`.","example":"98765432000110","uniqueKey":"boletoTransaction.payerDocument.oneOf.0","typeLabel":"string"},{"type":"null","description":"CPF or CNPJ of the payer. Can be `null`.","example":"98765432000110","uniqueKey":"boletoTransaction.payerDocument.oneOf.1","typeLabel":"null"}],"uniqueKey":"boletoTransaction.payerDocument","typeLabel":"string | null"}},"required":["internalBoletoId","barcode","txnCurrency","txnOriginalAmount","txnDiscountAmount","txnFineAmount","txnInterestAmount","txnUpdatedAmount","txnUpdatedAmountAuthorized","txnMaxAmount","txnMinAmount","issuer","type","linkedTransactions"],"description":"Details of a boleto paid or received.","uniqueKey":"boletoTransaction","typeLabel":"object"},"tedTransaction":{"type":"object","properties":{"txnCurrency":{"type":"string","description":"Currency, as an ISO 4217 numeric code: always `986` (Brazilian real).","example":"986","isRequired":true,"uniqueKey":"tedTransaction.txnCurrency","typeLabel":"string"},"txnAmount":{"type":"number","description":"Amount, in cents.","example":120000,"isRequired":true,"uniqueKey":"tedTransaction.txnAmount","typeLabel":"number"},"txnAmountAuthorized":{"type":"number","description":"Amount authorized, in cents.","example":120000,"isRequired":true,"uniqueKey":"tedTransaction.txnAmountAuthorized","typeLabel":"number"},"_id":{"type":"string","description":"ID of the details record.","example":"6722a0b1b4d3e80012c9a3c0","uniqueKey":"tedTransaction._id","typeLabel":"string"},"internalTedId":{"type":"string","description":"ID of the TED behind the transaction — use it with the TED routes.","example":"6722a07eb4d3e80012c9a3bf","uniqueKey":"tedTransaction.internalTedId","typeLabel":"string"},"creditParty":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the record.","example":"6722a0b1b4d3e80012c9a3c1","uniqueKey":"tedTransaction.creditParty._id","typeLabel":"string"},"name":{"type":"string","description":"Name of the account holder.","example":"Papelaria Central Ltda","uniqueKey":"tedTransaction.creditParty.name","typeLabel":"string"},"personName":{"type":"string","description":"Name of the person, when the holder is one.","example":"João Silva","uniqueKey":"tedTransaction.creditParty.personName","typeLabel":"string"},"document":{"type":"string","description":"CPF or CNPJ of the account holder, digits only.","example":"12345678000190","uniqueKey":"tedTransaction.creditParty.document","typeLabel":"string"},"bankCode":{"type":"string","description":"Bank code (COMPE, 3 digits).","example":"341","uniqueKey":"tedTransaction.creditParty.bankCode","typeLabel":"string"},"branch":{"type":"string","description":"Bank branch.","example":"0001","uniqueKey":"tedTransaction.creditParty.branch","typeLabel":"string"},"accountNumber":{"type":"string","description":"Account number.","example":"123456","uniqueKey":"tedTransaction.creditParty.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"Type of the account, such as `CACC` (checking).","example":"CACC","uniqueKey":"tedTransaction.creditParty.accountType","typeLabel":"string"}},"description":"Who received the money. Can be an empty object.","uniqueKey":"tedTransaction.creditParty","typeLabel":"object"},"debitParty":{"type":"object","properties":{"_id":{"type":"string","description":"ID of the record.","example":"6722a0b1b4d3e80012c9a3c1","uniqueKey":"tedTransaction.debitParty._id","typeLabel":"string"},"name":{"type":"string","description":"Name of the account holder.","example":"Papelaria Central Ltda","uniqueKey":"tedTransaction.debitParty.name","typeLabel":"string"},"personName":{"type":"string","description":"Name of the person, when the holder is one.","example":"João Silva","uniqueKey":"tedTransaction.debitParty.personName","typeLabel":"string"},"document":{"type":"string","description":"CPF or CNPJ of the account holder, digits only.","example":"12345678000190","uniqueKey":"tedTransaction.debitParty.document","typeLabel":"string"},"bankCode":{"type":"string","description":"Bank code (COMPE, 3 digits).","example":"341","uniqueKey":"tedTransaction.debitParty.bankCode","typeLabel":"string"},"branch":{"type":"string","description":"Bank branch.","example":"0001","uniqueKey":"tedTransaction.debitParty.branch","typeLabel":"string"},"accountNumber":{"type":"string","description":"Account number.","example":"123456","uniqueKey":"tedTransaction.debitParty.accountNumber","typeLabel":"string"},"accountType":{"type":"string","description":"Type of the account, such as `CACC` (checking).","example":"CACC","uniqueKey":"tedTransaction.debitParty.accountType","typeLabel":"string"}},"description":"Who paid.","uniqueKey":"tedTransaction.debitParty","typeLabel":"object"},"description":{"type":"string","description":"Description of the TED.","example":"Pagamento fornecedor","uniqueKey":"tedTransaction.description","typeLabel":"string"},"rolledback":{"type":"object","properties":{"reason":{"type":"string","description":"Reason given for the return.","example":"Conta inexistente","uniqueKey":"tedTransaction.rolledback.reason","typeLabel":"string"},"reasonCode":{"type":"string","description":"Code of the reason.","example":"AC03","uniqueKey":"tedTransaction.rolledback.reasonCode","typeLabel":"string"}},"description":"Why the TED was returned, when it was.","uniqueKey":"tedTransaction.rolledback","typeLabel":"object"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"tedTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions.","uniqueKey":"tedTransaction.linkedTransactions","typeLabel":"object[]"}},"required":["txnCurrency","txnAmount","txnAmountAuthorized"],"description":"Details of a TED sent.","uniqueKey":"tedTransaction","typeLabel":"object"},"p2pTransaction":{"type":"object","properties":{"txnCurrency":{"type":"string","description":"Currency, as an ISO 4217 numeric code: always `986` (Brazilian real).","example":"986","isRequired":true,"uniqueKey":"p2pTransaction.txnCurrency","typeLabel":"string"},"txnAmount":{"type":"number","description":"Amount transferred, in cents.","example":50000,"isRequired":true,"uniqueKey":"p2pTransaction.txnAmount","typeLabel":"number"},"txnAmountAuthorized":{"type":"number","description":"Amount authorized, in cents.","example":50000,"isRequired":true,"uniqueKey":"p2pTransaction.txnAmountAuthorized","typeLabel":"number"},"payeeAccountId":{"type":"string","description":"ID of the account that received the money.","example":"66f2a1c7b4d3e80012c9a0b4","isRequired":true,"uniqueKey":"p2pTransaction.payeeAccountId","typeLabel":"string"},"payerAccountId":{"type":"string","description":"ID of the account the money left.","example":"66f2a1c7b4d3e80012c9a0b4","isRequired":true,"uniqueKey":"p2pTransaction.payerAccountId","typeLabel":"string"},"_id":{"type":"string","description":"ID of the details record. Absent on some older transactions.","example":"6720f1a3b4d3e80012c9a3b2","uniqueKey":"p2pTransaction._id","typeLabel":"string"},"payeeWalletId":{"type":"string","description":"ID of the wallet that received the money.","example":"66f2a3d1b4d3e80012c9a0d3","uniqueKey":"p2pTransaction.payeeWalletId","typeLabel":"string"},"payerWalletId":{"type":"string","description":"ID of the wallet the money left.","example":"66f2a3d1b4d3e80012c9a0d2","uniqueKey":"p2pTransaction.payerWalletId","typeLabel":"string"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"p2pTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions.","uniqueKey":"p2pTransaction.linkedTransactions","typeLabel":"object[]"}},"required":["txnCurrency","txnAmount","txnAmountAuthorized","payeeAccountId","payerAccountId"],"description":"Details of a transfer between wallets at Portão 3.","uniqueKey":"p2pTransaction","typeLabel":"object"},"feeTransaction":{"type":"object","properties":{"txnCurrency":{"type":"string","description":"Currency, as an ISO 4217 numeric code.","example":"986","isRequired":true,"uniqueKey":"feeTransaction.txnCurrency","typeLabel":"string"},"txnAmount":{"type":"number","description":"Amount of the fee, in cents of `txnCurrency`.","example":664,"isRequired":true,"uniqueKey":"feeTransaction.txnAmount","typeLabel":"number"},"txnAmountAuthorized":{"type":"number","description":"Amount authorized, in cents of `txnCurrency`.","example":664,"isRequired":true,"uniqueKey":"feeTransaction.txnAmountAuthorized","typeLabel":"number"},"_id":{"type":"string","description":"ID of the details record. Absent on some older transactions.","example":"66f2a7e9b4d3e80012c9a117","uniqueKey":"feeTransaction._id","typeLabel":"string"},"linkedTransactions":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"string","description":"ID of the related transaction.","example":"66f2a7e9b4d3e80012c9a113","isRequired":true,"uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX].transactionId","typeLabel":"string"},"linkType":{"type":"string","description":"How the two are related, from this transaction's point of view, such as `CLEARING_DEBITED_BY` (a card purchase settled by the other one), `CLEARING_CREDITED_BY` (refunded by it) or `REVERSED_BY` / `EXPIRED_BY` (an authorization reversed or expired by it); `CLEARING_DEBITS`, `CLEARING_CREDITS`, `REVERSES` and `EXPIRES` are the other side.","example":"CLEARING_DEBITED_BY","isRequired":true,"uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX].linkType","typeLabel":"string"},"createdAt":{"type":"string","description":"When the link was created.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"When the link last changed.","example":"2026-11-03T09:12:40.000Z","isRequired":true,"uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX].updatedAt","typeLabel":"string"},"_id":{"type":"string","description":"ID of the link. Absent on some older links.","example":"66f2a7e9b4d3e80012c9a114","uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX]._id","typeLabel":"string"}},"required":["transactionId","linkType","createdAt","updatedAt"],"description":"A link between this transaction and a related one (its settlement, a refund, …).","uniqueKey":"feeTransaction.linkedTransactions.items.[INDEX]","typeLabel":"object"},"description":"Related transactions, such as the purchase the fee was charged on.","uniqueKey":"feeTransaction.linkedTransactions","typeLabel":"object[]"},"description":{"type":"string","description":"Description of the fee.","example":"Tarifa de compra internacional","uniqueKey":"feeTransaction.description","typeLabel":"string"},"external":{"type":"object","properties":{"invoiceId":{"type":"string","description":"ID of the invoice the fee belongs to.","example":"66f2a8a1b4d3e80012c9a120","uniqueKey":"feeTransaction.external.invoiceId","typeLabel":"string"},"dealId":{"type":"string","description":"ID of the deal the fee belongs to.","example":"66f2a8a1b4d3e80012c9a121","uniqueKey":"feeTransaction.external.dealId","typeLabel":"string"},"contractId":{"type":"string","description":"ID of the contract the fee belonged to, on older fees.","example":"66f2a8a1b4d3e80012c9a122","uniqueKey":"feeTransaction.external.contractId","typeLabel":"string"}},"description":"References of the fee to what it was charged for.","uniqueKey":"feeTransaction.external","typeLabel":"object"},"creditParty":{"type":"object","properties":{"type":{"type":"string","description":"`LOCAL` (a wallet at Portão 3) or `REMOTE_PIX` (a Pix key elsewhere).","example":"LOCAL","isRequired":true,"uniqueKey":"feeTransaction.creditParty.type","typeLabel":"string"},"_id":{"type":"string","description":"ID of the party record.","example":"66f2a7e9b4d3e80012c9a118","uniqueKey":"feeTransaction.creditParty._id","typeLabel":"string"},"local":{"type":"object","properties":{"realmId":{"type":"string","description":"ID of the wallet's realm.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","uniqueKey":"feeTransaction.creditParty.local.realmId","typeLabel":"string"},"organizationId":{"type":"string","description":"ID of the wallet's organization.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","uniqueKey":"feeTransaction.creditParty.local.organizationId","typeLabel":"string"},"accountId":{"type":"string","description":"ID of the wallet's account.","example":"66f2a1c7b4d3e80012c9a0b4","uniqueKey":"feeTransaction.creditParty.local.accountId","typeLabel":"string"},"walletId":{"type":"string","description":"ID of the wallet.","example":"66f2a3d1b4d3e80012c9a0d2","uniqueKey":"feeTransaction.creditParty.local.walletId","typeLabel":"string"}},"description":"The wallet, for a `LOCAL` party.","uniqueKey":"feeTransaction.creditParty.local","typeLabel":"object"},"remote":{"type":"object","properties":{"pixKey":{"type":"string","description":"The Pix key.","example":"financeiro@acme.com.br","uniqueKey":"feeTransaction.creditParty.remote.pixKey","typeLabel":"string"},"pixDict":{"type":"string","description":"Type of the Pix key, such as `EMAIL` or `CNPJ`.","example":"EMAIL","uniqueKey":"feeTransaction.creditParty.remote.pixDict","typeLabel":"string"}},"description":"The Pix key, for a `REMOTE_PIX` party.","uniqueKey":"feeTransaction.creditParty.remote","typeLabel":"object"}},"required":["type"],"description":"Where the fee goes.","uniqueKey":"feeTransaction.creditParty","typeLabel":"object"},"debitParty":{"type":"object","properties":{"type":{"type":"string","description":"`LOCAL` (a wallet at Portão 3) or `REMOTE_PIX` (a Pix key elsewhere).","example":"LOCAL","isRequired":true,"uniqueKey":"feeTransaction.debitParty.type","typeLabel":"string"},"_id":{"type":"string","description":"ID of the party record.","example":"66f2a7e9b4d3e80012c9a118","uniqueKey":"feeTransaction.debitParty._id","typeLabel":"string"},"local":{"type":"object","properties":{"realmId":{"type":"string","description":"ID of the wallet's realm.","example":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","uniqueKey":"feeTransaction.debitParty.local.realmId","typeLabel":"string"},"organizationId":{"type":"string","description":"ID of the wallet's organization.","example":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","uniqueKey":"feeTransaction.debitParty.local.organizationId","typeLabel":"string"},"accountId":{"type":"string","description":"ID of the wallet's account.","example":"66f2a1c7b4d3e80012c9a0b4","uniqueKey":"feeTransaction.debitParty.local.accountId","typeLabel":"string"},"walletId":{"type":"string","description":"ID of the wallet.","example":"66f2a3d1b4d3e80012c9a0d2","uniqueKey":"feeTransaction.debitParty.local.walletId","typeLabel":"string"}},"description":"The wallet, for a `LOCAL` party.","uniqueKey":"feeTransaction.debitParty.local","typeLabel":"object"},"remote":{"type":"object","properties":{"pixKey":{"type":"string","description":"The Pix key.","example":"financeiro@acme.com.br","uniqueKey":"feeTransaction.debitParty.remote.pixKey","typeLabel":"string"},"pixDict":{"type":"string","description":"Type of the Pix key, such as `EMAIL` or `CNPJ`.","example":"EMAIL","uniqueKey":"feeTransaction.debitParty.remote.pixDict","typeLabel":"string"}},"description":"The Pix key, for a `REMOTE_PIX` party.","uniqueKey":"feeTransaction.debitParty.remote","typeLabel":"object"}},"required":["type"],"description":"Where the fee is paid from.","uniqueKey":"feeTransaction.debitParty","typeLabel":"object"}},"required":["txnCurrency","txnAmount","txnAmountAuthorized"],"description":"Details of a fee.","uniqueKey":"feeTransaction","typeLabel":"object"},"enrichment":{"type":"object","properties":{"merchant":{"oneOf":[{"type":"string","description":"Recognized merchant brand, such as `AMAZON` or `UBER`. `null` when none is recognized.","example":null,"isRequired":true,"uniqueKey":"enrichment.merchant.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recognized merchant brand, such as `AMAZON` or `UBER`. `null` when none is recognized.","example":null,"isRequired":true,"uniqueKey":"enrichment.merchant.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrichment.merchant","typeLabel":"string | null"},"category":{"oneOf":[{"type":"string","description":"Spending category of the purchase, such as `ADVERTISING_AND_MARKETING`, `AIRLINES_AND_TRAVEL`, `FOOD_AND_DINING`, `OFFICE_SUPPLIES` or `UNCATEGORIZED`. `null` when it couldn't be determined.","example":"OFFICE_SUPPLIES","isRequired":true,"uniqueKey":"enrichment.category.oneOf.0","typeLabel":"string"},{"type":"null","description":"Spending category of the purchase, such as `ADVERTISING_AND_MARKETING`, `AIRLINES_AND_TRAVEL`, `FOOD_AND_DINING`, `OFFICE_SUPPLIES` or `UNCATEGORIZED`. `null` when it couldn't be determined.","example":"OFFICE_SUPPLIES","isRequired":true,"uniqueKey":"enrichment.category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrichment.category","typeLabel":"string | null"},"rulesVersion":{"type":"number","description":"Version of the recognition rules that produced this.","example":3,"isRequired":true,"uniqueKey":"enrichment.rulesVersion","typeLabel":"number"},"_id":{"type":"string","description":"ID of the record. Absent on most transactions.","example":"66f2a7e9b4d3e80012c9a116","uniqueKey":"enrichment._id","typeLabel":"string"}},"required":["merchant","category","rulesVersion"],"description":"Merchant and spending category recognized for a card purchase. Absent on older ones.","uniqueKey":"enrichment","typeLabel":"object"},"customFields":{"oneOf":[{"type":"object","description":"Values of the organization's transaction custom fields, keyed by each field's `slug`. Absent when the transaction has none. On a few older transactions it is still an array of custom field entries, from before values were keyed by slug.\n\n---\n\nExample: `{\"cost-center\":\"CC-1020\"}`","example":{"cost-center":"CC-1020"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"customFields.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"customFields.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"customFields.oneOf.1.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"customFields.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"Values of the organization's transaction custom fields, keyed by each field's `slug`. Absent when the transaction has none. On a few older transactions it is still an array of custom field entries, from before values were keyed by slug.\n\n---\n\nExample: `{\"cost-center\":\"CC-1020\"}`","example":{"cost-center":"CC-1020"},"uniqueKey":"customFields.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"customFields","typeLabel":"object | object[]"},"spendReview":{"type":"object","properties":{"status":{"type":"string","enum":["PENDING_APPROVAL","APPROVED","DECLINED"],"description":"`PENDING_APPROVAL` (waiting for the approvers), `APPROVED` or `DECLINED`.","example":"PENDING_APPROVAL","isRequired":true,"uniqueKey":"spendReview.status","typeLabel":"enum\u003cstring>"},"policyId":{"type":"string","description":"ID of the business policy that governs the review.","example":"3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f","isRequired":true,"uniqueKey":"spendReview.policyId","typeLabel":"string"},"policyRequestId":{"type":"string","description":"ID of the approval request.","example":"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a","isRequired":true,"uniqueKey":"spendReview.policyRequestId","typeLabel":"string"},"requester":{"type":"object","properties":{"userId":{"type":"string","description":"ID of the user.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","isRequired":true,"uniqueKey":"spendReview.requester.userId","typeLabel":"string"},"name":{"type":"string","description":"Name of the user (their e-mail or ID when they have none).","example":"Mariana Costa","isRequired":true,"uniqueKey":"spendReview.requester.name","typeLabel":"string"},"email":{"type":"string","description":"E-mail of the user.","example":"mariana.costa@acme.com.br","isRequired":true,"uniqueKey":"spendReview.requester.email","typeLabel":"string"}},"required":["userId","name","email"],"description":"Who submitted the transaction for review.","isRequired":true,"uniqueKey":"spendReview.requester","typeLabel":"object"},"requestedAt":{"type":"string","description":"When it was submitted.","example":"2026-11-02T18:02:11.000Z","format":"date-time","isRequired":true,"uniqueKey":"spendReview.requestedAt","typeLabel":"string\u003cdate-time>"},"autoApproved":{"type":"boolean","description":"`true` when the policy approved it without an approver.","example":false,"uniqueKey":"spendReview.autoApproved","typeLabel":"boolean"},"approvalExpiresAt":{"type":"string","description":"Deadline for the approvers: a month after it was submitted. A review still pending then ends `DECLINED` with `declineOutcome` `EXPIRED`.","example":"2026-12-02T18:02:11.000Z","format":"date-time","uniqueKey":"spendReview.approvalExpiresAt","typeLabel":"string\u003cdate-time>"},"decidedAt":{"type":"string","description":"When it was approved or declined.","example":"2026-11-03T10:15:00.000Z","format":"date-time","uniqueKey":"spendReview.decidedAt","typeLabel":"string\u003cdate-time>"},"declineOutcome":{"type":"string","enum":["DENIED","CANCELED","EXPIRED"],"description":"Why a `DECLINED` review ended: `DENIED` (an approver refused it), `CANCELED` (the request was cancelled) or `EXPIRED` (nobody decided in time).","example":"DENIED","uniqueKey":"spendReview.declineOutcome","typeLabel":"enum\u003cstring>"},"decisionReason":{"type":"string","description":"The approver's reason, when one was given (up to 500 characters).","example":"Falta o comprovante","uniqueKey":"spendReview.decisionReason","typeLabel":"string"}},"required":["status","policyId","policyRequestId","requester","requestedAt"],"description":"The expense review, once the transaction was submitted for approval.","uniqueKey":"spendReview","typeLabel":"object"},"spendReviewSubmissionLeaseUntil":{"type":"string","description":"Until when a submission for review is being processed. Absent otherwise.","example":"2026-11-02T18:07:11.000Z","format":"date-time","uniqueKey":"spendReviewSubmissionLeaseUntil","typeLabel":"string\u003cdate-time>"},"receipts":{"type":"string","description":"Receipt attached to an older transaction.","example":"https://files.example.com/receipt.pdf","uniqueKey":"receipts","typeLabel":"string"},"external":{"type":"object","properties":{"transactionId":{"type":"string","description":"Identifier of a card transaction at the card issuer.","example":"0F1E2D3C4B5A69788796A5B4C3D2E1F0","uniqueKey":"external.transactionId","typeLabel":"string"},"pixId":{"type":"string","description":"Identifier of the Pix at the bank.","example":"b6c2a1f0-3d4e-4f5a-8b9c-0d1e2f3a4b5c","uniqueKey":"external.pixId","typeLabel":"string"},"paymentId":{"type":"string","description":"Identifier of the payment at the bank.","example":"c7d3b2a1-4e5f-4a6b-9c0d-1e2f3a4b5c6d","uniqueKey":"external.paymentId","typeLabel":"string"},"boletoId":{"type":"string","description":"Identifier of the boleto payment at the bank.","example":"d8e4c3b2-5f6a-4b7c-8d1e-2f3a4b5c6d7e","uniqueKey":"external.boletoId","typeLabel":"string"},"tedId":{"type":"string","description":"Identifier of the TED at the bank.","example":"e9f5d4c3-6a7b-4c8d-9e2f-3a4b5c6d7e8f","uniqueKey":"external.tedId","typeLabel":"string"}},"description":"References of the transaction outside its ledger record. Absent on a transfer between wallets that failed.","uniqueKey":"external","typeLabel":"object"},"processingType":{"type":"string","enum":["INSTANT","DELAYED"],"description":"`INSTANT` (processed as it happened) or `DELAYED` (processed later, such as a payment scheduled for a later day). Absent on a few older transactions.","example":"INSTANT","uniqueKey":"processingType","typeLabel":"enum\u003cstring>"},"internalErrorCode":{"type":"string","description":"Why a transaction that moved no money failed, such as `INSUFFICIENT_FUNDS`, `LIMIT_EXCEEDED` or `REJECTED_BY_ANTIFRAUD_PREVENTION_RULES`.","example":"LIMIT_EXCEEDED","uniqueKey":"internalErrorCode","typeLabel":"string"},"__v":{"type":"number","description":"Version of the record. Absent on a few older ones.","example":0,"uniqueKey":"__v","typeLabel":"number"},"paymentInfo":{"oneOf":[{"type":"object","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["status"],"properties":{"status":{"type":"string","description":"Status of the Pix payment, such as `PAID`, `CONFIRMED` (sent, waiting for the bank), `FAILED` or `REFUNDED`.","example":"PAID","isRequired":true,"uniqueKey":"paymentInfo.oneOf.0.status","typeLabel":"string"},"external":{"type":"object","properties":{"pixId":{"type":"string","description":"ID of the payment at Portão 3's banking partner. You never need it to call this API: identify the payment by its `_id`. Absent on some older payments.","example":"c7810c30-971f-4e84-8feb-b7819087d4de","format":"uuid","uniqueKey":"paymentInfo.oneOf.0.external.pixId","typeLabel":"string\u003cuuid>"},"platformUserId":{"type":"string","description":"ID of the user who created the payment, on some older payments only.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","uniqueKey":"paymentInfo.oneOf.0.external.platformUserId","typeLabel":"string"}},"description":"References of the payment at the bank.","uniqueKey":"paymentInfo.oneOf.0.external","typeLabel":"object"}},"uniqueKey":"paymentInfo.oneOf.0","typeLabel":"object"},{"type":"null","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["status"],"properties":{"status":{"type":"string","description":"Status of the Pix payment, such as `PAID`, `CONFIRMED` (sent, waiting for the bank), `FAILED` or `REFUNDED`.","example":"PAID"},"external":{"type":"object","properties":{"pixId":{"type":"string","description":"ID of the payment at Portão 3's banking partner. You never need it to call this API: identify the payment by its `_id`. Absent on some older payments.","example":"c7810c30-971f-4e84-8feb-b7819087d4de","format":"uuid"},"platformUserId":{"type":"string","description":"ID of the user who created the payment, on some older payments only.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99"}},"description":"References of the payment at the bank."}},"uniqueKey":"paymentInfo.oneOf.1","typeLabel":"null"},{"type":"object","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["status"],"properties":{"status":{"type":"string","description":"Status of the boleto payment, such as `PAID`, `FAILED` or `REFUNDED`.","example":"PAID","isRequired":true,"uniqueKey":"paymentInfo.oneOf.2.status","typeLabel":"string"},"external":{"type":"object","properties":{"boletoId":{"type":"string","description":"The bank's ID of the payment.","example":"2f8d6c1a-4b3e-4a5d-9c7b-1e0f2a3b4c5d","format":"uuid","uniqueKey":"paymentInfo.oneOf.2.external.boletoId","typeLabel":"string\u003cuuid>"},"platformUserId":{"type":"string","description":"ID of the user who created the payment, on some older payments only. Use `requester`.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","uniqueKey":"paymentInfo.oneOf.2.external.platformUserId","typeLabel":"string"}},"description":"References of the payment at the bank.","uniqueKey":"paymentInfo.oneOf.2.external","typeLabel":"object"}},"uniqueKey":"paymentInfo.oneOf.2","typeLabel":"object"},{"type":"null","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["status"],"properties":{"status":{"type":"string","description":"Status of the boleto payment, such as `PAID`, `FAILED` or `REFUNDED`.","example":"PAID"},"external":{"type":"object","properties":{"boletoId":{"type":"string","description":"The bank's ID of the payment.","example":"2f8d6c1a-4b3e-4a5d-9c7b-1e0f2a3b4c5d","format":"uuid"},"platformUserId":{"type":"string","description":"ID of the user who created the payment, on some older payments only. Use `requester`.","example":"e3553bc1-5e20-4e17-b22a-a796fda0aa99"}},"description":"References of the payment at the bank."}},"uniqueKey":"paymentInfo.oneOf.3","typeLabel":"null"},{"type":"object","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["panMasked","status"],"properties":{"panMasked":{"type":"string","description":"The card's number, masked.","example":"533612******1234","isRequired":true,"uniqueKey":"paymentInfo.oneOf.4.panMasked","typeLabel":"string"},"status":{"type":"string","description":"Status of the card: `ACTIVE`, `BLOCKED` or `CANCELLED`.","example":"ACTIVE","isRequired":true,"uniqueKey":"paymentInfo.oneOf.4.status","typeLabel":"string"}},"uniqueKey":"paymentInfo.oneOf.4","typeLabel":"object"},{"type":"null","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","required":["panMasked","status"],"properties":{"panMasked":{"type":"string","description":"The card's number, masked.","example":"533612******1234"},"status":{"type":"string","description":"Status of the card: `ACTIVE`, `BLOCKED` or `CANCELLED`.","example":"ACTIVE"}},"uniqueKey":"paymentInfo.oneOf.5","typeLabel":"null"},{"type":"object","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","additionalProperties":{"oneOf":[{}],"uniqueKey":"paymentInfo.oneOf.6.additionalProperties","typeLabel":"any"},"uniqueKey":"paymentInfo.oneOf.6","typeLabel":"object"},{"type":"null","description":"On a Pix sent, a boleto paid or a card transaction: the status and references of the Pix payment, boleto payment or card behind it — or, with `details=true`, that whole Pix payment (as `GET .../pix/{pixId}` returns it), boleto payment or card. `null` when that record is gone; absent on any other transaction.","additionalProperties":{"oneOf":[{}],"uniqueKey":"paymentInfo.oneOf.7.additionalProperties","typeLabel":"any"},"uniqueKey":"paymentInfo.oneOf.7","typeLabel":"null"}],"uniqueKey":"paymentInfo","typeLabel":"object · null · object · null · object · null · object · null"}},"required":["_id","accountId","availableBalanceBefore","billingAmount","billingAmountAuthorized","createdAt","effectiveAt","environment","financialImpactType","msgType","organizationId","realmId","responseCode","txnType","updatedAt","walletId"],"description":"A transaction, with what the payment or card behind it says.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"6710c9a2b4d3e80012c9a1e4","environment":"LIVE","realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"66f2a3d1b4d3e80012c9a0d2","availableBalanceBefore":1250000,"financialImpactType":"CREDIT","responseCode":0,"msgType":1600,"txnType":36,"effectiveAt":"2026-10-17T13:42:58.000Z","billingAmount":15000,"billingAmountAuthorized":15000,"createdAt":"2026-10-17T13:43:01.000Z","updatedAt":"2026-10-17T13:43:01.000Z","cardId":"66f2a4b8b4d3e80012c9a0e1","balanceCategory":"FLEX_INTERNATIONAL","billingCurrency":"986","cardTransaction":{"localTime":"2026-11-02T15:20:31.000Z","txnCurrency":"986","txnAmount":18990,"txnAmountAuthorized":18990,"linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}],"_id":"66f2a7e9b4d3e80012c9a115","acquiringCountryCode":"076","acquiringId":"012345","mcc":"5943","merchantCity":"SAO PAULO","merchantCountry":"BRA","merchantId":"000000000473921","merchantName":"PAPELARIA CENTRAL","expired":false,"cleared":true,"overcleared":false,"reversed":false,"posEntryMode":"E-Commerce","recurring":false,"mobileWalletProvider":103},"pixTransaction":{"creditParty":{"name":"Papelaria Central Ltda","document":"12345678000190","_id":"6710c9a2b4d3e80012c9a1e5","key":"financeiro@papelariacentral.com.br","bankIspb":"60701190","branch":"0001","accountNumber":"123456","accountType":"CACC","street":null,"city":null,"state":null,"postalCode":null},"debitParty":{"name":"Papelaria Central Ltda","document":"12345678000190","_id":"6710c9a2b4d3e80012c9a1e5","key":"financeiro@papelariacentral.com.br","bankIspb":"60701190","branch":"0001","accountNumber":"123456","accountType":"CACC","street":null,"city":null,"state":null,"postalCode":null},"receipt":{"endToEndId":"E60701190202611031520s0a1b2c3d4e"},"txnCurrency":"986","txnOriginalAmount":15000,"txnDiscountAmount":0,"txnFineAmount":0,"txnInterestAmount":0,"txnPurchaseAmount":0,"txnWithdrawalAmount":0,"txnUpdatedAmount":15000,"txnUpdatedAmountAuthorized":15000,"initiationType":"DICT","_id":"6710c9a2b4d3e80012c9a1e7","internalPixId":"6710c8f1b4d3e80012c9a1d0","internalPixBillingId":"6710c8f1b4d3e80012c9a1d1","payer":{"document":"12345678909","name":"Mariana Costa"},"withdrawal":{"agentType":null,"serviceProvider":null},"description":"Pedido 1234","dueDate":null,"expiresAt":null,"qrCodeType":"COB","pixCopyPaste":"00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913PAPELARIA6009SAO PAULO62070503***63041D3D","qrQrCodeActive":true,"errorDescription":"Saldo insuficiente","cleared":true,"additionalInfo":[{"key":"Pedido","value":"1234","_id":"6710c9a2b4d3e80012c9a1e6"}],"linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}]},"boletoTransaction":{"internalBoletoId":"6718b0c4b4d3e80012c9a2a7","barcode":"34191790010104351004791020150008291070026000","txnCurrency":"986","txnOriginalAmount":26000,"txnDiscountAmount":0,"txnFineAmount":0,"txnInterestAmount":0,"txnUpdatedAmount":26000,"txnUpdatedAmountAuthorized":26000,"txnMaxAmount":26000,"txnMinAmount":26000,"issuer":"Banco Itaú","type":"GENERIC","linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}],"_id":"6718b0c4b4d3e80012c9a2a8","receipt":{"authentication":null,"authenticationApi":"A1B2C3D4E5F60718293A4B5C6D7E8F90","receipt":null},"confirmedAt":"2026-10-23T14:02:11.000Z","dueDate":"2026-10-25T00:00:00.000Z","finalPaymentAt":"2026-11-24T00:00:00.000Z","settleAt":"2026-10-23T00:00:00.000Z","payee":"Papelaria Central Ltda","payeeDocument":"12345678000190","payer":"Acme Comércio Ltda","payerDocument":"98765432000110"},"tedTransaction":{"txnCurrency":"986","txnAmount":120000,"txnAmountAuthorized":120000,"_id":"6722a0b1b4d3e80012c9a3c0","internalTedId":"6722a07eb4d3e80012c9a3bf","creditParty":{"_id":"6722a0b1b4d3e80012c9a3c1","name":"Papelaria Central Ltda","personName":"João Silva","document":"12345678000190","bankCode":"341","branch":"0001","accountNumber":"123456","accountType":"CACC"},"debitParty":{"_id":"6722a0b1b4d3e80012c9a3c1","name":"Papelaria Central Ltda","personName":"João Silva","document":"12345678000190","bankCode":"341","branch":"0001","accountNumber":"123456","accountType":"CACC"},"description":"Pagamento fornecedor","rolledback":{"reason":"Conta inexistente","reasonCode":"AC03"},"linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}]},"p2pTransaction":{"txnCurrency":"986","txnAmount":50000,"txnAmountAuthorized":50000,"payeeAccountId":"66f2a1c7b4d3e80012c9a0b4","payerAccountId":"66f2a1c7b4d3e80012c9a0b4","_id":"6720f1a3b4d3e80012c9a3b2","payeeWalletId":"66f2a3d1b4d3e80012c9a0d3","payerWalletId":"66f2a3d1b4d3e80012c9a0d2","linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}]},"feeTransaction":{"txnCurrency":"986","txnAmount":664,"txnAmountAuthorized":664,"_id":"66f2a7e9b4d3e80012c9a117","linkedTransactions":[{"transactionId":"66f2a7e9b4d3e80012c9a113","linkType":"CLEARING_DEBITED_BY","createdAt":"2026-11-03T09:12:40.000Z","updatedAt":"2026-11-03T09:12:40.000Z","_id":"66f2a7e9b4d3e80012c9a114"}],"description":"Tarifa de compra internacional","external":{"invoiceId":"66f2a8a1b4d3e80012c9a120","dealId":"66f2a8a1b4d3e80012c9a121","contractId":"66f2a8a1b4d3e80012c9a122"},"creditParty":{"type":"LOCAL","_id":"66f2a7e9b4d3e80012c9a118","local":{"realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"66f2a3d1b4d3e80012c9a0d2"},"remote":{"pixKey":"financeiro@acme.com.br","pixDict":"EMAIL"}},"debitParty":{"type":"LOCAL","_id":"66f2a7e9b4d3e80012c9a118","local":{"realmId":"f495ff0c-ab54-4f99-8e92-ca8682e4de9b","organizationId":"c4bd3f21-dfbd-44e8-8055-68ba15bed410","accountId":"66f2a1c7b4d3e80012c9a0b4","walletId":"66f2a3d1b4d3e80012c9a0d2"},"remote":{"pixKey":"financeiro@acme.com.br","pixDict":"EMAIL"}}},"enrichment":{"merchant":null,"category":"OFFICE_SUPPLIES","rulesVersion":3,"_id":"66f2a7e9b4d3e80012c9a116"},"customFields":{"cost-center":"CC-1020"},"spendReview":{"status":"PENDING_APPROVAL","policyId":"3f2e1d0c-9b8a-4c7d-8e6f-5a4b3c2d1e0f","policyRequestId":"4d2c1b0a-9f8e-4d7c-8b6a-5f4e3d2c1b0a","requester":{"userId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99","name":"Mariana Costa","email":"mariana.costa@acme.com.br"},"requestedAt":"2026-11-02T18:02:11.000Z","autoApproved":false,"approvalExpiresAt":"2026-12-02T18:02:11.000Z","decidedAt":"2026-11-03T10:15:00.000Z","declineOutcome":"DENIED","decisionReason":"Falta o comprovante"},"spendReviewSubmissionLeaseUntil":"2026-11-02T18:07:11.000Z","receipts":"https://files.example.com/receipt.pdf","external":{"transactionId":"0F1E2D3C4B5A69788796A5B4C3D2E1F0","pixId":"b6c2a1f0-3d4e-4f5a-8b9c-0d1e2f3a4b5c","paymentId":"c7d3b2a1-4e5f-4a6b-9c0d-1e2f3a4b5c6d","boletoId":"d8e4c3b2-5f6a-4b7c-8d1e-2f3a4b5c6d7e","tedId":"e9f5d4c3-6a7b-4c8d-9e2f-3a4b5c6d7e8f"},"processingType":"INSTANT","internalErrorCode":"LIMIT_EXCEEDED","__v":0,"paymentInfo":{"status":"PAID","external":{"pixId":"c7810c30-971f-4e84-8feb-b7819087d4de","platformUserId":"e3553bc1-5e20-4e17-b22a-a796fda0aa99"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"f497919d-4408-4852-929d-d8b5e6212448":{"description":"`FORBIDDEN_WALLET` — You are not an admin of the organization and the wallet is not shared with you.","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"},"18f6b23a-6a7f-4e86-a82f-a2730f0201af":{"description":"`ACCOUNT_NOT_FOUND` — No account with this ID exists in the organization.\n\n`WALLET_NOT_FOUND` — No wallet with this ID exists in the account and environment.\n\n`TRANSACTION_NOT_FOUND` — The wallet has no transaction with this ID in this environment.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["ACCOUNT_NOT_FOUND","WALLET_NOT_FOUND","TRANSACTION_NOT_FOUND"],"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"},"e3e66a50-06a7-4fc6-8a2f-5567ec2ad4ba":{"description":"`BAD_REQUEST` — A path or query parameter is invalid; `fields` lists each one.","content":{"application/json":{"schema":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request that failed. Quote it when contacting support.","example":"1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b","isRequired":true,"uniqueKey":"traceId","typeLabel":"string"},"code":{"type":"string","enum":["BAD_REQUEST"],"description":"Stable, machine-readable error code. Branch on this, never on `message`.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"origin":{"type":"string","enum":["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":"details","message":"Invalid option: expected one of \"true\"|\"false\"","code":"DETAILS_ONE_OF"}]},"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":"details","message":"Invalid option: expected one of \"true\"|\"false\"","code":"DETAILS_ONE_OF"}]}}},"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":"Get a transaction - Portão 3","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/banking/transactions/get-a-transaction","matchLevel":0},"pt-BR":{"href":"/api-reference/banking/transactions/get-a-transaction","matchLevel":0}}},"lastModified":"2026-11-05T01:29:31.701Z","originalFileLocation":"api-reference/banking/transactions/get-a-transaction.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=\"Returns one of the wallet\u0026#x27;s transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Portão 3\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/porto3/QdzuGtifN6DwhHiP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a transaction - Portão 3\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one of the wallet\u0026#x27;s transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.\">\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/transactions/get-a-transaction\">\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=Transactions\u0026amp;title=Get+a+transaction\u0026amp;description=Returns+one+of+the+wallet%27s+transactions+in+full%3A+its+details+sub-document+%28%60cardTransaction%60%2C+%60pixTransaction%60%2C+%60boletoTransaction%60%2C+%60tedTransaction%60%2C+%60p2pTran\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=ab4d2070aa8b0b622afdfe142821f39c4162b4a875ac5ccf067ce23274fbbcc8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a transaction - Portão 3\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one of the wallet\u0026#x27;s transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://porto3.mintlify.app/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Get+a+transaction\u0026amp;description=Returns+one+of+the+wallet%27s+transactions+in+full%3A+its+details+sub-document+%28%60cardTransaction%60%2C+%60pixTransaction%60%2C+%60boletoTransaction%60%2C+%60tedTransaction%60%2C+%60p2pTran\u0026amp;theme=5e0a82ebc99173f82bcd67f6\u0026amp;signature=ab4d2070aa8b0b622afdfe142821f39c4162b4a875ac5ccf067ce23274fbbcc8\">\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/transactions/get-a-transaction\">\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/transactions/get-a-transaction.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/transactions/get-a-transaction#webpage\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction\",\"name\":\"Get a transaction\",\"description\":\"Returns one of the wallet's transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.\",\"dateModified\":\"2026-11-05T01:29:31.701Z\",\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction#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\":\"Transactions\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/transactions/list-an-accounts-transactions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a transaction\",\"item\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction#apireference\",\"headline\":\"Get a transaction\",\"name\":\"Get a transaction\",\"description\":\"Returns one of the wallet's transactions in full: its details sub-document (cardTransaction, pixTransaction, boletoTransaction, tedTransaction, p2pTransaction or feeTransaction), its custom fields and, once it was submitted for an expense review, its spendReview.\",\"url\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://developers.portao3.com.br/api-reference/banking/transactions/get-a-transaction#webpage\"},\"dateModified\":\"2026-11-05T01:29:31.701Z\",\"publisher\":{\"@id\":\"https://developers.portao3.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.portao3.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Portão 3\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Portão 3","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/overview"},{"title":"Pagination","href":"/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","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","description":"Totals the wallet's money in and money out in a period: the sum of its `CREDIT` transactions (`input`) and of its `DEBIT` transactions (`output`), in cents.","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","description":"Replaces the transaction's custom field values with the body — a map of each field's `slug` to its value. Send the whole set: a field you leave out is removed, and `{}` removes them all.","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/banking/transactions/update-a-transactions-custom-fields"}]},{"group":"Transaction Reversals","pages":[{"title":"List the realm's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/reversals","href":"/api-reference/banking/transaction-reversals/list-the-realms-pix-refunds"},{"title":"List an organization's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-organizations-pix-refunds"},{"title":"List an account's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals","href":"/api-reference/banking/transaction-reversals/list-an-accounts-pix-refunds"},{"title":"List a wallet's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-wallets-pix-refunds"},{"title":"List a transaction's PIX refunds","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/list-a-transactions-pix-refunds"},{"title":"Start a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/banking/transaction-reversals/start-a-pix-refund"},{"title":"Confirm a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/banking/transaction-reversals/confirm-a-pix-refund"},{"title":"Cancel a PIX refund","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/banking/transaction-reversals/cancel-a-pix-refund"}]},{"group":"Spend Review","pages":[{"title":"Preview a transaction's spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/banking/spend-review/preview-a-transactions-spend-review"},{"title":"Submit a transaction for spend review","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/banking/spend-review/submit-a-transaction-for-spend-review"}]},{"group":"Cashback","pages":[{"title":"Get a wallet's earned cashback","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/banking/cashback/get-a-wallets-earned-cashback"},{"title":"Get a wallet's cashback balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance","href":"/api-reference/banking/cashback/get-a-wallets-cashback-balance"}]},{"group":"Currency Codes","pages":[{"title":"List currency codes","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /currency-codes","href":"/api-reference/banking/currency-codes/list-currency-codes"}]}]},{"group":"Billing","pages":[{"group":"Deals","pages":[{"title":"List an organization's deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/list-an-organizations-deals"},{"title":"Export deals","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/export","href":"/api-reference/billing/deals/export-deals"},{"title":"Get a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/get-a-deal"},{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/billing/deals/create-a-deal"},{"title":"Update a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/deals/{dealId}","href":"/api-reference/billing/deals/update-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/billing/deals/cancel-a-deal"}]},{"group":"Invoices","pages":[{"title":"List an organization's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/list-an-organizations-invoices"},{"title":"List a deal's invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/invoices","href":"/api-reference/billing/invoices/list-a-deals-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/billing/invoices/create-an-invoice"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/get-an-invoice"},{"title":"Update an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/billing/invoices/update-an-invoice"},{"title":"Cancel an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/cancel","href":"/api-reference/billing/invoices/cancel-an-invoice"},{"title":"Export invoices","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/export","href":"/api-reference/billing/invoices/export-invoices"}]},{"group":"Invoice Entries","pages":[{"title":"List an invoice's entries","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/list-an-invoices-entries"},{"title":"Add entries to an invoice","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/billing/invoice-entries/add-entries-to-an-invoice"},{"title":"Get an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}","href":"/api-reference/billing/invoice-entries/get-an-entry"},{"title":"Delete an entry","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries/{invoiceEntryId}/delete","href":"/api-reference/billing/invoice-entries/delete-an-entry"}]},{"group":"Invoice Statements","pages":[{"title":"List an invoice's statements","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/list-an-invoices-statements"},{"title":"Get a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/billing/invoice-statements/get-a-statement"},{"title":"Create a statement","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/billing/invoice-statements/create-a-statement"},{"title":"Mark an invoice as paid","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/billing/invoice-statements/mark-an-invoice-as-paid"},{"title":"Create a boleto","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/bank-slip","href":"/api-reference/billing/invoice-statements/create-a-boleto"},{"title":"Download a boleto PDF","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/billing/invoice-statements/download-a-boleto-pdf"},{"title":"Create a PIX charge","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/pix-billing","href":"/api-reference/billing/invoice-statements/create-a-pix-charge"},{"title":"Charge the payer's wallet","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/p2p-billing","href":"/api-reference/billing/invoice-statements/charge-the-payers-wallet"}]},{"group":"NFSe Configuration","pages":[{"title":"Get the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/get-the-nfse-configuration"},{"title":"Create the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/create-the-nfse-configuration"},{"title":"Delete the NFSe configuration","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json delete /realms/{realmId}/organizations/{organizationId}/nfse-configs","href":"/api-reference/billing/nfse-configuration/delete-the-nfse-configuration"}]},{"group":"Payment Links","pages":[{"title":"List an organization's payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/list-an-organizations-payment-links"},{"title":"Create a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links","href":"/api-reference/billing/payment-links/create-a-payment-link"},{"title":"Export payment links","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/report","href":"/api-reference/billing/payment-links/export-payment-links"},{"title":"Get a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json get /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/get-a-payment-link"},{"title":"Update a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json put /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}","href":"/api-reference/billing/payment-links/update-a-payment-link"},{"title":"Activate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/activate","href":"/api-reference/billing/payment-links/activate-a-payment-link"},{"title":"Deactivate a payment link","deprecated":null,"version":null,"openapi":"/api-reference/billing.openapi.json post /realms/{realmId}/organizations/{organizationId}/payment-links/{paymentLinkId}/deactivate","href":"/api-reference/billing/payment-links/deactivate-a-payment-link"}]}]},{"group":"Accounting","pages":[{"group":"Tax Issuers","pages":[{"title":"Get your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/get-your-tax-issuer"},{"title":"Create your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/create-your-tax-issuer"},{"title":"Update your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json patch /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/update-your-tax-issuer"},{"title":"Deactivate your tax issuer","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-issuer","href":"/api-reference/accounting/tax-issuers/deactivate-your-tax-issuer"},{"title":"Upload your digital certificate","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/secrets","href":"/api-reference/accounting/tax-issuers/upload-your-digital-certificate"},{"title":"Upload your logo","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-issuer/{taxIssuer}/logotype","href":"/api-reference/accounting/tax-issuers/upload-your-logo"}]},{"group":"Tax Documents (NFSe)","pages":[{"title":"List an organization's tax documents","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/list-an-organizations-tax-documents"},{"title":"Issue a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document","href":"/api-reference/accounting/tax-documents-nfse/issue-a-tax-document"},{"title":"Issue tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch","href":"/api-reference/accounting/tax-documents-nfse/issue-tax-documents-in-batch"},{"title":"Download tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/download-batch","href":"/api-reference/accounting/tax-documents-nfse/download-tax-documents-in-batch"},{"title":"Cancel tax documents in batch","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json post /realms/{realmId}/organizations/{organizationId}/tax-document/batch-cancel","href":"/api-reference/accounting/tax-documents-nfse/cancel-tax-documents-in-batch"},{"title":"Download a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}/download","href":"/api-reference/accounting/tax-documents-nfse/download-a-tax-document"},{"title":"Cancel a tax document","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json delete /realms/{realmId}/organizations/{organizationId}/tax-document/{taxDocumentId}","href":"/api-reference/accounting/tax-documents-nfse/cancel-a-tax-document"}]},{"group":"Tax Codes","pages":[{"title":"List a city's special tax regimes","deprecated":null,"version":null,"openapi":"/api-reference/accounting.openapi.json get /taxCode/{specialTaxCode}","href":"/api-reference/accounting/tax-codes/list-a-citys-special-tax-regimes"}]}]},{"group":"Registry","pages":[{"group":"Customers","pages":[{"title":"List an organization's customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/list-an-organizations-customers"},{"title":"Create a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer","href":"/api-reference/registry/customers/create-a-customer"},{"title":"Export customers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customers/report","href":"/api-reference/registry/customers/export-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/get-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/customer/{customerId}","href":"/api-reference/registry/customers/update-a-customer"},{"title":"Activate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/activate","href":"/api-reference/registry/customers/activate-a-customer"},{"title":"Deactivate a customer","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/customer/{customerId}/deactivate","href":"/api-reference/registry/customers/deactivate-a-customer"}]},{"group":"Companies","pages":[{"title":"Search companies","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies","href":"/api-reference/registry/companies/search-companies"},{"title":"Get a company by CNPJ","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/companies/{document}","href":"/api-reference/registry/companies/get-a-company-by-cnpj"}]},{"group":"People","pages":[{"title":"Get a person by CPF","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/people/{document}","href":"/api-reference/registry/people/get-a-person-by-cpf"}]},{"group":"Products","pages":[{"title":"List an organization's products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/list-an-organizations-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products","href":"/api-reference/registry/products/create-a-product"},{"title":"Export products","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/report","href":"/api-reference/registry/products/export-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/products/{productId}","href":"/api-reference/registry/products/update-a-product"},{"title":"Activate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/activate","href":"/api-reference/registry/products/activate-a-product"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/products/{productId}/deactivate","href":"/api-reference/registry/products/deactivate-a-product"}]},{"group":"Suppliers","pages":[{"title":"List an organization's suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/list-an-organizations-suppliers"},{"title":"Create a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers","href":"/api-reference/registry/suppliers/create-a-supplier"},{"title":"Export suppliers","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/suppliers/report","href":"/api-reference/registry/suppliers/export-suppliers"},{"title":"Get a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json get /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/get-a-supplier"},{"title":"Update a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json put /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}","href":"/api-reference/registry/suppliers/update-a-supplier"},{"title":"Activate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/activate","href":"/api-reference/registry/suppliers/activate-a-supplier"},{"title":"Deactivate a supplier","deprecated":null,"version":null,"openapi":"/api-reference/registry.openapi.json post /realms/{realmId}/organizations/{organizationId}/suppliers/{supplierId}/deactivate","href":"/api-reference/registry/suppliers/deactivate-a-supplier"}]}]},{"group":"Platform","pages":[{"group":"Wallets","pages":[{"title":"Get wallet cashback","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback","href":"/api-reference/platform/wallets/get-wallet-cashback"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/platform/wallets/realms-organizations-wallets-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets-report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets-report","href":"/api-reference/platform/wallets/realms-organizations-wallets-report"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block","href":"/api-reference/platform/wallets/realms-organizations-wallets-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-cashback-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance","href":"/api-reference/platform/wallets/realms-organizations-wallets-clear-balance"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/platform/wallets/realms-organizations-wallets-transfer-requests-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock","href":"/api-reference/platform/wallets/realms-organizations-wallets-unblock"}]},{"group":"Cards","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/platform/cards/realms-organizations-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/threeds-submit","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/threeds-submit","href":"/api-reference/platform/cards/realms-organizations-threeds-submit"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-block"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-details"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-pin"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-transactionsexport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/platform/cards/realms-organizations-wallets-cards-unblock"}]},{"group":"PIX","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix","href":"/api-reference/platform/pix/realms-organizations-wallets-pix"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/platform/pix/realms-organizations-wallets-pix-request"}]},{"group":"PIX Keys (DICT)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove","href":"/api-reference/platform/pix-keys-dict/realms-organizations-wallets-pix-dict-remove"}]},{"group":"Boleto","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slip-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check","href":"/api-reference/platform/boleto/realms-organizations-wallets-bank-slipcheck"}]},{"group":"Transfers","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2p"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfers-p2pschedule"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule","href":"/api-reference/platform/transfers/realms-organizations-wallets-transfersschedule"}]},{"group":"Scheduled Payments","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-schedulesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json delete /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report","href":"/api-reference/platform/scheduled-payments/realms-organizations-wallets-schedulesreport"}]},{"group":"Transactions \u0026 Statements","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statements-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-invoices-statementssettlement"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/statements/report-async","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/statements/report-async","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-statementsreport-async"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-aggregated-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-summary"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-custom-fields"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-reversals-confirm"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-review"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request","href":"/api-reference/platform/transactions-\u0026-statements/realms-organizations-wallets-transactions-spend-reviewrequest"}]},{"group":"Invoices","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices","href":"/api-reference/platform/invoices/realms-organizations-invoices"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}","href":"/api-reference/platform/invoices/realms-organizations-invoices-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment","href":"/api-reference/platform/invoices/realms-organizations-invoices-create-payment"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf","href":"/api-reference/platform/invoices/realms-organizations-invoices-download-pdf"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries","href":"/api-reference/platform/invoices/realms-organizations-invoices-entries-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/invoices/report","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/invoices/report","href":"/api-reference/platform/invoices/realms-organizations-invoicesreport"},{"title":"/realms/{realmId}/organizations/{organizationId}/my-invoices","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/my-invoices","href":"/api-reference/platform/invoices/realms-organizations-my-invoices"}]},{"group":"Deals","pages":[{"title":"Create a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals","href":"/api-reference/platform/deals/create-a-deal"},{"title":"Cancel a deal","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel","href":"/api-reference/platform/deals/cancel-a-deal"}]},{"group":"Billing","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing","href":"/api-reference/platform/billing/realms-organizations-wallets-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf","href":"/api-reference/platform/billing/realms-organizations-wallets-billing-download-pdf"}]},{"group":"Notifications","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/notifications","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/notifications","href":"/api-reference/platform/notifications/realms-organizations-notifications"}]},{"group":"Users","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default","href":"/api-reference/platform/users/realms-organizations-users-walletsdefault"}]},{"group":"Vehicles","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","deprecated":null,"version":null,"openapi":"/api-reference/platform.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/platform/vehicles/realms-organizations-vehicles-unarchive"}]}]},{"group":"Notification","pages":[{"group":"Webhooks","pages":[{"title":"List the realm's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/list-the-realms-webhooks"},{"title":"Register a realm webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks","href":"/api-reference/notification/webhooks/register-a-realm-webhook"},{"title":"Activate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-a-realm-webhook-event"},{"title":"Deactivate a realm webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-a-realm-webhook-event"},{"title":"List an organization's webhooks","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json get /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/list-an-organizations-webhooks"},{"title":"Register an organization webhook","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks","href":"/api-reference/notification/webhooks/register-an-organization-webhook"},{"title":"Activate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/activate","href":"/api-reference/notification/webhooks/activate-an-organization-webhook-event"},{"title":"Deactivate an organization webhook event","deprecated":null,"version":null,"openapi":"/api-reference/notification.openapi.json post /realms/{realmId}/organizations/{organizationId}/webhooks/{webhookId}/events/{eventId}/deactivate","href":"/api-reference/notification/webhooks/deactivate-an-organization-webhook-event"}]}]},{"group":"Rule Engine","pages":[{"group":"Business Policies","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json put /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-3"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/{businessPolicyId}/archive","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policies-archive"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-description","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-description"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/business-policies/generate-policy","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesgenerate-policy"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/payment-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiespayment-conditions"},{"title":"/realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/business-policies/spend-review-conditions","href":"/api-reference/ruleengine/business-policies/realms-organizations-business-policiesspend-review-conditions"}]},{"group":"Policy Evaluations","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-evaluations","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-evaluations","href":"/api-reference/ruleengine/policy-evaluations/realms-organizations-policy-evaluations"}]},{"group":"Policy Requests","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json get /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/cancel","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-deny"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-approve","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-approve"},{"title":"/realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","deprecated":null,"version":null,"openapi":"/api-reference/ruleengine.openapi.json post /realms/{realmId}/organizations/{organizationId}/policy-requests/{policyRequestId}/force-deny","href":"/api-reference/ruleengine/policy-requests/realms-organizations-policy-requests-force-deny"}]}]},{"group":"Scheduling","pages":[{"group":"Schedules","pages":[{"title":"List an organization's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/schedules","href":"/api-reference/scheduling/schedules/list-an-organizations-schedules"},{"title":"List a wallet's schedules","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules","href":"/api-reference/scheduling/schedules/list-a-wallets-schedules"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/scheduling/schedules/get-a-schedule"},{"title":"List a schedule's events","deprecated":null,"version":null,"openapi":"/api-reference/scheduling.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}/logs","href":"/api-reference/scheduling/schedules/list-a-schedules-events"}]}]},{"group":"Travel","pages":[{"group":"Passengers","pages":[{"title":"List an organization's passengers","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/list-an-organizations-passengers"},{"title":"Create a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/passengers","href":"/api-reference/travel/passengers/create-a-passenger"},{"title":"Get a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/get-a-passenger"},{"title":"Update a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json put /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/update-a-passenger"},{"title":"Delete a passenger","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json delete /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}","href":"/api-reference/travel/passengers/delete-a-passenger"}]},{"group":"Trips","pages":[{"title":"List the realm's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/trips","href":"/api-reference/travel/trips/list-the-realms-trips"},{"title":"List an organization's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/list-an-organizations-trips"},{"title":"Create a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips","href":"/api-reference/travel/trips/create-a-trip"},{"title":"List a passenger's trips","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/passengers/{passengerId}/trips","href":"/api-reference/travel/trips/list-a-passengers-trips"},{"title":"Get a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}","href":"/api-reference/travel/trips/get-a-trip"},{"title":"List a trip's history","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/history","href":"/api-reference/travel/trips/list-a-trips-history"},{"title":"Issue a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/issue","href":"/api-reference/travel/trips/issue-a-trip"},{"title":"List a trip's cancellation quotes","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/list-a-trips-cancellation-quotes"},{"title":"Cancel a trip","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/trips/{tripId}/cancel","href":"/api-reference/travel/trips/cancel-a-trip"}]},{"group":"Air search","pages":[{"title":"Search airports","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/locations","href":"/api-reference/travel/air-search/search-airports"},{"title":"Create an air search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/air/searches","href":"/api-reference/travel/air-search/create-an-air-search"},{"title":"Get an air search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}","href":"/api-reference/travel/air-search/get-an-air-search-and-its-results"},{"title":"Get an air search grouped by airline and price","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/aggregate","href":"/api-reference/travel/air-search/get-an-air-search-grouped-by-airline-and-price"},{"title":"Get an air search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/air/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/air-search/get-an-air-search-item"}]},{"group":"Hotel search","pages":[{"title":"Search hotel destinations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/locations","href":"/api-reference/travel/hotel-search/search-hotel-destinations"},{"title":"Create a hotel search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/hotel/searches","href":"/api-reference/travel/hotel-search/create-a-hotel-search"},{"title":"Get a hotel search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-and-its-results"},{"title":"Get a hotel search as map points","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map","href":"/api-reference/travel/hotel-search/get-a-hotel-search-as-map-points"},{"title":"Get a hotel search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/hotel-search/get-a-hotel-search-item"}]},{"group":"Bus search","pages":[{"title":"Search bus stations","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/locations","href":"/api-reference/travel/bus-search/search-bus-stations"},{"title":"Create a bus search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/bus/searches","href":"/api-reference/travel/bus-search/create-a-bus-search"},{"title":"Get a bus search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}","href":"/api-reference/travel/bus-search/get-a-bus-search-and-its-results"},{"title":"Get a bus search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/bus/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/bus-search/get-a-bus-search-item"}]},{"group":"Vehicle search","pages":[{"title":"Search vehicle pick-up places","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/locations","href":"/api-reference/travel/vehicle-search/search-vehicle-pick-up-places"},{"title":"Create a vehicle search","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicle/searches","href":"/api-reference/travel/vehicle-search/create-a-vehicle-search"},{"title":"Get a vehicle search and its results","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-and-its-results"},{"title":"Get a vehicle search item","deprecated":null,"version":null,"openapi":"/api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicle/searches/{searchId}/items/{itemId}","href":"/api-reference/travel/vehicle-search/get-a-vehicle-search-item"}]}]},{"group":"Vehicles","pages":[{"group":"Vehicles","pages":[{"title":"List an organization's vehicles","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/list-an-organizations-vehicles"},{"title":"Create a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles","href":"/api-reference/vehicle/vehicles/create-a-vehicle"},{"title":"Get a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json get /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/get-a-vehicle"},{"title":"Update a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json put /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}","href":"/api-reference/vehicle/vehicles/update-a-vehicle"},{"title":"Archive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive","href":"/api-reference/vehicle/vehicles/archive-a-vehicle"},{"title":"Unarchive a vehicle","deprecated":null,"version":null,"openapi":"/api-reference/vehicle.openapi.json post /realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive","href":"/api-reference/vehicle/vehicles/unarchive-a-vehicle"}]}]},{"group":"Attachments","pages":[{"group":"Attachments","pages":[{"title":"List the realm's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/attachments","href":"/api-reference/attachment/attachments/list-the-realms-attachments"},{"title":"List an organization's attachments","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/list-an-organizations-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json post /realms/{realmId}/organizations/{organizationId}/attachments","href":"/api-reference/attachment/attachments/create-an-attachment"},{"title":"Get an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/get-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json delete /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}","href":"/api-reference/attachment/attachments/delete-an-attachment"},{"title":"Download an attachment","deprecated":null,"version":null,"openapi":"/api-reference/attachment.openapi.json get /realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}/download","href":"/api-reference/attachment/attachments/download-an-attachment"}]}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pt-BR"}]},{"tab":"Referência da API","groups":[{"group":"Visão geral","pages":[{"title":"Referência da API","href":"/pt-BR/api-reference/overview"},{"title":"Paginação","href":"/pt-BR/api-reference/pagination"}]},{"group":"Identity","pages":[{"group":"Authentication","pages":[{"title":"Sign in","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /auth/sign-in","href":"/api-reference/identity/authentication/sign-in"}]},{"group":"Current User","pages":[{"title":"Get the current API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /me","href":"/api-reference/identity/current-user/get-the-current-api-client"}]},{"group":"Custom Fields","pages":[{"title":"List an organization's custom fields","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/list-an-organizations-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields","href":"/api-reference/identity/custom-fields/create-a-custom-field"},{"title":"Get a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/get-a-custom-field"},{"title":"Update a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}","href":"/api-reference/identity/custom-fields/update-a-custom-field"},{"title":"Activate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/activate","href":"/api-reference/identity/custom-fields/activate-a-custom-field"},{"title":"Deactivate a custom field","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/deactivate","href":"/api-reference/identity/custom-fields/deactivate-a-custom-field"}]},{"group":"API Clients","pages":[{"title":"List the realm's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/list-the-realms-api-clients"},{"title":"List an organization's API clients","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/appclients","href":"/api-reference/identity/api-clients/list-an-organizations-api-clients"},{"title":"Create an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients","href":"/api-reference/identity/api-clients/create-an-api-client"},{"title":"Deactivate an API client","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/appclients/{appClientId}/deactivate","href":"/api-reference/identity/api-clients/deactivate-an-api-client"}]},{"group":"Users","pages":[{"title":"List the realm's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users","href":"/api-reference/identity/users/list-the-realms-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users","href":"/api-reference/identity/users/create-a-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/get-a-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json patch /realms/{realmId}/users/{userId}","href":"/api-reference/identity/users/update-a-user"},{"title":"Activate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/activate","href":"/api-reference/identity/users/activate-a-user"},{"title":"Deactivate a user","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/deactivate","href":"/api-reference/identity/users/deactivate-a-user"},{"title":"List an organization's users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users","href":"/api-reference/identity/users/list-an-organizations-users"},{"title":"Assign a user to an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/assign","href":"/api-reference/identity/users/assign-a-user-to-an-organization"},{"title":"Revoke a user from an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/users/{userId}/organizations/{organizationId}/revoke","href":"/api-reference/identity/users/revoke-a-user-from-an-organization"},{"title":"Export organization users","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users/report","href":"/api-reference/identity/users/export-organization-users"}]},{"group":"Organizations","pages":[{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}","href":"/api-reference/identity/organizations/get-an-organization"}]},{"group":"Groups","pages":[{"title":"List an organization's groups","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/list-an-organizations-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups","href":"/api-reference/identity/groups/create-a-group"},{"title":"Get a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/get-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json put /realms/{realmId}/organizations/{organizationId}/groups/{groupId}","href":"/api-reference/identity/groups/update-a-group"},{"title":"Archive a group","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json post /realms/{realmId}/organizations/{organizationId}/groups/{groupId}/archive","href":"/api-reference/identity/groups/archive-a-group"}]},{"group":"Realms","pages":[{"title":"Get your realm","deprecated":null,"version":null,"openapi":"/api-reference/identity.openapi.json get /realms/{realmId}","href":"/api-reference/identity/realms/get-your-realm"}]}]},{"group":"Banking","pages":[{"group":"Accounts","pages":[{"title":"List the realm's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/accounts","href":"/api-reference/banking/accounts/list-the-realms-accounts"},{"title":"List an organization's accounts","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts","href":"/api-reference/banking/accounts/list-an-organizations-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}","href":"/api-reference/banking/accounts/get-an-account"},{"title":"Get an account's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/balance","href":"/api-reference/banking/accounts/get-an-accounts-closing-balance"},{"title":"Get a wallet's closing balance","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/balance","href":"/api-reference/banking/accounts/get-a-wallets-closing-balance"}]},{"group":"Account Limits","pages":[{"title":"List the realm's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/account-limits","href":"/api-reference/banking/account-limits/list-the-realms-account-limits"},{"title":"List an organization's account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/account-limits","href":"/api-reference/banking/account-limits/list-an-organizations-account-limits"},{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits","href":"/api-reference/banking/account-limits/get-account-limits"}]},{"group":"Wallets","pages":[{"title":"List the realm's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/wallets","href":"/api-reference/banking/wallets/list-the-realms-wallets"},{"title":"List an organization's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/wallets","href":"/api-reference/banking/wallets/list-an-organizations-wallets"},{"title":"List an account's wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/list-an-accounts-wallets"},{"title":"Create a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets","href":"/api-reference/banking/wallets/create-a-wallet"},{"title":"Export wallets","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/export","href":"/api-reference/banking/wallets/export-wallets"},{"title":"Get a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/get-a-wallet"},{"title":"Update a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}","href":"/api-reference/banking/wallets/update-a-wallet"},{"title":"Cancel a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cancel","href":"/api-reference/banking/wallets/cancel-a-wallet"},{"title":"Block a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block","href":"/api-reference/banking/wallets/block-a-wallet"},{"title":"Unblock a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock","href":"/api-reference/banking/wallets/unblock-a-wallet"},{"title":"Empty a wallet","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance","href":"/api-reference/banking/wallets/empty-a-wallet"},{"title":"Cancel a scheduled payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}","href":"/api-reference/banking/wallets/cancel-a-scheduled-payment"}]},{"group":"Transaction Limits","pages":[{"title":"Get transaction limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/get-transaction-limits"},{"title":"Update a transaction limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits","href":"/api-reference/banking/transaction-limits/update-a-transaction-limit"}]},{"group":"Transfers","pages":[{"title":"List a wallet's transfer requests","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/list-a-wallets-transfer-requests"},{"title":"Create a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests","href":"/api-reference/banking/transfers/create-a-transfer-request"},{"title":"Get a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/get-a-transfer-request"},{"title":"Update a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}","href":"/api-reference/banking/transfers/update-a-transfer-request"},{"title":"Send a transfer request for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request","href":"/api-reference/banking/transfers/send-a-transfer-request-for-approval"},{"title":"Confirm a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm","href":"/api-reference/banking/transfers/confirm-a-transfer-request"},{"title":"Cancel a transfer request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel","href":"/api-reference/banking/transfers/cancel-a-transfer-request"}]},{"group":"Cards","pages":[{"title":"List the realm's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/cards","href":"/api-reference/banking/cards/list-the-realms-cards"},{"title":"List an organization's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/cards","href":"/api-reference/banking/cards/list-an-organizations-cards"},{"title":"List an account's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards","href":"/api-reference/banking/cards/list-an-accounts-cards"},{"title":"List a wallet's cards","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/list-a-wallets-cards"},{"title":"Issue a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards","href":"/api-reference/banking/cards/issue-a-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/get-a-card"},{"title":"Update a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}","href":"/api-reference/banking/cards/update-a-card"},{"title":"Get card details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details","href":"/api-reference/banking/cards/get-card-details"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block","href":"/api-reference/banking/cards/block-a-card"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock","href":"/api-reference/banking/cards/unblock-a-card"},{"title":"Set a card's PIN","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin","href":"/api-reference/banking/cards/set-a-cards-pin"},{"title":"List a card's transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions","href":"/api-reference/banking/cards/list-a-cards-transactions"},{"title":"Get a card's transaction totals","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary","href":"/api-reference/banking/cards/get-a-cards-transaction-totals"},{"title":"Export card transactions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export","href":"/api-reference/banking/cards/export-card-transactions"}]},{"group":"Card Limits","pages":[{"title":"List the realm's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-the-realms-card-limit-rules"},{"title":"List an organization's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-organizations-card-limit-rules"},{"title":"List an account's card limit rules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/list-an-accounts-card-limit-rules"},{"title":"Create a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule","href":"/api-reference/banking/card-limits/create-a-card-limit-rule"},{"title":"Get a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/get-a-card-limit-rule"},{"title":"Update a card limit rule","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}","href":"/api-reference/banking/card-limits/update-a-card-limit-rule"},{"title":"Create a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit","href":"/api-reference/banking/card-limits/create-a-card-limit"},{"title":"Get a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/get-a-card-limit"},{"title":"Delete a card limit","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}","href":"/api-reference/banking/card-limits/delete-a-card-limit"},{"title":"List a card's limits","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit","href":"/api-reference/banking/card-limits/list-a-cards-limits"}]},{"group":"Cards 3DS","pages":[{"title":"List an account's 3D Secure challenges","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds","href":"/api-reference/banking/cards-3ds/list-an-accounts-3d-secure-challenges"},{"title":"Answer a 3D Secure challenge","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit","href":"/api-reference/banking/cards-3ds/answer-a-3d-secure-challenge"}]},{"group":"Pix Payments","pages":[{"title":"List the realm's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix","href":"/api-reference/banking/pix-payments/list-the-realms-pix-payments"},{"title":"List an organization's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix","href":"/api-reference/banking/pix-payments/list-an-organizations-pix-payments"},{"title":"List an account's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix","href":"/api-reference/banking/pix-payments/list-an-accounts-pix-payments"},{"title":"List a wallet's Pix payments","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/list-a-wallets-pix-payments"},{"title":"Create a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix","href":"/api-reference/banking/pix-payments/create-a-pix-payment"},{"title":"Get a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/get-a-pix-payment"},{"title":"Set a Pix payment's details","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}","href":"/api-reference/banking/pix-payments/set-a-pix-payments-details"},{"title":"Send a Pix payment for approval","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request","href":"/api-reference/banking/pix-payments/send-a-pix-payment-for-approval"},{"title":"Confirm a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm","href":"/api-reference/banking/pix-payments/confirm-a-pix-payment"},{"title":"Cancel a Pix payment","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel","href":"/api-reference/banking/pix-payments/cancel-a-pix-payment"}]},{"group":"Pix Keys","pages":[{"title":"List the realm's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-dict","href":"/api-reference/banking/pix-keys/list-the-realms-pix-keys"},{"title":"List an organization's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-keys"},{"title":"List an account's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict","href":"/api-reference/banking/pix-keys/list-an-accounts-pix-keys"},{"title":"List a wallet's Pix keys","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/list-a-wallets-pix-keys"},{"title":"Register a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict","href":"/api-reference/banking/pix-keys/register-a-pix-key"},{"title":"Request a Pix key confirmation code","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp","href":"/api-reference/banking/pix-keys/request-a-pix-key-confirmation-code"},{"title":"Confirm a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key"},{"title":"Remove a Pix key","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove","href":"/api-reference/banking/pix-keys/remove-a-pix-key"},{"title":"List an organization's Pix key claims","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-dict-claim","href":"/api-reference/banking/pix-keys/list-an-organizations-pix-key-claims"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm","href":"/api-reference/banking/pix-keys/confirm-a-pix-key-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel","href":"/api-reference/banking/pix-keys/cancel-a-pix-key-claim"}]},{"group":"PIX Charges","pages":[{"title":"/pix-billing/{pixBillingId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /pix-billing/{pixBillingId}","href":"/api-reference/banking/pix-charges/pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel","href":"/api-reference/banking/pix-charges/realms-organizations-accounts-wallets-pix-billing-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-organizations-pix-billing"},{"title":"/realms/{realmId}/pix-billing","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing","href":"/api-reference/banking/pix-charges/realms-pix-billing"}]},{"group":"PIX Automatic","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json put /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automatic-schedules-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules","href":"/api-reference/banking/pix-automatic/realms-organizations-accounts-wallets-pix-billing-automaticschedules"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history","href":"/api-reference/banking/pix-automatic/realms-organizations-pix-billing-automatic-history"},{"title":"/realms/{realmId}/pix-billing-automatic","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-automatic","href":"/api-reference/banking/pix-automatic/realms-pix-billing-automatic"}]},{"group":"PIX Initiation (Open Finance)","pages":[{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json post /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-2"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-cancel"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items"},{"title":"/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json delete /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-accounts-wallets-pix-billing-initiation-request-items-1"},{"title":"/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-organizations-pix-billing-initiation-request"},{"title":"/realms/{realmId}/pix-billing-initiation-request","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-billing-initiation-request","href":"/api-reference/banking/pix-initiation-open-finance/realms-pix-billing-initiation-request"}]},{"group":"PIX Infractions (MED)","pages":[{"title":"List the realm's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-the-realms-pix-infractions"},{"title":"List an organization's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-organizations-pix-infractions"},{"title":"List an account's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-an-accounts-pix-infractions"},{"title":"List a wallet's Pix infractions","deprecated":null,"version":null,"openapi":"/api-reference/banking.openapi.json get /realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction","href":"/api-reference/banking/pix-infractions-med/list-a-wallets-pix-infractions"},{"title":"Get a transaction's Pix infraction","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","description":"Totals the wallet's money in and money out in a period: the sum of its `CREDIT` transactions (`input`) and of its `DEBIT` transactions (`output`), in cents.","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","description":"Replaces the transaction's custom field values with the body — a map of each field's `slug` to its value. Send the whole set: a field you leave out is removed, and `{}` removes them all.","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":"Get a transaction - 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"]}