{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
{
"code": "AUT-0033",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example",
"upstream": {
"code": "E4001",
"message": "account not found at provider"
}
}
Read the B3 instrument code of an averbado contract
Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.
GET
/
v1
/
consignado
/
contracts
/
{numero_contrato}
/
registro-b3
Read the B3 instrument code of an averbado contract
Read only: the CCB number the contract's cadastro named (the documentation's block when it sent one, else the averbação's), or numeroContrato when it named none.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Lerian","description":"Documentation for Lerian's core banking platform: Midaz ledger, Tracer, Reporter, Matcher, Flowker, Lender, Brazilian payment rails, Access Manager, Console and APIs.","colors":{"primary":"#847000","light":"#feed02","dark":"#7a6e00"},"logo":{"light":"https://mintcdn.com/lerian-49cb71fc/5Pw5_1cckl5ZMv6f/images/logo/light.png?fit=max\u0026auto=format\u0026n=5Pw5_1cckl5ZMv6f\u0026q=85\u0026s=de7fc3e0093ffdf038e1e2f846026264","dark":"https://mintcdn.com/lerian-49cb71fc/5Pw5_1cckl5ZMv6f/images/logo/dark.png?fit=max\u0026auto=format\u0026n=5Pw5_1cckl5ZMv6f\u0026q=85\u0026s=ed46af54d1a048c270443b346f7bf0cf"},"favicon":"https://mintcdn.com/lerian-49cb71fc/7NrS5Dioky2Qpn5V/images/icons/lerian-favicon.png?fit=max\u0026auto=format\u0026n=7NrS5Dioky2Qpn5V\u0026q=85\u0026s=95a2179ffdca213c5d13d729e575b753","api":{"examples":{"languages":["bash","go","typescript","python"],"prefill":true}},"appearance":{"default":"dark"},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contact us","href":"https://lerian.studio/contact"}},"footer":{"socials":{"github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Products","items":[{"label":"Midaz","href":"/en/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/en/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/en/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/en/products/flowker/what-is-flowker"},{"label":"Lender","href":"/en/products/lender/what-is-lender"},{"label":"Reporter","href":"/en/products/reporter/what-is-reporter"}]},{"header":"Payments","items":[{"label":"Brazil Rails","href":"/en/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/en/interfaces/introduction"},{"label":"Pix","href":"/en/interfaces/pix/pix-overview"},{"label":"TED","href":"/en/interfaces/ted/ted-overview"}]},{"header":"Developers","items":[{"label":"API Reference","href":"/en/reference/introduction"},{"label":"Event streaming","href":"/en/reference/events/overview"},{"label":"News","href":"/en/news/news"}]},{"header":"Company","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contact","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"search":{"prompt":"Search Lerian docs"},"seo":{"metatags":{"og:site_name":"Lerian Docs","og:type":"website","twitter:card":"summary_large_image"},"organization":{"id":"https://lerian.studio/#organization","name":"Lerian","url":"https://lerian.studio","logo":"https://docs.lerian.studio/images/logo/light.png","sameAs":["https://github.com/LerianStudio","https://www.linkedin.com/company/lerianstudio","https://www.instagram.com/lerian.studio/","https://blog.lerian.studio/"]},"indexing":"navigable"},"fonts":{"heading":{"family":"IBM Plex Sans"},"body":{"family":"IBM Plex Sans"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"errors":{"404":{"redirect":false,"description":"The page moved or never existed. Start from the [home page](/en/index) or the [API Reference](/en/reference/introduction)."}},"contextual":{"options":["copy","view","download-spec","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/LerianStudio"}]},"languages":[{"language":"en","default":true,"href":"en"},{"language":"pt-BR","footer":{"socials":{"github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Produtos","items":[{"label":"Midaz","href":"/pt/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/pt/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/pt/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/pt/products/flowker/what-is-flowker"},{"label":"Lender","href":"/pt/products/lender/what-is-lender"},{"label":"Reporter","href":"/pt/products/reporter/what-is-reporter"}]},{"header":"Pagamentos","items":[{"label":"Trilhos Brasil","href":"/pt/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/pt/interfaces/introduction"},{"label":"Pix","href":"/pt/interfaces/pix/pix-overview"},{"label":"TED","href":"/pt/interfaces/ted/ted-overview"}]},{"header":"Desenvolvedores","items":[{"label":"Referência da API","href":"/pt/reference/introduction"},{"label":"Streaming de eventos","href":"/pt/reference/events/overview"},{"label":"Novidades","href":"/pt/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contato","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Fale conosco","href":"https://lerian.studio/contact"}},"href":"pt"},{"language":"es","footer":{"socials":{"github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Productos","items":[{"label":"Midaz","href":"/es/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/es/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/es/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/es/products/flowker/what-is-flowker"},{"label":"Lender","href":"/es/products/lender/what-is-lender"},{"label":"Reporter","href":"/es/products/reporter/what-is-reporter"}]},{"header":"Pagos","items":[{"label":"Rieles Brasil","href":"/es/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/es/interfaces/introduction"},{"label":"Pix","href":"/es/interfaces/pix/pix-overview"},{"label":"TED","href":"/es/interfaces/ted/ted-overview"}]},{"header":"Desarrolladores","items":[{"label":"Referencia de API","href":"/es/reference/introduction"},{"label":"Streaming de eventos","href":"/es/reference/events/overview"},{"label":"Novedades","href":"/es/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contacto","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contáctanos","href":"https://lerian.studio/contact"}},"href":"es"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"lerian-49cb71fc","hasAudioNarration":false,"actualSubdomain":"lerian-49cb71fc","customDomains":["docs.lerian.studio"],"gitSource":{"type":"github","owner":"lerianstudio","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfe21f6954ce8e22a1e39f","collectionId":"02ea3e63-1f6f-4ae9-914f-1d474afd7767","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfe21f6954ce8e22a1e39f"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfe3c31a060c9b7798b189","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"en","tag":"API Reference","count":2025},{"language":"es","tag":"Referencia de API","count":2025},{"language":"pt-BR","tag":"Referência da API","count":2025},{"language":"en","tag":"Brazil Rails","count":807},{"language":"es","tag":"Rieles Brasil","count":807},{"language":"pt-BR","tag":"Trilhos Brasil","count":807},{"language":"en","tag":"Products","count":665},{"language":"es","tag":"Productos","count":665},{"language":"pt-BR","tag":"Produtos","count":665},{"language":"en","tag":"Interfaces","count":507},{"language":"es","tag":"Interfaces","count":507},{"language":"pt-BR","tag":"Interfaces","count":507},{"language":"en","tag":"Lerian Products","count":384},{"language":"es","tag":"Productos Lerian","count":384},{"language":"pt-BR","tag":"Produtos Lerian","count":384},{"language":"en","tag":"Midaz","count":348},{"language":"es","tag":"Midaz","count":348},{"language":"pt-BR","tag":"Midaz","count":348},{"language":"en","tag":"Platform","count":326},{"language":"es","tag":"Plataforma","count":326},{"language":"pt-BR","tag":"Plataforma","count":326},{"language":"en","tag":"Matcher","count":234},{"language":"es","tag":"Matcher","count":234},{"language":"pt-BR","tag":"Matcher","count":234},{"language":"en","tag":"SPI (Pix)","count":200},{"language":"es","tag":"SPI (Pix)","count":200},{"language":"pt-BR","tag":"SPI (Pix)","count":200},{"language":"en","tag":"Console","count":172},{"language":"es","tag":"Console","count":172},{"language":"pt-BR","tag":"Console","count":172}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles/styles.css","content":"a.link.nav-tabs-item{padding-left:.3rem!important;padding-right:.3rem!important;border-radius:.75rem!important}.sidebar>nav>a.group.flex.items-center,nav[data-level=\"0\"]>a.group.flex.items-center{padding-right:.25rem!important;padding-left:.25rem!important;border-radius:.75rem!important}a.group.flex.items-center:hover{text-shadow:none!important}.dark a.link.nav-anchor.group.flex.items-center:hover,a.group.flex.items-center:hover{background-color:#feed02!important;color:#000!important;border-radius:.75rem!important}.dark a.link.nav-anchor.group.flex.items-center:hover svg{background-color:#000!important;filter:none!important}.dark a.link.nav-anchor.group.flex.items-center:hover .bg-primary,.dark a.link.nav-anchor.group.flex.items-center:hover .dark\\:bg-primary-light,.dark a.link.nav-anchor.group.flex.items-center:hover svg.bg-primary,.dark a.link.nav-anchor.group.flex.items-center:hover svg.dark\\:bg-primary-light,.dark a.link.nav-anchor.group.flex.items-center:hover svg[style*=-webkit-mask],.dark a.link.nav-anchor.group.flex.items-center:hover svg[style*=mask]{background-color:#000!important}#pagination a:hover div,#pagination a:hover span,.dark a.link.nav-anchor.group.flex.items-center:hover div,.dark a.link.nav-anchor.group.flex.items-center:hover span{color:#000!important;-webkit-text-fill-color:#000!important;text-shadow:none!important}#pagination a:hover{border-radius:.75rem!important;transition:background-color .2s ease,border-color .2s ease}#pagination a:hover svg,#pagination a:hover svg *{color:#000!important;stroke:#000!important;fill:#000!important}#pagination a:hover,.dark #pagination a:hover{background-color:#feed02!important;border-color:#feed02!important}.dark #pagination a:hover div,.dark #pagination a:hover span,.dark #pagination a:hover svg,.dark #pagination a:hover svg *{color:#000!important;stroke:#000!important;fill:#000!important;-webkit-text-fill-color:#000!important}.nav-anchor img[src*=\"/images/icons/\"]{filter:grayscale(1)!important;opacity:.55!important}.nav-anchor.text-primary img[src*=\"/images/icons/\"],.nav-anchor:hover img[src*=\"/images/icons/\"],.nav-anchor[aria-current=location] img[src*=\"/images/icons/\"]{filter:none!important;opacity:1!important}a.link.nav-tabs-item[aria-current=location]{color:rgb(var(--primary))!important}.dark a.link.nav-tabs-item[aria-current=location]{color:rgb(var(--primary-light))!important}.landing-band{background-image:linear-gradient(to bottom right,#feed02,#f6ff86)}.dark .landing-band{background-image:linear-gradient(to bottom right,#0d0d11,#15151a)}"}],"page":{"pagePath":"pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","slug":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","pageMetadata":{"title":"Read the B3 instrument code of an averbado contract","description":"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.","deprecated":null,"version":null,"sidebarTitle":"Read the b3 instrument code of an averbado contract","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/registro-b3","href":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":"Read the B3 instrument code of an averbado contract","description":"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.","deprecated":null,"version":null,"sidebarTitle":"Read the b3 instrument code of an averbado contract","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/registro-b3","href":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.","operationId":"getConsignadoRegistroB3","parameters":["28928e12-d05f-4628-b5b3-8e5aaea5a249"],"responses":{"200":"4cad7c75-eeca-49fa-8953-6c0a428697da","401":"ee362c67-c59a-4cea-9d14-55c20326283d","403":"a4847a66-0d09-4dcf-9d30-42bf70c9f8f5","404":"4d837996-5a3c-4ccb-92d3-c701dc8dc8b2","422":"ce81f66d-7936-4b76-bd24-0e59bec4fc2c","429":"20fca24e-bba9-4e32-aa14-4873b81acefe","500":"71cf6488-965e-45c7-b526-c181636403d6","501":"835b853d-2b75-4023-b218-e7f04b337ad3","503":"6a9288b6-5d88-4c86-a1ad-d7d4eed5dbba"},"security":["f4435254-10ce-40d6-9118-cfd4c79baeed"],"summary":"Read the B3 instrument code of an averbado contract","tags":["Consignado Registro B3"],"x-mint":{"href":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract"},"method":"get","type":"path","servers":["e4fabad7-ea07-4c93-8599-d40fb36615d4"],"path":"/v1/consignado/contracts/{numero_contrato}/registro-b3","baseUrlOptions":["https://br-consignado-gw.sandbox.lerian.net"],"title":"Read the B3 instrument code of an averbado contract","codeSamples":[],"requestExampleLanguages":["bash","go","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"28928e12-d05f-4628-b5b3-8e5aaea5a249":{"description":"Client contract identity within the authenticated tenant.","in":"path","name":"numero_contrato","required":true,"schema":{"description":"Client contract identity within the authenticated tenant.","examples":["99999999999AN1"],"minLength":1,"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"4cad7c75-eeca-49fa-8953-6c0a428697da":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"numeroCcb":{"description":"Read only: the CCB number the contract's cadastro named (the documentation's block when it sent one, else the averbação's), or numeroContrato when it named none.","examples":["DIDI2090"],"type":"string","isRequired":true,"uniqueKey":"numeroCcb","typeLabel":"string"},"numeroContrato":{"description":"The contract the registro belongs to.","examples":["99999999999AN1"],"type":"string","isRequired":true,"uniqueKey":"numeroContrato","typeLabel":"string"},"registradoEm":{"description":"When the registro was durably stored, strict RFC 3339 UTC. A replay returns the original instant.","examples":["2026-10-08T14:03:11Z"],"type":"string","isRequired":true,"uniqueKey":"registradoEm","typeLabel":"string"},"registroB3":{"additionalProperties":false,"properties":{"codigoInstrumentoFinanceiro":{"description":"The code B3 generated when it accepted the CCB registration (X(14)). Stored as received and compared byte for byte: no trim, no case fold.","examples":["CCB0000ABCD12"],"pattern":"^[A-Za-z0-9]{1,14}$","type":"string","isRequired":true,"uniqueKey":"registroB3.codigoInstrumentoFinanceiro","typeLabel":"string"},"dataRegistro":{"description":"The civil date B3 accepted the registration on, YYYY-MM-DD. Not in the future and not before the averbação, both in Brasília time.","examples":["2026-10-08"],"format":"date","type":"string","uniqueKey":"registroB3.dataRegistro","typeLabel":"string\u003cdate>"}},"required":["codigoInstrumentoFinanceiro"],"type":"object","description":"The registro B3 as stored.","isRequired":true,"uniqueKey":"registroB3","typeLabel":"object"}},"required":["numeroContrato","numeroCcb","registroB3","registradoEm"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"numeroCcb":"DIDI2090","numeroContrato":"99999999999AN1","registradoEm":"2026-10-08T14:03:11Z","registroB3":{"codigoInstrumentoFinanceiro":"CCB0000ABCD12","dataRegistro":"2026-10-08"}}}},"exampleType":"generated"}},"description":"OK","exampleType":"generated"},"ee362c67-c59a-4cea-9d14-55c20326283d":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Unauthorized","exampleType":"generated"},"a4847a66-0d09-4dcf-9d30-42bf70c9f8f5":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"4d837996-5a3c-4ccb-92d3-c701dc8dc8b2":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"ce81f66d-7936-4b76-bd24-0e59bec4fc2c":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Unprocessable Entity","exampleType":"generated"},"20fca24e-bba9-4e32-aa14-4873b81acefe":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Too Many Requests","exampleType":"generated"},"71cf6488-965e-45c7-b526-c181636403d6":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Internal Server Error","exampleType":"generated"},"835b853d-2b75-4023-b218-e7f04b337ad3":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Not Implemented","exampleType":"generated"},"6a9288b6-5d88-4c86-a1ad-d7d4eed5dbba":{"content":{"application/problem+json":{"schema":{"additionalProperties":true,"properties":{"code":{"description":"Stable, machine-readable product error code. One of the enumerated values: the CLT-NNNN catalog codes for the general refusal classes; the named command conflicts, which a client branches on to tell one conflict from another; the four terminal refusals IDEMPOTENCY_STATE_UNRECOGNISED, IDEMPOTENCY_RECORD_UNREADABLE, IDEMPOTENCY_OUTCOME_UNRECORDED and IDEMPOTENCY_REPLAY_UNAVAILABLE (422), which tell the client to reconcile the original request and never retry under a new key; IDEMPOTENCY_KEY_REUSE (422): the key is spent on a different request, so send a new key; the codes a single surface answers, named after it (FUNDO_*, CESSAO_*, REGISTRO_B3_*, ...); and the 5xx codes naming an upstream (DATAPREV_*, STREAMING_HUB_*, TENANT_MANAGER_*, the Access Manager's AUT-0033 and AUT-1021) or an unknown outcome, whose detail is client-readable.","enum":["AUT-0033","AUT-1021","AVERBACAO_ARTIFACT_CONFLICT","AVERBACAO_CLAIM_CONFLICT","AVERBACAO_DOCUMENTATION_CONFLICT","AVERBACAO_EXCLUDED","AVERBACAO_HELD_BY_ANOTHER_SENDER","AVERBACAO_NOT_ACCEPTED","AVERBACAO_OPERATIONS_INTERNAL","AVERBACAO_OPERATIONS_INVALID_CURSOR","AVERBACAO_OPERATIONS_INVALID_QUERY","AVERBACAO_OPERATIONS_UNKNOWN_STATUS","AVERBACAO_OPERATION_NOT_FOUND","BID_NO_PROPOSTA_LEFT","BID_ORIGINADOR_INACTIVE","BID_ORIGINADOR_UNKNOWN","BID_PROPOSAL_SLOT_TAKEN","BID_SOLICITACAO_TAKEN","BID_SOLICITACAO_UNKNOWN","BID_SUBMISSIONS_INTERNAL","BID_SUBMISSIONS_INVALID_CURSOR","BID_SUBMISSIONS_UNKNOWN_SITUATION","BOOKING_FIELD_INVALID","CEDED_CREDIT_INTERNAL","CEDED_CREDIT_NO_FUND_ENTITLEMENT","CEDED_CREDIT_UNAVAILABLE","CESSAO_CEDED_TO_OTHER_FUND","CESSAO_CREDIT_NOT_ACCEPTED","CESSAO_CREDIT_NOT_FOUND","CESSAO_CREDIT_NOT_WITNESSED","CESSAO_CREDIT_PENDING","CESSAO_FUNDO_NOT_ATTRIBUTED","CESSAO_INTERNAL","CESSAO_INVALID_INPUT","CESSAO_UNAVAILABLE","CESSAO_UNWIRED","CLT-0001","CLT-0002","CLT-0003","CLT-0004","CLT-0005","CLT-0006","CLT-0007","CLT-0008","CLT-0009","CLT-0010","CLT-0011","CONTRACT_ALREADY_REGISTERED","CONTRACT_NOT_BOOKABLE","CURSOR_EXPIRED","CURSOR_FENCE_MISMATCH","DATAPREV_CREDENTIAL_REJECTED","DATAPREV_CREDENTIAL_REQUIRED","DATAPREV_CREDENTIAL_REVOKED","DATAPREV_INVALID_RESPONSE","DATAPREV_TIMEOUT","DATAPREV_UNAVAILABLE","DECLARED_DATES_OUT_OF_ORDER","DECLARED_TERMS_INCONSISTENT","DISBURSEMENT_CONFIRMATIONS_INTERNAL","DISBURSEMENT_CONFIRMATIONS_INVALID_CURSOR","DISBURSEMENT_PAYMENT_CONFLICT","EVENT_DELIVERY_INTERNAL","EXCLUSION_AUTHORITY_CONFLICT","EXCLUSION_BOOKING_IDENTITY_INCOMPLETE","EXCLUSION_DOCUMENTATION_UNDERWAY","EXCLUSION_OPERATIONS_INTERNAL","EXCLUSION_OPERATIONS_INVALID_CURSOR","EXCLUSION_OPERATIONS_INVALID_QUERY","EXCLUSION_OPERATIONS_UNKNOWN_STATUS","EXCLUSION_OPERATION_NOT_FOUND","FGTS_EXECUTION_ALREADY_REFUSED","FGTS_EXECUTION_CONTRACT_TAKEN","FGTS_EXECUTION_OUTCOME_UNRESOLVED","FGTS_EXECUTION_PAYLOAD_MISMATCH","FIRST_DEDUCTION_BEFORE_COMPETENCIA","FORMALIZATION_DEADLINE_EXCEEDED","FUNDO_CNPJ_CONFLICT","FUNDO_DEACTIVATED","FUNDO_INTERNAL","FUNDO_INVALID_ID","FUNDO_INVALID_INPUT","FUNDO_NOT_FOUND","FUNDO_NOT_REGISTERED","FUNDO_REF_CONFLICT","FUNDO_UNAVAILABLE","IDEMPOTENCY_KEY_REUSE","IDEMPOTENCY_OUTCOME_UNRECORDED","IDEMPOTENCY_RECORD_UNREADABLE","IDEMPOTENCY_REPLAY_UNAVAILABLE","IDEMPOTENCY_STATE_UNRECOGNISED","INVALID_CONTRACT_NUMBER","INVALID_CURSOR","INVALID_EVENTS_INVALID_CURSOR","INVALID_PAGE_LIMIT","INVENTORY_UNAVAILABLE","MARGIN_SNAPSHOT_INCONSISTENT","ORIGINADOR_INTERNAL","ORIGINADOR_INVALID_ID","ORIGINADOR_INVALID_INPUT","ORIGINADOR_NOT_FOUND","ORIGINADOR_REF_CONFLICT","ORIGINADOR_UNAVAILABLE","OUTCOME_UNKNOWN","PORTABILIDADE_WINDOW_EXPIRED","RAIL_COMMANDS_INTERNAL","RAIL_COMMANDS_INVALID_CURSOR","RAIL_COMMANDS_TENANT_REQUIRED","RAIL_COMMANDS_UNKNOWN_FILTER","RAIL_COMMAND_ALREADY_REFUSED","RAIL_COMMAND_ANSWER_NOT_RETAINED","RAIL_COMMAND_CLAIM_CONFLICT","RAIL_COMMAND_OUTCOME_UNRESOLVED","RAIL_COMMAND_PAYLOAD_MISMATCH","REGISTRATION_NOT_FOUND","REGISTRO_B3_AVERBACAO_NAO_CONFIRMADA","REGISTRO_B3_CONTRATO_NAO_ENCONTRADO","REGISTRO_B3_DATA_REGISTRO_INVALIDA","REGISTRO_B3_INTERNAL","REGISTRO_B3_JA_INFORMADO","REGISTRO_B3_NAO_INFORMADO","REGISTRO_B3_UNAVAILABLE","REGISTRO_B3_UNWIRED","REPASSE_EXPECTATIONS_INTERNAL","REPASSE_EXPECTATIONS_INVALID_CURSOR","REPASSE_EXPECTATIONS_UNKNOWN_SITUATION","REVERSAO_WINDOW_EXPIRED","SALDO_DEVEDOR_INTERNAL","SALDO_DEVEDOR_INVALID_CURSOR","SALDO_DEVEDOR_NOT_FOUND","SALDO_DEVEDOR_TENANT_REQUIRED","SALDO_DEVEDOR_UNAVAILABLE","STREAMING_HUB_TIMEOUT","STREAMING_HUB_UNAVAILABLE","TENANT_MANAGER_TIMEOUT","TENANT_MANAGER_UNAVAILABLE","THROUGHPUT_HISTORY_INTERNAL","THROUGHPUT_HISTORY_INVALID_CURSOR","THROUGHPUT_HISTORY_TENANT_REQUIRED","THROUGHPUT_HISTORY_UNAVAILABLE","THROUGH_REQUIRED","UNKNOWN_QUERY_PARAMETER"],"type":"string","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","examples":["Property foo is required but is missing."],"type":"string","uniqueKey":"detail","typeLabel":"string"},"errors":{"oneOf":[{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].location","typeLabel":"string"},"message":{"description":"Error message text","type":"string","uniqueKey":"errors.oneOf.0.items.[INDEX].message","typeLabel":"string"},"value":{"description":"The value at the given location","uniqueKey":"errors.oneOf.0.items.[INDEX].value","typeLabel":"any"}},"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"errors.oneOf.0","typeLabel":"object[]"},{"description":"Optional list of individual error details","items":{"additionalProperties":false,"properties":{"location":{"description":"Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'","type":"string"},"message":{"description":"Error message text","type":"string"},"value":{"description":"The value at the given location"}},"type":"object"},"type":"null","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"object[] | null"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","examples":["https://example.com/error-log/abc123"],"format":"uri","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi>"},"status":{"description":"HTTP status code","examples":[400],"format":"int64","type":"integer","uniqueKey":"status","typeLabel":"integer\u003cint64>"},"title":{"description":"A short, human-readable summary of the problem type. This value should not change between occurrences of the error.","examples":["Bad Request"],"type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference to human-readable documentation for the error.","examples":["https://example.com/errors/example"],"format":"uri","type":"string","uniqueKey":"type","typeLabel":"string\u003curi>"},"upstream":{"additionalProperties":false,"properties":{"code":{"description":"The upstream provider's own error code, verbatim.","examples":["E4001"],"type":"string","uniqueKey":"upstream.code","typeLabel":"string"},"message":{"description":"The upstream provider's own error message, verbatim (bounded, never its raw response body).","examples":["account not found at provider"],"type":"string","uniqueKey":"upstream.message","typeLabel":"string"}},"type":"object","description":"RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one.","uniqueKey":"upstream","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"AUT-0033","detail":"Property foo is required but is missing.","errors":[{"location":"\u003cstring>","message":"\u003cstring>","value":"\u003cunknown>"}],"instance":"https://example.com/error-log/abc123","status":400,"title":"Bad Request","type":"https://example.com/errors/example","upstream":{"code":"E4001","message":"account not found at provider"}}}},"exampleType":"generated"}},"description":"Service Unavailable","exampleType":"generated"}},"security":{"f4435254-10ce-40d6-9118-cfd4c79baeed":{"BearerAuth":{"bearerFormat":"JWT","description":"JWT bearer token issued by the identity provider.","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"e4fabad7-ea07-4c93-8599-d40fb36615d4":{"url":"https://br-consignado-gw.sandbox.lerian.net"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","description":"JWT bearer token issued by the identity provider.","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT bearer token issued by the identity provider.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"pt/openapi/v3-current/consignado.yaml"},"subdomain":"lerian-49cb71fc","siteName":"Lerian","title":"Read the B3 instrument code of an averbado contract - Lerian","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","matchLevel":1},"pt-BR":{"href":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","matchLevel":0},"es":{"href":"/es/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract","matchLevel":1}}},"lastModified":"2026-10-26T23:30:55.653Z","originalFileLocation":"pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract.mdx","locale":"pt-BR"},"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=\"dark\"}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=\"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Lerian\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read the B3 instrument code of an averbado contract - Lerian\">\u003cmeta data-mint-head property=\"og:description\" content=\"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Lerian Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://lerian-49cb71fc.mintlify.app/_mintlify/api/og/v2?division=Registro+e+documentos+do+contrato\u0026amp;title=Read+the+B3+instrument+code+of+an+averbado+contract\u0026amp;description=Reads+the+B3+instrument+code+informed+for+an+averbado+contract.+A+contract+that+exists+and+holds+no+code+yet+is+404+REGISTRO_B3_NAO_INFORMADO%3B+a+contract+this+t\u0026amp;theme=3f503b0e4b30ffd40e70bfc6\u0026amp;signature=be9ed3c52ae08103d33583584ff90e1c0b34c6d384aaf4948be85f4a254c7993\">\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=\"Read the B3 instrument code of an averbado contract - Lerian\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://lerian-49cb71fc.mintlify.app/_mintlify/api/og/v2?division=Registro+e+documentos+do+contrato\u0026amp;title=Read+the+B3+instrument+code+of+an+averbado+contract\u0026amp;description=Reads+the+B3+instrument+code+informed+for+an+averbado+contract.+A+contract+that+exists+and+holds+no+code+yet+is+404+REGISTRO_B3_NAO_INFORMADO%3B+a+contract+this+t\u0026amp;theme=3f503b0e4b30ffd40e70bfc6\u0026amp;signature=be9ed3c52ae08103d33583584ff90e1c0b34c6d384aaf4948be85f4a254c7993\">\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/lerian-49cb71fc/YdFUAfJ0t1oeD5Cu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Lerian\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#847000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.lerian.studio/en/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.lerian.studio/es/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.lerian.studio/en/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://lerian.studio/#organization\",\"name\":\"Lerian\",\"url\":\"https://lerian.studio\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.lerian.studio/images/logo/light.png\"},\"sameAs\":[\"https://github.com/LerianStudio\",\"https://www.linkedin.com/company/lerianstudio\",\"https://www.instagram.com/lerian.studio/\",\"https://blog.lerian.studio/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.lerian.studio#website\",\"name\":\"Lerian\",\"url\":\"https://docs.lerian.studio\",\"publisher\":{\"@id\":\"https://lerian.studio/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract#webpage\",\"url\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\",\"name\":\"Read the B3 instrument code of an averbado contract\",\"description\":\"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\",\"dateModified\":\"2026-10-26T23:30:55.653Z\",\"isPartOf\":{\"@id\":\"https://docs.lerian.studio#website\"},\"breadcrumb\":{\"@id\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Registro e documentos do contrato\",\"item\":\"https://docs.lerian.studio/pt/reference/rails/consignado/averbar-consignado-contract\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read the B3 instrument code of an averbado contract\",\"item\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract#apireference\",\"headline\":\"Read the B3 instrument code of an averbado contract\",\"name\":\"Read the B3 instrument code of an averbado contract\",\"description\":\"Reads the B3 instrument code informed for an averbado contract. A contract that exists and holds no code yet is 404 REGISTRO_B3_NAO_INFORMADO; a contract this tenant does not hold is 404 REGISTRO_B3_CONTRATO_NAO_ENCONTRADO.\",\"url\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.lerian.studio/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract#webpage\"},\"dateModified\":\"2026-10-26T23:30:55.653Z\",\"publisher\":{\"@id\":\"https://lerian.studio/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.lerian.studio#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Lerian\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Lerian","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/LerianStudio"}]},"languages":[{"language":"en","default":true,"pages":[{"title":"en","href":"/en/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract"}]},{"language":"pt-BR","footer":{"socials":{"github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Produtos","items":[{"label":"Midaz","href":"/pt/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/pt/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/pt/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/pt/products/flowker/what-is-flowker"},{"label":"Lender","href":"/pt/products/lender/what-is-lender"},{"label":"Reporter","href":"/pt/products/reporter/what-is-reporter"}]},{"header":"Pagamentos","items":[{"label":"Trilhos Brasil","href":"/pt/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/pt/interfaces/introduction"},{"label":"Pix","href":"/pt/interfaces/pix/pix-overview"},{"label":"TED","href":"/pt/interfaces/ted/ted-overview"}]},{"header":"Desenvolvedores","items":[{"label":"Referência da API","href":"/pt/reference/introduction"},{"label":"Streaming de eventos","href":"/pt/reference/events/overview"},{"label":"Novidades","href":"/pt/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contato","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Fale conosco","href":"https://lerian.studio/contact"}},"tabs":[{"tab":"Início","icon":"house-blank","pages":[{"title":"Início","href":"/pt"}]},{"tab":"Comece aqui","icon":"rocket","pages":[{"title":"Comece aqui","href":"/pt/start-here/welcome-to-our-guides"}]},{"tab":"Produtos Lerian","icon":"cubes","pages":[{"title":"Produtos Lerian","href":"/pt/products/products-and-plugins"}]},{"tab":"Trilhos Brasil","icon":"money-bill-transfer","pages":[{"title":"Trilhos Brasil","href":"/pt/rails/what-are-brazil-rails"}]},{"tab":"Diagramas de integração","icon":"diagram-project","pages":[{"title":"Diagramas de integração","href":"/pt/diagrams/introduction"}]},{"tab":"Referência da API","icon":"terminal","anchors":[{"anchor":"Introdução","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/hourglass-yellow.png","pages":[{"title":"Introdução","href":"/pt/reference/introduction"}]},{"anchor":"Produtos","icon":"cubes","dropdowns":[{"dropdown":"Midaz","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/midaz-yellow.png","description":"Ledger, contas, transações, CRM e tarifas","versions":[{"version":"v2","default":true,"tag":"Current","groups":[{"group":"Primeiros passos","pages":[{"title":"Guia de início rápido","href":"/pt/reference/products/midaz/quick-start-guide"}]},{"group":"Núcleo","pages":[{"title":"List all organizations","deprecated":null,"version":null,"sidebarTitle":"List organizations","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations","href":"/pt/reference/products/midaz/v2/list-organizations"},{"title":"Create a new organization","deprecated":null,"version":null,"sidebarTitle":"Create organization","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations","href":"/pt/reference/products/midaz/v2/create-organization"},{"title":"Delete an organization","deprecated":null,"version":null,"sidebarTitle":"Delete organization","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}","href":"/pt/reference/products/midaz/v2/delete-organization"},{"title":"Retrieve a specific organization","deprecated":null,"version":null,"sidebarTitle":"Get organization by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}","href":"/pt/reference/products/midaz/v2/get-organization-by-id"},{"title":"Update an existing organization","deprecated":null,"version":null,"sidebarTitle":"Update organization","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}","href":"/pt/reference/products/midaz/v2/update-organization"},{"title":"List all ledgers","deprecated":null,"version":null,"sidebarTitle":"List ledgers","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers","href":"/pt/reference/products/midaz/v2/list-ledgers"},{"title":"Create a new ledger","deprecated":null,"version":null,"sidebarTitle":"Create ledger","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers","href":"/pt/reference/products/midaz/v2/create-ledger"},{"title":"Delete a ledger","deprecated":null,"version":null,"sidebarTitle":"Delete ledger","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/pt/reference/products/midaz/v2/delete-ledger"},{"title":"Retrieve a specific ledger","deprecated":null,"version":null,"sidebarTitle":"Get ledger by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/pt/reference/products/midaz/v2/get-ledger-by-id"},{"title":"Update an existing ledger","deprecated":null,"version":null,"sidebarTitle":"Update ledger","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}","href":"/pt/reference/products/midaz/v2/update-ledger"},{"title":"List all account types","deprecated":null,"version":null,"sidebarTitle":"List account types","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types","href":"/pt/reference/products/midaz/v2/list-account-types"},{"title":"Create a new account type","deprecated":null,"version":null,"sidebarTitle":"Create account type","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types","href":"/pt/reference/products/midaz/v2/create-account-type"},{"title":"Delete an account type","deprecated":null,"version":null,"sidebarTitle":"Delete account type","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}","href":"/pt/reference/products/midaz/v2/delete-account-type"},{"title":"Retrieve a specific account type","deprecated":null,"version":null,"sidebarTitle":"Get account type by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}","href":"/pt/reference/products/midaz/v2/get-account-type-by-id"},{"title":"Update an account type","deprecated":null,"version":null,"sidebarTitle":"Update account type","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/account-types/{account_type_id}","href":"/pt/reference/products/midaz/v2/update-account-type"},{"title":"List all accounts","deprecated":null,"version":null,"sidebarTitle":"List accounts","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts","href":"/pt/reference/products/midaz/v2/list-accounts"},{"title":"Create a new account","deprecated":null,"version":null,"sidebarTitle":"Create account","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts","href":"/pt/reference/products/midaz/v2/create-account"},{"title":"Retrieve an account by alias","deprecated":null,"version":null,"sidebarTitle":"Get account by alias","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}","href":"/pt/reference/products/midaz/v2/get-account-by-alias"},{"title":"Get Balances using Alias","deprecated":null,"version":null,"sidebarTitle":"Get balances by alias","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances","href":"/pt/reference/products/midaz/v2/get-balances-by-alias"},{"title":"Create single-use account block exceptions","deprecated":null,"version":null,"sidebarTitle":"Create account block exceptions","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/block-exceptions","href":"/pt/reference/products/midaz/v2/create-account-block-exceptions"},{"title":"Retrieve an account by external code","deprecated":null,"version":null,"sidebarTitle":"Get account external by code","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code}","href":"/pt/reference/products/midaz/v2/get-account-external-by-code"},{"title":"Get External balances using code","deprecated":null,"version":null,"sidebarTitle":"Get balances external by code","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/external/{code}/balances","href":"/pt/reference/products/midaz/v2/get-balances-external-by-code"},{"title":"Get all balances by account id","deprecated":null,"version":null,"sidebarTitle":"Get all balances by account id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances","href":"/pt/reference/products/midaz/v2/get-all-balances-by-account-id"},{"title":"Create Additional Balance","deprecated":null,"version":null,"sidebarTitle":"Create additional balance","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances","href":"/pt/reference/products/midaz/v2/create-additional-balance"},{"title":"Get Account Balances history at date","deprecated":null,"version":null,"sidebarTitle":"Get account balances at timestamp","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances/history","href":"/pt/reference/products/midaz/v2/get-account-balances-at-timestamp"},{"title":"Close an account","deprecated":null,"version":null,"sidebarTitle":"Close account","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/close","href":"/pt/reference/products/midaz/v2/close-account"},{"title":"Get all Operations by account","deprecated":null,"version":null,"sidebarTitle":"Get all operations by account","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations","href":"/pt/reference/products/midaz/v2/get-all-operations-by-account"},{"title":"Get Operation","deprecated":null,"version":null,"sidebarTitle":"Get operation by account","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id}","href":"/pt/reference/products/midaz/v2/get-operation-by-account"},{"title":"Delete an account","deprecated":null,"version":null,"sidebarTitle":"Delete account","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}","href":"/pt/reference/products/midaz/v2/delete-account"},{"title":"Retrieve a specific account","deprecated":null,"version":null,"sidebarTitle":"Get account by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}","href":"/pt/reference/products/midaz/v2/get-account-by-id"},{"title":"Update an account","deprecated":null,"version":null,"sidebarTitle":"Update account","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}","href":"/pt/reference/products/midaz/v2/update-account"},{"title":"List all assets","deprecated":null,"version":null,"sidebarTitle":"List assets","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets","href":"/pt/reference/products/midaz/v2/list-assets"},{"title":"Create a new asset","deprecated":null,"version":null,"sidebarTitle":"Create asset","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets","href":"/pt/reference/products/midaz/v2/create-asset"},{"title":"Delete an asset","deprecated":null,"version":null,"sidebarTitle":"Delete asset","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id}","href":"/pt/reference/products/midaz/v2/delete-asset"},{"title":"Retrieve a specific asset","deprecated":null,"version":null,"sidebarTitle":"Get asset by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id}","href":"/pt/reference/products/midaz/v2/get-asset-by-id"},{"title":"Update an asset","deprecated":null,"version":null,"sidebarTitle":"Update asset","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/assets/{asset_id}","href":"/pt/reference/products/midaz/v2/update-asset"},{"title":"Get all balances","deprecated":null,"version":null,"sidebarTitle":"Get all balances","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances","href":"/pt/reference/products/midaz/v2/get-all-balances"},{"title":"Delete Balance by account","deprecated":null,"version":null,"sidebarTitle":"Delete balance","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/pt/reference/products/midaz/v2/delete-balance"},{"title":"Get Balance by id","deprecated":null,"version":null,"sidebarTitle":"Get balance by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/pt/reference/products/midaz/v2/get-balance-by-id"},{"title":"Update Balance","deprecated":null,"version":null,"sidebarTitle":"Update balance","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}","href":"/pt/reference/products/midaz/v2/update-balance"},{"title":"Get Balance history at date","deprecated":null,"version":null,"sidebarTitle":"Get balance at timestamp","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}/history","href":"/pt/reference/products/midaz/v2/get-balance-at-timestamp"},{"title":"Get ledger current position per asset","deprecated":null,"version":null,"sidebarTitle":"Get dashboard assets","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/assets","href":"/pt/reference/products/midaz/v2/get-dashboard-assets"},{"title":"Get ledger dashboard metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/metrics","href":"/pt/reference/products/midaz/v2/get-dashboard-metrics"},{"title":"Get ledger dashboard volume series","deprecated":null,"version":null,"sidebarTitle":"Get dashboard volume","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/volume","href":"/pt/reference/products/midaz/v2/get-dashboard-volume"},{"title":"Retrieve all operation routes","deprecated":null,"version":null,"sidebarTitle":"List operation routes","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes","href":"/pt/reference/products/midaz/v2/list-operation-routes"},{"title":"Create Operation Route","deprecated":null,"version":null,"sidebarTitle":"Create operation route","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes","href":"/pt/reference/products/midaz/v2/create-operation-route"},{"title":"Delete an operation route","deprecated":null,"version":null,"sidebarTitle":"Delete operation route","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/delete-operation-route"},{"title":"Retrieve a specific operation route","deprecated":null,"version":null,"sidebarTitle":"Get operation route by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/get-operation-route-by-id"},{"title":"Update an operation route","deprecated":null,"version":null,"sidebarTitle":"Update operation route","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/update-operation-route"},{"title":"List all portfolios","deprecated":null,"version":null,"sidebarTitle":"List portfolios","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios","href":"/pt/reference/products/midaz/v2/list-portfolios"},{"title":"Create a new portfolio","deprecated":null,"version":null,"sidebarTitle":"Create portfolio","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios","href":"/pt/reference/products/midaz/v2/create-portfolio"},{"title":"Delete a portfolio","deprecated":null,"version":null,"sidebarTitle":"Delete portfolio","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id}","href":"/pt/reference/products/midaz/v2/delete-portfolio"},{"title":"Retrieve a specific portfolio","deprecated":null,"version":null,"sidebarTitle":"Get portfolio by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id}","href":"/pt/reference/products/midaz/v2/get-portfolio-by-id"},{"title":"Update a portfolio","deprecated":null,"version":null,"sidebarTitle":"Update portfolio","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/portfolios/{portfolio_id}","href":"/pt/reference/products/midaz/v2/update-portfolio"},{"title":"List all segments","deprecated":null,"version":null,"sidebarTitle":"List segments","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments","href":"/pt/reference/products/midaz/v2/list-segments"},{"title":"Create a new segment","deprecated":null,"version":null,"sidebarTitle":"Create segment","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments","href":"/pt/reference/products/midaz/v2/create-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"sidebarTitle":"Delete segment","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id}","href":"/pt/reference/products/midaz/v2/delete-segment"},{"title":"Retrieve a specific segment","deprecated":null,"version":null,"sidebarTitle":"Get segment by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id}","href":"/pt/reference/products/midaz/v2/get-segment-by-id"},{"title":"Update a segment","deprecated":null,"version":null,"sidebarTitle":"Update segment","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id}","href":"/pt/reference/products/midaz/v2/update-segment"},{"title":"Get ledger settings","deprecated":null,"version":null,"sidebarTitle":"Get ledger settings","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/settings","href":"/pt/reference/products/midaz/v2/get-ledger-settings"},{"title":"Update ledger settings","deprecated":null,"version":null,"sidebarTitle":"Update ledger settings","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/settings","href":"/pt/reference/products/midaz/v2/update-ledger-settings"},{"title":"Get all Transaction Routes","deprecated":null,"version":null,"sidebarTitle":"List transaction routes","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes","href":"/pt/reference/products/midaz/v2/list-transaction-routes"},{"title":"Create Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Create transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes","href":"/pt/reference/products/midaz/v2/create-transaction-route"},{"title":"Delete Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/delete-transaction-route"},{"title":"Get Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get transaction route by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/get-transaction-route-by-id"},{"title":"Update Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Update transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/update-transaction-route"},{"title":"Get all Transactions","deprecated":null,"version":null,"sidebarTitle":"Get all transactions","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions","href":"/pt/reference/products/midaz/v2/get-all-transactions"},{"title":"Get a Transaction by ID","deprecated":null,"version":null,"sidebarTitle":"Get transaction","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}","href":"/pt/reference/products/midaz/v2/get-transaction"},{"title":"Update a Transaction","deprecated":null,"version":null,"sidebarTitle":"Update transaction","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}","href":"/pt/reference/products/midaz/v2/update-transaction"},{"title":"Cancel a pending Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Cancel transaction","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel","href":"/pt/reference/products/midaz/v2/cancel-transaction"},{"title":"Commit a Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Commit transaction","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/commit","href":"/pt/reference/products/midaz/v2/commit-transaction"},{"title":"Update an Operation","deprecated":null,"version":null,"sidebarTitle":"Update operation","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}","href":"/pt/reference/products/midaz/v2/update-operation"},{"title":"Revert a Transaction (v2)","deprecated":null,"version":null,"sidebarTitle":"Revert transaction","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert","href":"/pt/reference/products/midaz/v2/revert-transaction"},{"title":"List the organization Operation Routes","deprecated":null,"version":null,"sidebarTitle":"List organization operation routes","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/operation-routes","href":"/pt/reference/products/midaz/v2/list-organization-operation-routes"},{"title":"Create an organization Operation Route","deprecated":null,"version":null,"sidebarTitle":"Create organization operation route","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/operation-routes","href":"/pt/reference/products/midaz/v2/create-organization-operation-route"},{"title":"Delete an organization Operation Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete organization operation route","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/delete-organization-operation-route"},{"title":"Get an organization Operation Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get organization operation route by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/get-organization-operation-route-by-id"},{"title":"Update an organization Operation Route","deprecated":null,"version":null,"sidebarTitle":"Update organization operation route","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/operation-routes/{operation_route_id}","href":"/pt/reference/products/midaz/v2/update-organization-operation-route"},{"title":"List the organization Transaction Routes","deprecated":null,"version":null,"sidebarTitle":"List organization transaction routes","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/transaction-routes","href":"/pt/reference/products/midaz/v2/list-organization-transaction-routes"},{"title":"Create an organization Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Create organization transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/transaction-routes","href":"/pt/reference/products/midaz/v2/create-organization-transaction-route"},{"title":"Delete an organization Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Delete organization transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/delete-organization-transaction-route"},{"title":"Get an organization Transaction Route by ID","deprecated":null,"version":null,"sidebarTitle":"Get organization transaction route by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/get-organization-transaction-route-by-id"},{"title":"Update an organization Transaction Route","deprecated":null,"version":null,"sidebarTitle":"Update organization transaction route","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/transaction-routes/{transaction_route_id}","href":"/pt/reference/products/midaz/v2/update-organization-transaction-route"},{"title":"Get all Metadata Indexes","deprecated":null,"version":null,"sidebarTitle":"Get all metadata indexes","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/settings/metadata-indexes","href":"/pt/reference/products/midaz/v2/get-all-metadata-indexes"},{"title":"Create Metadata Index","deprecated":null,"version":null,"sidebarTitle":"Create metadata index","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/settings/metadata-indexes/entities/{entity_name}","href":"/pt/reference/products/midaz/v2/create-metadata-index"},{"title":"Delete Metadata Index","deprecated":null,"version":null,"sidebarTitle":"Delete metadata index","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/settings/metadata-indexes/entities/{entity_name}/key/{index_key}","href":"/pt/reference/products/midaz/v2/delete-metadata-index"},{"title":"Create an atomic batch of Transactions (v2)","deprecated":null,"version":null,"sidebarTitle":"Create transaction batch","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/transactions/batch","href":"/pt/reference/products/midaz/v2/create-transaction-batch"},{"title":"Create a Transaction using the v2 block model","deprecated":null,"version":null,"sidebarTitle":"Create transaction block","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/transactions/block","href":"/pt/reference/products/midaz/v2/create-transaction-block"},{"title":"Create a Transaction using the v2 direct model","deprecated":null,"version":null,"sidebarTitle":"Create transaction direct","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/transactions/direct","href":"/pt/reference/products/midaz/v2/create-transaction-direct"},{"title":"Create a Transaction using the v2 hold model","deprecated":null,"version":null,"sidebarTitle":"Create transaction hold","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/transactions/hold","href":"/pt/reference/products/midaz/v2/create-transaction-hold"},{"title":"Create a Transaction using the v2 unblock model","deprecated":null,"version":null,"sidebarTitle":"Create transaction unblock","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/transactions/unblock","href":"/pt/reference/products/midaz/v2/create-transaction-unblock"}]},{"group":"CRM","pages":[{"title":"Provision an Organization for Envelope Encryption","deprecated":null,"version":null,"sidebarTitle":"Provision encryption","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/encryption/provision","href":"/pt/reference/products/midaz/v2/provision-encryption"},{"title":"Get Provisioning Status","deprecated":null,"version":null,"sidebarTitle":"Get provisioning status","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/encryption/status","href":"/pt/reference/products/midaz/v2/get-provisioning-status"},{"title":"List Holders","deprecated":null,"version":null,"sidebarTitle":"List holders","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders","href":"/pt/reference/products/midaz/v2/list-holders"},{"title":"Create a Holder","deprecated":null,"version":null,"sidebarTitle":"Create holder","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders","href":"/pt/reference/products/midaz/v2/create-holder"},{"title":"Create an Instrument Account","deprecated":null,"version":null,"sidebarTitle":"Create instrument","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/holders/{holder_id}/instruments","href":"/pt/reference/products/midaz/v2/create-instrument"},{"title":"Delete an Instrument","deprecated":null,"version":null,"sidebarTitle":"Delete instrument","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/pt/reference/products/midaz/v2/delete-instrument"},{"title":"Retrieve Instrument details","deprecated":null,"version":null,"sidebarTitle":"Get instrument by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/pt/reference/products/midaz/v2/get-instrument-by-id"},{"title":"Update an Instrument","deprecated":null,"version":null,"sidebarTitle":"Update instrument","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}","href":"/pt/reference/products/midaz/v2/update-instrument"},{"title":"Delete a Related Party","deprecated":null,"version":null,"sidebarTitle":"Delete related party","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}/related-parties/{related_party_id}","href":"/pt/reference/products/midaz/v2/delete-related-party"},{"title":"Delete a Holder","deprecated":null,"version":null,"sidebarTitle":"Delete holder","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/holders/{holder_id}","href":"/pt/reference/products/midaz/v2/delete-holder"},{"title":"Retrieve Holder details","deprecated":null,"version":null,"sidebarTitle":"Get holder by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{holder_id}","href":"/pt/reference/products/midaz/v2/get-holder-by-id"},{"title":"Update a Holder","deprecated":null,"version":null,"sidebarTitle":"Update holder","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/holders/{holder_id}","href":"/pt/reference/products/midaz/v2/update-holder"},{"title":"List Accounts by Holder","deprecated":null,"version":null,"sidebarTitle":"List accounts by holder","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/holders/{holder_id}/accounts","href":"/pt/reference/products/midaz/v2/list-accounts-by-holder"},{"title":"List Instruments","deprecated":null,"version":null,"sidebarTitle":"List instruments","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/instruments","href":"/pt/reference/products/midaz/v2/list-instruments"},{"title":"Open a holder-owned account (with optional instrument)","deprecated":null,"version":null,"sidebarTitle":"Create holder account","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts","href":"/pt/reference/products/midaz/v2/create-holder-account"},{"title":"List Protection Audit Events","deprecated":null,"version":null,"sidebarTitle":"Get audit events","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/protection/audit","href":"/pt/reference/products/midaz/v2/get-audit-events"}]},{"group":"Fees","pages":[{"title":"Get all billing packages of a ledger","deprecated":null,"version":null,"sidebarTitle":"Get all billing packages","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages","href":"/pt/reference/products/midaz/v2/get-all-billing-packages"},{"title":"Create a BillingPackage","deprecated":null,"version":null,"sidebarTitle":"Create billing package","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages","href":"/pt/reference/products/midaz/v2/create-billing-package"},{"title":"SoftDelete a BillingPackage by ID","deprecated":null,"version":null,"sidebarTitle":"Delete billing package","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{billing_package_id}","href":"/pt/reference/products/midaz/v2/delete-billing-package"},{"title":"Get billing package","deprecated":null,"version":null,"sidebarTitle":"Get billing package by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{billing_package_id}","href":"/pt/reference/products/midaz/v2/get-billing-package-by-id"},{"title":"Update a billing package","deprecated":null,"version":null,"sidebarTitle":"Update billing package","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing-packages/{billing_package_id}","href":"/pt/reference/products/midaz/v2/update-billing-package"},{"title":"Calculate billing","deprecated":null,"version":null,"sidebarTitle":"Calculate billing","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/billing/calculate","href":"/pt/reference/products/midaz/v2/calculate-billing"},{"title":"Create a fee estimate calculation","deprecated":null,"version":null,"sidebarTitle":"Estimate fee calculation","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/estimates","href":"/pt/reference/products/midaz/v2/estimate-fee-calculation"},{"title":"List the fee debts of a ledger, oldest first","deprecated":null,"version":null,"sidebarTitle":"List the fee debts of a ledger oldest first","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts","href":"/pt/reference/products/midaz/v2/list-the-fee-debts-of-a-ledger-oldest-first"},{"title":"Collect a balance's open fee debts","deprecated":null,"version":null,"sidebarTitle":"Collect a balance s open fee debts","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts/collect","href":"/pt/reference/products/midaz/v2/collect-a-balance-s-open-fee-debts"},{"title":"Get a fee debt","deprecated":null,"version":null,"sidebarTitle":"Get a fee debt","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/fee-debts/{fee_debt_id}","href":"/pt/reference/products/midaz/v2/get-a-fee-debt"},{"title":"Get all packages of a ledger","deprecated":null,"version":null,"sidebarTitle":"Get all packages","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages","href":"/pt/reference/products/midaz/v2/get-all-packages"},{"title":"Create a Package","deprecated":null,"version":null,"sidebarTitle":"Create package","openapi":"/pt/openapi/v3-current/ledger.yaml post /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages","href":"/pt/reference/products/midaz/v2/create-package"},{"title":"SoftDelete a Package by ID","deprecated":null,"version":null,"sidebarTitle":"Delete package","openapi":"/pt/openapi/v3-current/ledger.yaml delete /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}","href":"/pt/reference/products/midaz/v2/delete-package"},{"title":"Get package","deprecated":null,"version":null,"sidebarTitle":"Get package by id","openapi":"/pt/openapi/v3-current/ledger.yaml get /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}","href":"/pt/reference/products/midaz/v2/get-package-by-id"},{"title":"Update a package","deprecated":null,"version":null,"sidebarTitle":"Update package","openapi":"/pt/openapi/v3-current/ledger.yaml patch /v2/organizations/{organization_id}/ledgers/{ledger_id}/packages/{package_id}","href":"/pt/reference/products/midaz/v2/update-package"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Midaz","href":"/pt/reference/products/midaz/error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Midaz","href":"/pt/reference/events/midaz"}]}]},{"version":"v1","tag":"Compatibility","pages":[{"title":"v1","href":"/pt/reference/products/midaz/quick-start-guide"}]}]},{"dropdown":"Tracer","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/tracer-yellow.png","description":"Validação de transações, regras, limites e auditoria","groups":[{"group":"Primeiros passos","pages":[{"title":"Início rápido da API do Tracer","href":"/pt/reference/products/tracer/tracer-api-quick-start"}]},{"group":"API de Validações","pages":[{"title":"Validate a transaction","deprecated":null,"version":null,"sidebarTitle":"Validate transaction","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/validations","href":"/pt/reference/products/tracer/validate-transaction"},{"title":"Validate a transaction by rules only","deprecated":null,"version":null,"sidebarTitle":"Validate transaction by rules only","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/validations/rules-only","href":"/pt/reference/products/tracer/validate-transaction-by-rules-only"},{"title":"List transaction validation records","deprecated":null,"version":null,"sidebarTitle":"List validations","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/validations","href":"/pt/reference/products/tracer/list-validations"},{"title":"Get a transaction validation record by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve validation","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/validations/{validation_id}","href":"/pt/reference/products/tracer/retrieve-validation"}]},{"group":"API de Regras","pages":[{"title":"Create a new fraud rule","deprecated":null,"version":null,"sidebarTitle":"Create rule","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/rules","href":"/pt/reference/products/tracer/create-rule"},{"title":"List fraud rules","deprecated":null,"version":null,"sidebarTitle":"List rules","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/rules","href":"/pt/reference/products/tracer/list-rules"},{"title":"Get a fraud rule by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve rule","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/rules/{rule_id}","href":"/pt/reference/products/tracer/retrieve-rule"},{"title":"Partially update an existing fraud rule","deprecated":null,"version":null,"sidebarTitle":"Update rule","openapi":"/pt/openapi/v3-current/tracer.yaml patch /v1/rules/{rule_id}","href":"/pt/reference/products/tracer/update-rule"},{"title":"Delete a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Delete rule","openapi":"/pt/openapi/v3-current/tracer.yaml delete /v1/rules/{rule_id}","href":"/pt/reference/products/tracer/delete-rule"},{"title":"Activate a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Activate rule","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/rules/{rule_id}/activate","href":"/pt/reference/products/tracer/activate-rule"},{"title":"Deactivate a fraud rule","deprecated":null,"version":null,"sidebarTitle":"Deactivate rule","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/rules/{rule_id}/deactivate","href":"/pt/reference/products/tracer/deactivate-rule"},{"title":"Transition a rule back to draft","deprecated":null,"version":null,"sidebarTitle":"Draft rule","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/rules/{rule_id}/draft","href":"/pt/reference/products/tracer/draft-rule"}]},{"group":"API de Limites","pages":[{"title":"Create a new spending limit","deprecated":null,"version":null,"sidebarTitle":"Create limit","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/limits","href":"/pt/reference/products/tracer/create-limit"},{"title":"List spending limits","deprecated":null,"version":null,"sidebarTitle":"List limits","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/limits","href":"/pt/reference/products/tracer/list-limits"},{"title":"Get a spending limit by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve limit","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/limits/{limit_id}","href":"/pt/reference/products/tracer/retrieve-limit"},{"title":"Partially update an existing spending limit","deprecated":null,"version":null,"sidebarTitle":"Update limit","openapi":"/pt/openapi/v3-current/tracer.yaml patch /v1/limits/{limit_id}","href":"/pt/reference/products/tracer/update-limit"},{"title":"Delete a spending limit","deprecated":null,"version":null,"sidebarTitle":"Delete limit","openapi":"/pt/openapi/v3-current/tracer.yaml delete /v1/limits/{limit_id}","href":"/pt/reference/products/tracer/delete-limit"},{"title":"Activate a spending limit","deprecated":null,"version":null,"sidebarTitle":"Activate limit","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/limits/{limit_id}/activate","href":"/pt/reference/products/tracer/activate-limit"},{"title":"Deactivate a spending limit","deprecated":null,"version":null,"sidebarTitle":"Deactivate limit","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/limits/{limit_id}/deactivate","href":"/pt/reference/products/tracer/deactivate-limit"},{"title":"Transition a limit back to draft","deprecated":null,"version":null,"sidebarTitle":"Draft limit","openapi":"/pt/openapi/v3-current/tracer.yaml post /v1/limits/{limit_id}/draft","href":"/pt/reference/products/tracer/draft-limit"},{"title":"Get usage snapshot for a limit","deprecated":null,"version":null,"sidebarTitle":"Retrieve limit usage","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/limits/{limit_id}/usage","href":"/pt/reference/products/tracer/retrieve-limit-usage"}]},{"group":"API de Eventos de Auditoria","pages":[{"title":"List audit events","deprecated":null,"version":null,"sidebarTitle":"List audit events","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/audit-events","href":"/pt/reference/products/tracer/list-audit-events"},{"title":"Get an audit event by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve audit event","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/audit-events/{audit_event_id}","href":"/pt/reference/products/tracer/retrieve-audit-event"},{"title":"Verify audit event hash chain integrity","deprecated":null,"version":null,"sidebarTitle":"Verify audit event","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/audit-events/{audit_event_id}/verify","href":"/pt/reference/products/tracer/verify-audit-event"}]},{"group":"API de Dashboards","pages":[{"title":"Get dashboard flagged-traffic breakdown","deprecated":null,"version":null,"sidebarTitle":"Get dashboard fraud types","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/dashboard/fraud-types","href":"/pt/reference/products/tracer/get-dashboard-fraud-types"},{"title":"Get dashboard headline metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/dashboard/metrics","href":"/pt/reference/products/tracer/get-dashboard-metrics"},{"title":"Get the busiest rules in the window","deprecated":null,"version":null,"sidebarTitle":"Get dashboard top rules","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/dashboard/top-rules","href":"/pt/reference/products/tracer/get-dashboard-top-rules"},{"title":"Get dashboard volume series","deprecated":null,"version":null,"sidebarTitle":"Get dashboard volume","openapi":"/pt/openapi/v3-current/tracer.yaml get /v1/dashboard/volume","href":"/pt/reference/products/tracer/get-dashboard-volume"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Tracer","href":"/pt/reference/products/tracer/tracer-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Tracer","href":"/pt/reference/events/tracer"}]}]},{"dropdown":"Matcher","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/matcher-yellow.png","description":"Conciliação, regras de correspondência e exceções","groups":[{"group":"Primeiros passos","pages":[{"title":"Início rápido da API do Matcher","href":"/pt/reference/products/matcher/matcher-developer-quick-start"}]},{"group":"API de Contextos de Configuração","pages":[{"title":"List reconciliation contexts","deprecated":null,"version":null,"sidebarTitle":"List contexts","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts","href":"/pt/reference/products/matcher/list-contexts"},{"title":"Create a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Create context","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts","href":"/pt/reference/products/matcher/create-context"},{"title":"Get a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Retrieve context","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}","href":"/pt/reference/products/matcher/retrieve-context"},{"title":"Update a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Update context","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}","href":"/pt/reference/products/matcher/update-context"},{"title":"Clone a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Clone context","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/clone","href":"/pt/reference/products/matcher/clone-context"},{"title":"Get context setup progress","deprecated":null,"version":null,"sidebarTitle":"Get setup progress","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/setup-progress","href":"/pt/reference/products/matcher/get-setup-progress"},{"title":"Archive a reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Archive context","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/archive","href":"/pt/reference/products/matcher/archive-context"},{"title":"Restore an archived reconciliation context","deprecated":null,"version":null,"sidebarTitle":"Restore context","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/restore","href":"/pt/reference/products/matcher/restore-context"}]},{"group":"API de Regras de Correspondência","pages":[{"title":"List match rules","deprecated":null,"version":null,"sidebarTitle":"List match rules","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/rules","href":"/pt/reference/products/matcher/list-match-rules"},{"title":"Create a match rule","deprecated":null,"version":null,"sidebarTitle":"Create match rule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/rules","href":"/pt/reference/products/matcher/create-match-rule"},{"title":"Get a match rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve match rule","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/rules/{ruleId}","href":"/pt/reference/products/matcher/retrieve-match-rule"},{"title":"Update a match rule","deprecated":null,"version":null,"sidebarTitle":"Update match rule","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/rules/{ruleId}","href":"/pt/reference/products/matcher/update-match-rule"},{"title":"Delete a match rule","deprecated":null,"version":null,"sidebarTitle":"Delete match rule","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/rules/{ruleId}","href":"/pt/reference/products/matcher/delete-match-rule"},{"title":"Reorder match rules","deprecated":null,"version":null,"sidebarTitle":"Reorder match rules","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/rules/reorder","href":"/pt/reference/products/matcher/reorder-match-rules"}]},{"group":"API de Fontes de Dados","pages":[{"title":"List reconciliation sources","deprecated":null,"version":null,"sidebarTitle":"List sources","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources","href":"/pt/reference/products/matcher/list-sources"},{"title":"Create a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Create source","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources","href":"/pt/reference/products/matcher/create-source"},{"title":"Get a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Retrieve source","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}","href":"/pt/reference/products/matcher/retrieve-source"},{"title":"Update a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Update source","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/sources/{sourceId}","href":"/pt/reference/products/matcher/update-source"},{"title":"Delete a source binding","deprecated":null,"version":null,"sidebarTitle":"Delete source binding","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/pt/reference/products/matcher/delete-source-binding"},{"title":"List source bindings","deprecated":null,"version":null,"sidebarTitle":"List source bindings","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/bindings","href":"/pt/reference/products/matcher/list-source-bindings"},{"title":"Get a source binding","deprecated":null,"version":null,"sidebarTitle":"Get source binding","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/pt/reference/products/matcher/get-source-binding"},{"title":"Update a source binding","deprecated":null,"version":null,"sidebarTitle":"Update source binding","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}","href":"/pt/reference/products/matcher/update-source-binding"},{"title":"Archive a reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Archive source","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/archive","href":"/pt/reference/products/matcher/archive-source"},{"title":"Create a source binding","deprecated":null,"version":null,"sidebarTitle":"Create source binding","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/bindings","href":"/pt/reference/products/matcher/create-source-binding"},{"title":"Restore an archived reconciliation source","deprecated":null,"version":null,"sidebarTitle":"Restore source","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/restore","href":"/pt/reference/products/matcher/restore-source"}]},{"group":"API de Mapeamento de Campos","pages":[{"title":"Get a field map by source","deprecated":null,"version":null,"sidebarTitle":"Retrieve field map by source","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/sources/{sourceId}/field-maps","href":"/pt/reference/products/matcher/retrieve-field-map-by-source"},{"title":"Create a field map","deprecated":null,"version":null,"sidebarTitle":"Create field map","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/sources/{sourceId}/field-maps","href":"/pt/reference/products/matcher/create-field-map"},{"title":"Update a field map","deprecated":null,"version":null,"sidebarTitle":"Update field map","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/field-maps/{fieldMapId}","href":"/pt/reference/products/matcher/update-field-map"},{"title":"Delete a field map","deprecated":null,"version":null,"sidebarTitle":"Delete field map","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/field-maps/{fieldMapId}","href":"/pt/reference/products/matcher/delete-field-map"},{"title":"List field maps for a context","deprecated":null,"version":null,"sidebarTitle":"List context field maps","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/field-maps","href":"/pt/reference/products/matcher/list-context-field-maps"}]},{"group":"API de Tabelas de Tarifas","pages":[{"title":"List fee schedules","deprecated":null,"version":null,"sidebarTitle":"List fee schedules","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/fee-schedules","href":"/pt/reference/products/matcher/list-fee-schedules"},{"title":"Create a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Create fee schedule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/fee-schedules","href":"/pt/reference/products/matcher/create-fee-schedule"},{"title":"Get a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Retrieve fee schedule","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/fee-schedules/{scheduleId}","href":"/pt/reference/products/matcher/retrieve-fee-schedule"},{"title":"Update a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Update fee schedule","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/fee-schedules/{scheduleId}","href":"/pt/reference/products/matcher/update-fee-schedule"},{"title":"Delete a fee schedule","deprecated":null,"version":null,"sidebarTitle":"Delete fee schedule","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/fee-schedules/{scheduleId}","href":"/pt/reference/products/matcher/delete-fee-schedule"},{"title":"Simulate fee calculation","deprecated":null,"version":null,"sidebarTitle":"Simulate fee schedule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/fee-schedules/{scheduleId}/simulate","href":"/pt/reference/products/matcher/simulate-fee-schedule"}]},{"group":"API de Configuração de Regras de Tarifas","pages":[{"title":"List fee rules","deprecated":null,"version":null,"sidebarTitle":"List fee rules","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/fee-rules","href":"/pt/reference/products/matcher/list-fee-rules"},{"title":"Create a fee rule","deprecated":null,"version":null,"sidebarTitle":"Create fee rule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/fee-rules","href":"/pt/reference/products/matcher/create-fee-rule"},{"title":"Get a fee rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve fee rule","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/fee-rules/{feeRuleId}","href":"/pt/reference/products/matcher/retrieve-fee-rule"},{"title":"Update a fee rule","deprecated":null,"version":null,"sidebarTitle":"Update fee rule","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/fee-rules/{feeRuleId}","href":"/pt/reference/products/matcher/update-fee-rule"},{"title":"Delete a fee rule","deprecated":null,"version":null,"sidebarTitle":"Delete fee rule","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/fee-rules/{feeRuleId}","href":"/pt/reference/products/matcher/delete-fee-rule"}]},{"group":"API de Agendamentos","pages":[{"title":"List schedules for a context","deprecated":null,"version":null,"sidebarTitle":"List schedules","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/schedules","href":"/pt/reference/products/matcher/list-schedules"},{"title":"Create a schedule","deprecated":null,"version":null,"sidebarTitle":"Create schedule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/schedules","href":"/pt/reference/products/matcher/create-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"sidebarTitle":"Retrieve schedule","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/pt/reference/products/matcher/retrieve-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"sidebarTitle":"Update schedule","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/pt/reference/products/matcher/update-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"sidebarTitle":"Delete schedule","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/contexts/{contextId}/schedules/{scheduleId}","href":"/pt/reference/products/matcher/delete-schedule"}]},{"group":"Fluxo de exceções","pages":[{"title":"List exceptions","deprecated":null,"version":null,"sidebarTitle":"List exceptions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions","href":"/pt/reference/products/matcher/list-exceptions"},{"title":"Get exception","deprecated":null,"version":null,"sidebarTitle":"Retrieve exception","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}","href":"/pt/reference/products/matcher/retrieve-exception"},{"title":"Get exception history","deprecated":null,"version":null,"sidebarTitle":"Retrieve exception history","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}/history","href":"/pt/reference/products/matcher/retrieve-exception-history"},{"title":"Adjust entry for an exception","deprecated":null,"version":null,"sidebarTitle":"Adjust entry exception","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/adjust-entry","href":"/pt/reference/products/matcher/adjust-entry-exception"},{"title":"Dispatch exception to external system","deprecated":null,"version":null,"sidebarTitle":"Dispatch exception","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/dispatch","href":"/pt/reference/products/matcher/dispatch-exception"},{"title":"Force match an exception","deprecated":null,"version":null,"sidebarTitle":"Force match exception","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/force-match","href":"/pt/reference/products/matcher/force-match-exception"},{"title":"Process exception callback","deprecated":null,"version":null,"sidebarTitle":"Process exception callback","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/callback","href":"/pt/reference/products/matcher/process-exception-callback"},{"title":"Assign an exception","deprecated":null,"version":null,"sidebarTitle":"Assign exception","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/assign","href":"/pt/reference/products/matcher/assign-exception"},{"title":"Resolve an exception","deprecated":null,"version":null,"sidebarTitle":"Resolve exception","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/resolve","href":"/pt/reference/products/matcher/resolve-exception"}]},{"group":"Ações em massa","pages":[{"title":"Bulk assign exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk assign exceptions","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/assign","href":"/pt/reference/products/matcher/bulk-assign-exceptions"},{"title":"Bulk resolve exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk resolve exceptions","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/resolve","href":"/pt/reference/products/matcher/bulk-resolve-exceptions"},{"title":"Bulk dispatch exceptions","deprecated":null,"version":null,"sidebarTitle":"Bulk dispatch exceptions","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/bulk/dispatch","href":"/pt/reference/products/matcher/bulk-dispatch-exceptions"},{"title":"Select exception ids by filter","deprecated":null,"version":null,"sidebarTitle":"Select exception ids","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions/ids","href":"/pt/reference/products/matcher/select-exception-ids"}]},{"group":"Comentários","pages":[{"title":"List exception comments","deprecated":null,"version":null,"sidebarTitle":"List exception comments","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions/{exceptionId}/comments","href":"/pt/reference/products/matcher/list-exception-comments"},{"title":"Add a comment to an exception","deprecated":null,"version":null,"sidebarTitle":"Add exception comment","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/comments","href":"/pt/reference/products/matcher/add-exception-comment"},{"title":"Delete an exception comment","deprecated":null,"version":null,"sidebarTitle":"Delete exception comment","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/exceptions/{exceptionId}/comments/{commentId}","href":"/pt/reference/products/matcher/delete-exception-comment"}]},{"group":"Credenciais de callback","pages":[{"title":"Revoke a callback credential","deprecated":null,"version":null,"sidebarTitle":"Revoke callback credential","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/exceptions/callbacks/credentials/{credentialId}","href":"/pt/reference/products/matcher/revoke-callback-credential"},{"title":"List callback credentials","deprecated":null,"version":null,"sidebarTitle":"List callback credentials","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/exceptions/callbacks/credentials","href":"/pt/reference/products/matcher/list-callback-credentials"},{"title":"Mint a callback credential","deprecated":null,"version":null,"sidebarTitle":"Mint callback credential","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/callbacks/credentials","href":"/pt/reference/products/matcher/mint-callback-credential"},{"title":"Rotate a callback credential","deprecated":null,"version":null,"sidebarTitle":"Rotate callback credential","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/callbacks/credentials/{credentialId}/rotate","href":"/pt/reference/products/matcher/rotate-callback-credential"}]},{"group":"API de Disputas","pages":[{"title":"List disputes","deprecated":null,"version":null,"sidebarTitle":"List disputes","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/disputes","href":"/pt/reference/products/matcher/list-disputes"},{"title":"Get a dispute","deprecated":null,"version":null,"sidebarTitle":"Retrieve dispute","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/disputes/{disputeId}","href":"/pt/reference/products/matcher/retrieve-dispute"},{"title":"Open a dispute","deprecated":null,"version":null,"sidebarTitle":"Open dispute","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/exceptions/{exceptionId}/disputes","href":"/pt/reference/products/matcher/open-dispute"},{"title":"Close a dispute","deprecated":null,"version":null,"sidebarTitle":"Close dispute","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/close","href":"/pt/reference/products/matcher/close-dispute"},{"title":"Submit evidence to a dispute","deprecated":null,"version":null,"sidebarTitle":"Submit evidence","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/evidence","href":"/pt/reference/products/matcher/submit-evidence"},{"title":"Upload an evidence file to a dispute","deprecated":null,"version":null,"sidebarTitle":"Upload evidence","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/disputes/{disputeId}/evidence/upload","href":"/pt/reference/products/matcher/upload-evidence"}]},{"group":"API de Jobs de Exportação","pages":[{"title":"Create an export job","deprecated":null,"version":null,"sidebarTitle":"Create export job","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/contexts/{contextId}/export-jobs","href":"/pt/reference/products/matcher/create-export-job"},{"title":"List export jobs","deprecated":null,"version":null,"sidebarTitle":"List export jobs","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/export-jobs","href":"/pt/reference/products/matcher/list-export-jobs"},{"title":"List export jobs by context","deprecated":null,"version":null,"sidebarTitle":"List export jobs by context","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/export-jobs","href":"/pt/reference/products/matcher/list-export-jobs-by-context"},{"title":"Get export job status","deprecated":null,"version":null,"sidebarTitle":"Retrieve export job","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/export-jobs/{jobId}","href":"/pt/reference/products/matcher/retrieve-export-job"},{"title":"Cancel an export job","deprecated":null,"version":null,"sidebarTitle":"Cancel export job","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/export-jobs/{jobId}/cancel","href":"/pt/reference/products/matcher/cancel-export-job"},{"title":"Download export file","deprecated":null,"version":null,"sidebarTitle":"Download export job","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/export-jobs/{jobId}/download","href":"/pt/reference/products/matcher/download-export-job"}]},{"group":"API de Governança","pages":[{"title":"List audit logs","deprecated":null,"version":null,"sidebarTitle":"List audit logs","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs","href":"/pt/reference/products/matcher/list-audit-logs"},{"title":"Get audit log by ID","deprecated":null,"version":null,"sidebarTitle":"Retrieve audit log","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs/{id}","href":"/pt/reference/products/matcher/retrieve-audit-log"},{"title":"List audit logs by entity","deprecated":null,"version":null,"sidebarTitle":"List audit logs by entity","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/entities/{entityType}/{entityId}/audit-logs","href":"/pt/reference/products/matcher/list-audit-logs-by-entity"},{"title":"Upsert an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Upsert actor mapping","openapi":"/pt/openapi/v3-current/matcher.yaml put /v1/governance/actor-mappings/{actorId}","href":"/pt/reference/products/matcher/upsert-actor-mapping"},{"title":"Get an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Get actor mapping","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/actor-mappings/{actorId}","href":"/pt/reference/products/matcher/get-actor-mapping"},{"title":"Delete an actor mapping","deprecated":null,"version":null,"sidebarTitle":"Delete actor mapping","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/governance/actor-mappings/{actorId}","href":"/pt/reference/products/matcher/delete-actor-mapping"},{"title":"Pseudonymize an actor","deprecated":null,"version":null,"sidebarTitle":"Pseudonymize actor","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/governance/actor-mappings/{actorId}/pseudonymize","href":"/pt/reference/products/matcher/pseudonymize-actor"},{"title":"List audit log archives","deprecated":null,"version":null,"sidebarTitle":"List archives","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/archives","href":"/pt/reference/products/matcher/list-archives"},{"title":"Download an audit log archive","deprecated":null,"version":null,"sidebarTitle":"Download archive","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/archives/{id}/download","href":"/pt/reference/products/matcher/download-archive"},{"title":"List actor mappings","deprecated":null,"version":null,"sidebarTitle":"List actor mappings","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/actor-mappings","href":"/pt/reference/products/matcher/list-actor-mappings"},{"title":"Verify audit log chain integrity","deprecated":null,"version":null,"sidebarTitle":"Verify audit log chain","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/governance/audit-logs/verify","href":"/pt/reference/products/matcher/verify-audit-log-chain"}]},{"group":"Jobs de ingestão","pages":[{"title":"List ingestion jobs for a context","deprecated":null,"version":null,"sidebarTitle":"List ingestion jobs","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs","href":"/pt/reference/products/matcher/list-ingestion-jobs"},{"title":"Get ingestion job status","deprecated":null,"version":null,"sidebarTitle":"Retrieve ingestion job","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}","href":"/pt/reference/products/matcher/retrieve-ingestion-job"},{"title":"List transactions for a job","deprecated":null,"version":null,"sidebarTitle":"List job transactions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}/transactions","href":"/pt/reference/products/matcher/list-job-transactions"},{"title":"Upload transaction file","deprecated":null,"version":null,"sidebarTitle":"Upload transaction file","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/upload","href":"/pt/reference/products/matcher/upload-transaction-file"},{"title":"Ignore a transaction","deprecated":null,"version":null,"sidebarTitle":"Ignore transaction","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/transactions/{transactionId}/ignore","href":"/pt/reference/products/matcher/ignore-transaction"},{"title":"Preview a transaction file","deprecated":null,"version":null,"sidebarTitle":"Preview upload","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/preview","href":"/pt/reference/products/matcher/preview-upload"},{"title":"Search transactions","deprecated":null,"version":null,"sidebarTitle":"Search transactions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/transactions/search","href":"/pt/reference/products/matcher/search-transactions"},{"title":"List per-row import errors for a job","deprecated":null,"version":null,"sidebarTitle":"List ingestion job errors","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/jobs/{jobId}/errors","href":"/pt/reference/products/matcher/list-ingestion-job-errors"}]},{"group":"Layouts e formatos","pages":[{"title":"Delete an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Delete layout template","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/imports/formats/templates/{templateId}","href":"/pt/reference/products/matcher/delete-layout-template"},{"title":"Browse the supported format catalog","deprecated":null,"version":null,"sidebarTitle":"Browse format catalog","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/formats","href":"/pt/reference/products/matcher/browse-format-catalog"},{"title":"List operator fixed-width layout templates","deprecated":null,"version":null,"sidebarTitle":"List layout templates","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/formats/templates","href":"/pt/reference/products/matcher/list-layout-templates"},{"title":"Get an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Get layout template","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/formats/templates/{templateId}","href":"/pt/reference/products/matcher/get-layout-template"},{"title":"Propose a config-only field-map/dialect mapping for a source sample","deprecated":null,"version":null,"sidebarTitle":"Propose mapping","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/mapping-proposal","href":"/pt/reference/products/matcher/propose-mapping"},{"title":"Submit an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Submit layout template","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/formats/templates","href":"/pt/reference/products/matcher/submit-layout-template"},{"title":"Replace an operator fixed-width layout template","deprecated":null,"version":null,"sidebarTitle":"Update layout template","openapi":"/pt/openapi/v3-current/matcher.yaml put /v1/imports/formats/templates/{templateId}","href":"/pt/reference/products/matcher/update-layout-template"}]},{"group":"Revisões de extração","pages":[{"title":"List AI extraction reviews (the human-review queue)","deprecated":null,"version":null,"sidebarTitle":"List extraction reviews","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/extraction-reviews","href":"/pt/reference/products/matcher/list-extraction-reviews"},{"title":"Get a single AI extraction review","deprecated":null,"version":null,"sidebarTitle":"Get extraction review","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}","href":"/pt/reference/products/matcher/get-extraction-review"},{"title":"Approve an AI extraction review (ingest the candidates)","deprecated":null,"version":null,"sidebarTitle":"Approve extraction review","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}/approve","href":"/pt/reference/products/matcher/approve-extraction-review"},{"title":"Reject an AI extraction review (discard the candidates)","deprecated":null,"version":null,"sidebarTitle":"Reject extraction review","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/extraction-reviews/{reviewId}/reject","href":"/pt/reference/products/matcher/reject-extraction-review"}]},{"group":"Extração de documentos","pages":[{"title":"Enqueue a document for AI extraction (human-review required)","deprecated":null,"version":null,"sidebarTitle":"Extract document","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/extract-document","href":"/pt/reference/products/matcher/extract-document"},{"title":"Trigger a manual fetch-and-ingest from an external transport","deprecated":null,"version":null,"sidebarTitle":"Fetch trigger","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/imports/contexts/{contextId}/sources/{sourceId}/fetch","href":"/pt/reference/products/matcher/fetch-trigger"}]},{"group":"Execuções de correspondência","pages":[{"title":"Trigger a matching run","deprecated":null,"version":null,"sidebarTitle":"Run match","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/run","href":"/pt/reference/products/matcher/run-match"},{"title":"List match runs","deprecated":null,"version":null,"sidebarTitle":"List match runs","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/runs","href":"/pt/reference/products/matcher/list-match-runs"},{"title":"Get match run","deprecated":null,"version":null,"sidebarTitle":"Retrieve match run","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}","href":"/pt/reference/products/matcher/retrieve-match-run"},{"title":"Get match run results","deprecated":null,"version":null,"sidebarTitle":"List match run groups","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}/groups","href":"/pt/reference/products/matcher/list-match-run-groups"}]},{"group":"Correspondência manual e ajustes","pages":[{"title":"Create a manual match","deprecated":null,"version":null,"sidebarTitle":"Create manual match","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/manual","href":"/pt/reference/products/matcher/create-manual-match"},{"title":"Break/Unmatch a match group","deprecated":null,"version":null,"sidebarTitle":"Unmatch group","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/matching/groups/{matchGroupId}","href":"/pt/reference/products/matcher/unmatch-group"},{"title":"Create an adjustment","deprecated":null,"version":null,"sidebarTitle":"Create adjustment","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/adjustments","href":"/pt/reference/products/matcher/create-adjustment"},{"title":"List recorded adjustments","deprecated":null,"version":null,"sidebarTitle":"List recorded adjustments","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/adjustments","href":"/pt/reference/products/matcher/list-recorded-adjustments"}]},{"group":"Candidatos e itens em aberto","pages":[{"title":"List match candidates for a transaction","deprecated":null,"version":null,"sidebarTitle":"List match candidates","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/candidates","href":"/pt/reference/products/matcher/list-match-candidates"},{"title":"List open items","deprecated":null,"version":null,"sidebarTitle":"List open items","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/open-items","href":"/pt/reference/products/matcher/list-open-items"}]},{"group":"Sugestões de regras","pages":[{"title":"List AI match-rule suggestions (the human-review queue)","deprecated":null,"version":null,"sidebarTitle":"List match rule suggestions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/rule-suggestions","href":"/pt/reference/products/matcher/list-match-rule-suggestions"},{"title":"Produce AI match-rule suggestions (human-review required)","deprecated":null,"version":null,"sidebarTitle":"Suggest match rules","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions","href":"/pt/reference/products/matcher/suggest-match-rules"},{"title":"Approve an AI match-rule suggestion (create the rule)","deprecated":null,"version":null,"sidebarTitle":"Approve match rule suggestion","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions/{suggestionId}/approve","href":"/pt/reference/products/matcher/approve-match-rule-suggestion"},{"title":"Reject an AI match-rule suggestion (discard it)","deprecated":null,"version":null,"sidebarTitle":"Reject match rule suggestion","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/contexts/{contextId}/rule-suggestions/{suggestionId}/reject","href":"/pt/reference/products/matcher/reject-match-rule-suggestion"},{"title":"Simulate a match rule against a context (read-only dry run)","deprecated":null,"version":null,"sidebarTitle":"Simulate match rule","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/matching/simulate","href":"/pt/reference/products/matcher/simulate-match-rule"}]},{"group":"Painel e métricas","pages":[{"title":"Get all dashboard aggregates","deprecated":null,"version":null,"sidebarTitle":"Get dashboard aggregates","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard","href":"/pt/reference/products/matcher/get-dashboard-aggregates"},{"title":"Get comprehensive dashboard metrics","deprecated":null,"version":null,"sidebarTitle":"Get dashboard metrics","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/metrics","href":"/pt/reference/products/matcher/get-dashboard-metrics"},{"title":"Get match rate statistics","deprecated":null,"version":null,"sidebarTitle":"Get match rate stats","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/match-rate","href":"/pt/reference/products/matcher/get-match-rate-stats"},{"title":"Get SLA statistics","deprecated":null,"version":null,"sidebarTitle":"Get sla stats","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/sla","href":"/pt/reference/products/matcher/get-sla-stats"},{"title":"Get volume statistics","deprecated":null,"version":null,"sidebarTitle":"Get volume stats","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/volume","href":"/pt/reference/products/matcher/get-volume-stats"},{"title":"Get source breakdown","deprecated":null,"version":null,"sidebarTitle":"Get source breakdown","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/source-breakdown","href":"/pt/reference/products/matcher/get-source-breakdown"},{"title":"Get cash impact summary","deprecated":null,"version":null,"sidebarTitle":"Get cash impact","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/dashboard/cash-impact","href":"/pt/reference/products/matcher/get-cash-impact"},{"title":"Count matches","deprecated":null,"version":null,"sidebarTitle":"Count matches","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matches/count","href":"/pt/reference/products/matcher/count-matches"},{"title":"Count transactions","deprecated":null,"version":null,"sidebarTitle":"Count transactions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/transactions/count","href":"/pt/reference/products/matcher/count-transactions"},{"title":"Count exceptions","deprecated":null,"version":null,"sidebarTitle":"Count exceptions","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/exceptions/count","href":"/pt/reference/products/matcher/count-exceptions"},{"title":"Count unmatched items","deprecated":null,"version":null,"sidebarTitle":"Count unmatched","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched/count","href":"/pt/reference/products/matcher/count-unmatched"}]},{"group":"Relatórios","pages":[{"title":"List matched transactions report","deprecated":null,"version":null,"sidebarTitle":"List matched report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matched","href":"/pt/reference/products/matcher/list-matched-report"},{"title":"List unmatched transactions report","deprecated":null,"version":null,"sidebarTitle":"List unmatched report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched","href":"/pt/reference/products/matcher/list-unmatched-report"},{"title":"Get reconciliation summary report","deprecated":null,"version":null,"sidebarTitle":"Get summary report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/summary","href":"/pt/reference/products/matcher/get-summary-report"},{"title":"List variance report","deprecated":null,"version":null,"sidebarTitle":"List variance report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/variance","href":"/pt/reference/products/matcher/list-variance-report"}]},{"group":"Exportações","pages":[{"title":"Export matched transactions report","deprecated":null,"version":null,"sidebarTitle":"Export matched report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/matched/export","href":"/pt/reference/products/matcher/export-matched-report"},{"title":"Export unmatched transactions report","deprecated":null,"version":null,"sidebarTitle":"Export unmatched report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/unmatched/export","href":"/pt/reference/products/matcher/export-unmatched-report"},{"title":"Export summary report","deprecated":null,"version":null,"sidebarTitle":"Export summary report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/summary/export","href":"/pt/reference/products/matcher/export-summary-report"},{"title":"Export variance report","deprecated":null,"version":null,"sidebarTitle":"Export variance report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/variance/export","href":"/pt/reference/products/matcher/export-variance-report"},{"title":"Export exceptions report","deprecated":null,"version":null,"sidebarTitle":"Export exceptions report","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/reports/contexts/{contextId}/exceptions/export","href":"/pt/reference/products/matcher/export-exceptions-report"}]},{"group":"Status da descoberta","pages":[{"title":"Get discovery status","deprecated":null,"version":null,"sidebarTitle":"Discovery status","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/status","href":"/pt/reference/products/matcher/discovery-status"}]},{"group":"Conexões de descoberta","pages":[{"title":"List discovered connections","deprecated":null,"version":null,"sidebarTitle":"List discovery connections","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/connections","href":"/pt/reference/products/matcher/list-discovery-connections"},{"title":"Get a discovered connection","deprecated":null,"version":null,"sidebarTitle":"Retrieve discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}","href":"/pt/reference/products/matcher/retrieve-discovery-connection"},{"title":"Get connection schema","deprecated":null,"version":null,"sidebarTitle":"Get connection schema","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}/schema","href":"/pt/reference/products/matcher/get-connection-schema"},{"title":"Get connection schema history","deprecated":null,"version":null,"sidebarTitle":"Get connection schema history","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/connections/{connectionId}/schema/history","href":"/pt/reference/products/matcher/get-connection-schema-history"},{"title":"Test a connection","deprecated":null,"version":null,"sidebarTitle":"Test discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/connections/{connectionId}/test","href":"/pt/reference/products/matcher/test-discovery-connection"},{"title":"Refresh discovery","deprecated":null,"version":null,"sidebarTitle":"Refresh discovery","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/refresh","href":"/pt/reference/products/matcher/refresh-discovery"},{"title":"Delete discovery connection","deprecated":null,"version":null,"sidebarTitle":"Delete discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/discovery/connections/{connectionId}","href":"/pt/reference/products/matcher/delete-discovery-connection"},{"title":"List connector types","deprecated":null,"version":null,"sidebarTitle":"List discovery connector types","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/connector-types","href":"/pt/reference/products/matcher/list-discovery-connector-types"},{"title":"Update discovery connection","deprecated":null,"version":null,"sidebarTitle":"Update discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml patch /v1/discovery/connections/{connectionId}","href":"/pt/reference/products/matcher/update-discovery-connection"},{"title":"Create discovery connection","deprecated":null,"version":null,"sidebarTitle":"Create discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/connections","href":"/pt/reference/products/matcher/create-discovery-connection"},{"title":"Create REST discovery connection","deprecated":null,"version":null,"sidebarTitle":"Create rest discovery connection","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/rest-connections","href":"/pt/reference/products/matcher/create-rest-discovery-connection"}]},{"group":"Extrações","pages":[{"title":"Start a connection extraction","deprecated":null,"version":null,"sidebarTitle":"Create extraction","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/connections/{connectionId}/extractions","href":"/pt/reference/products/matcher/create-extraction"},{"title":"Get an extraction request","deprecated":null,"version":null,"sidebarTitle":"Retrieve extraction","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/extractions/{extractionId}","href":"/pt/reference/products/matcher/retrieve-extraction"}]},{"group":"Conexões de agregadores","pages":[{"title":"Delete aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Delete aggregator connection","openapi":"/pt/openapi/v3-current/matcher.yaml delete /v1/discovery/aggregator-connections/{id}","href":"/pt/reference/products/matcher/delete-aggregator-connection"},{"title":"List aggregator connections","deprecated":null,"version":null,"sidebarTitle":"List aggregator connections","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/aggregator-connections","href":"/pt/reference/products/matcher/list-aggregator-connections"},{"title":"Get aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Get aggregator connection","openapi":"/pt/openapi/v3-current/matcher.yaml get /v1/discovery/aggregator-connections/{id}","href":"/pt/reference/products/matcher/get-aggregator-connection"},{"title":"Create aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Create aggregator connection","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections","href":"/pt/reference/products/matcher/create-aggregator-connection"},{"title":"Test aggregator connection credentials","deprecated":null,"version":null,"sidebarTitle":"Test aggregator connection","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections/test","href":"/pt/reference/products/matcher/test-aggregator-connection"},{"title":"Mint aggregator consent token","deprecated":null,"version":null,"sidebarTitle":"Mint aggregator consent token","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections/{id}/connect-token","href":"/pt/reference/products/matcher/mint-aggregator-consent-token"},{"title":"Update aggregator connection","deprecated":null,"version":null,"sidebarTitle":"Update aggregator connection","openapi":"/pt/openapi/v3-current/matcher.yaml put /v1/discovery/aggregator-connections/{id}","href":"/pt/reference/products/matcher/update-aggregator-connection"}]},{"group":"Webhooks de agregadores","pages":[{"title":"Receive an aggregator webhook","deprecated":null,"version":null,"sidebarTitle":"Receive aggregator webhook","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/webhooks/{provider}/{webhookToken}","href":"/pt/reference/products/matcher/receive-aggregator-webhook"},{"title":"Mint an aggregator webhook token","deprecated":null,"version":null,"sidebarTitle":"Mint aggregator webhook token","openapi":"/pt/openapi/v3-current/matcher.yaml post /v1/discovery/webhooks/tokens","href":"/pt/reference/products/matcher/mint-aggregator-webhook-token"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Matcher","href":"/pt/reference/products/matcher/matcher-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Matcher","href":"/pt/reference/events/matcher"}]}]},{"dropdown":"Flowker","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/flowker-yellow.png","description":"Catálogo de workflows, execuções e agendamentos","groups":[{"group":"API de Catálogo","pages":[{"title":"List Catalog Executors","deprecated":null,"version":null,"sidebarTitle":"List catalog executors","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/executors","href":"/pt/reference/products/flowker/list-catalog-executors"},{"title":"Get a Catalog Executor","deprecated":null,"version":null,"sidebarTitle":"Get catalog executor","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/executors/{id}","href":"/pt/reference/products/flowker/get-catalog-executor"},{"title":"Validate a Node Configuration","deprecated":null,"version":null,"sidebarTitle":"Validate executor config","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/catalog/executors/{id}/validate","href":"/pt/reference/products/flowker/validate-executor-config"},{"title":"List Catalog Providers","deprecated":null,"version":null,"sidebarTitle":"List catalog providers","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/providers","href":"/pt/reference/products/flowker/list-catalog-providers"},{"title":"Get a Catalog Provider","deprecated":null,"version":null,"sidebarTitle":"Get catalog provider","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/providers/{id}","href":"/pt/reference/products/flowker/get-catalog-provider"},{"title":"List Executors by Provider","deprecated":null,"version":null,"sidebarTitle":"List executors by provider","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/providers/{id}/executors","href":"/pt/reference/products/flowker/list-executors-by-provider"},{"title":"List Catalog Triggers","deprecated":null,"version":null,"sidebarTitle":"List catalog triggers","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/triggers","href":"/pt/reference/products/flowker/list-catalog-triggers"},{"title":"Get a Catalog Trigger","deprecated":null,"version":null,"sidebarTitle":"Get catalog trigger","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/triggers/{id}","href":"/pt/reference/products/flowker/get-catalog-trigger"},{"title":"List Catalog Templates","deprecated":null,"version":null,"sidebarTitle":"List catalog templates","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/templates","href":"/pt/reference/products/flowker/list-catalog-templates"},{"title":"Get a Catalog Template","deprecated":null,"version":null,"sidebarTitle":"Get catalog template","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/templates/{id}","href":"/pt/reference/products/flowker/get-catalog-template"},{"title":"Validate Catalog Template Parameters","deprecated":null,"version":null,"sidebarTitle":"Validate catalog template params","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/catalog/templates/{id}/validate","href":"/pt/reference/products/flowker/validate-catalog-template-params"}]},{"group":"API de Workflows","pages":[{"title":"List Workflows","deprecated":null,"version":null,"sidebarTitle":"List workflows","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows","href":"/pt/reference/products/flowker/list-workflows"},{"title":"Create a Workflow","deprecated":null,"version":null,"sidebarTitle":"Create workflow","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows","href":"/pt/reference/products/flowker/create-workflow"},{"title":"Get a Workflow","deprecated":null,"version":null,"sidebarTitle":"Get workflow","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows/{id}","href":"/pt/reference/products/flowker/get-workflow"},{"title":"Update a Workflow","deprecated":null,"version":null,"sidebarTitle":"Update workflow","openapi":"/pt/openapi/v3-current/flowker.yaml put /v1/workflows/{id}","href":"/pt/reference/products/flowker/update-workflow"},{"title":"Delete a Workflow","deprecated":null,"version":null,"sidebarTitle":"Delete workflow","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/workflows/{id}","href":"/pt/reference/products/flowker/delete-workflow"},{"title":"Activate a Workflow","deprecated":null,"version":null,"sidebarTitle":"Activate workflow","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/activate","href":"/pt/reference/products/flowker/activate-workflow"},{"title":"Deactivate a Workflow","deprecated":null,"version":null,"sidebarTitle":"Deactivate workflow","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/deactivate","href":"/pt/reference/products/flowker/deactivate-workflow"},{"title":"Move a Workflow to Draft","deprecated":null,"version":null,"sidebarTitle":"Move workflow to draft","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/draft","href":"/pt/reference/products/flowker/move-workflow-to-draft"},{"title":"Clone a Workflow","deprecated":null,"version":null,"sidebarTitle":"Clone workflow","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/clone","href":"/pt/reference/products/flowker/clone-workflow"}]},{"group":"API de Agendamento","pages":[{"title":"List Upcoming Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List upcoming scheduled occurrences","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/upcoming","href":"/pt/reference/products/flowker/list-upcoming-scheduled-occurrences"},{"title":"List Skipped Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List skipped scheduled occurrences","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/skipped","href":"/pt/reference/products/flowker/list-skipped-scheduled-occurrences"},{"title":"List Parked Scheduled Occurrences","deprecated":null,"version":null,"sidebarTitle":"List parked scheduled occurrences","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows/{id}/schedule/missed","href":"/pt/reference/products/flowker/list-parked-scheduled-occurrences"},{"title":"Count Pending-Review Occurrences","deprecated":null,"version":null,"sidebarTitle":"Count pending review occurrences","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/workflows/schedule/pending-review-counts","href":"/pt/reference/products/flowker/count-pending-review-occurrences"},{"title":"Run a Parked Occurrence","deprecated":null,"version":null,"sidebarTitle":"Run parked occurrence","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/{occurrenceId}/run","href":"/pt/reference/products/flowker/run-parked-occurrence"},{"title":"Discard a Parked Occurrence","deprecated":null,"version":null,"sidebarTitle":"Discard parked occurrence","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/{occurrenceId}/discard","href":"/pt/reference/products/flowker/discard-parked-occurrence"},{"title":"Discard All Parked Occurrences","deprecated":null,"version":null,"sidebarTitle":"Discard all parked occurrences","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{id}/schedule/missed/discard-all","href":"/pt/reference/products/flowker/discard-all-parked-occurrences"}]},{"group":"API de Execuções","pages":[{"title":"Execute a Workflow","deprecated":null,"version":null,"sidebarTitle":"Execute workflow","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/{workflowId}/executions","href":"/pt/reference/products/flowker/execute-workflow"},{"title":"List Executions","deprecated":null,"version":null,"sidebarTitle":"List executions","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/executions","href":"/pt/reference/products/flowker/list-executions"},{"title":"Get an Execution Status","deprecated":null,"version":null,"sidebarTitle":"Get execution status","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/executions/{id}","href":"/pt/reference/products/flowker/get-execution-status"},{"title":"Get Execution Results","deprecated":null,"version":null,"sidebarTitle":"Get execution results","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/executions/{id}/results","href":"/pt/reference/products/flowker/get-execution-results"},{"title":"Preview an Executor Request","deprecated":null,"version":null,"sidebarTitle":"Preview executor request","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/workflows/preview-request","href":"/pt/reference/products/flowker/preview-executor-request"}]},{"group":"API de Dashboards","pages":[{"title":"Get Dashboard Workflow Summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard workflow summary","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/dashboards/workflows/summary","href":"/pt/reference/products/flowker/get-dashboard-workflow-summary"},{"title":"Get Dashboard Execution Summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard execution summary","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/dashboards/executions","href":"/pt/reference/products/flowker/get-dashboard-execution-summary"}]},{"group":"API de Configurações de Executor","pages":[{"title":"List Executor Configurations","deprecated":null,"version":null,"sidebarTitle":"List executor configurations","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/executors","href":"/pt/reference/products/flowker/list-executor-configurations"},{"title":"Get an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Get executor configuration","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/executors/{id}","href":"/pt/reference/products/flowker/get-executor-configuration"},{"title":"Update an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Update executor configuration","openapi":"/pt/openapi/v3-current/flowker.yaml patch /v1/executors/{id}","href":"/pt/reference/products/flowker/update-executor-configuration"},{"title":"Delete an Executor Configuration","deprecated":null,"version":null,"sidebarTitle":"Delete executor configuration","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/executors/{id}","href":"/pt/reference/products/flowker/delete-executor-configuration"}]},{"group":"API de Configurações de Provider","pages":[{"title":"List Provider Configurations","deprecated":null,"version":null,"sidebarTitle":"List provider configurations","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/provider-configurations","href":"/pt/reference/products/flowker/list-provider-configurations"},{"title":"Create a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Create provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/provider-configurations","href":"/pt/reference/products/flowker/create-provider-configuration"},{"title":"Get a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Get provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/provider-configurations/{id}","href":"/pt/reference/products/flowker/get-provider-configuration"},{"title":"Update a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Update provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml patch /v1/provider-configurations/{id}","href":"/pt/reference/products/flowker/update-provider-configuration"},{"title":"Delete a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Delete provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/provider-configurations/{id}","href":"/pt/reference/products/flowker/delete-provider-configuration"},{"title":"Enable a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Enable provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/enable","href":"/pt/reference/products/flowker/enable-provider-configuration"},{"title":"Disable a Provider Configuration","deprecated":null,"version":null,"sidebarTitle":"Disable provider configuration","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/disable","href":"/pt/reference/products/flowker/disable-provider-configuration"}]},{"group":"API de Registro de Esquemas","pages":[{"title":"List OpenAPI Spec Versions","deprecated":null,"version":null,"sidebarTitle":"List openapi spec versions","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/catalog/openapi-versions/{service}","href":"/pt/reference/products/flowker/list-openapi-spec-versions"},{"title":"Upload an OpenAPI Spec Version","deprecated":null,"version":null,"sidebarTitle":"Upload openapi spec version","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/catalog/openapi-specs/{service}/{version}","href":"/pt/reference/products/flowker/upload-openapi-spec-version"},{"title":"Pin an OpenAPI Spec Version","deprecated":null,"version":null,"sidebarTitle":"Pin openapi spec version","openapi":"/pt/openapi/v3-current/flowker.yaml put /v1/catalog/openapi-version-pins/{service}","href":"/pt/reference/products/flowker/pin-openapi-spec-version"}]},{"group":"API de Esquemas OpenAPI","pages":[{"title":"List External OpenAPI Schemas","deprecated":null,"version":null,"sidebarTitle":"List openapi schemas","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/openapi-schemas","href":"/pt/reference/products/flowker/list-openapi-schemas"},{"title":"Get an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Get openapi schema","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}","href":"/pt/reference/products/flowker/get-openapi-schema"},{"title":"Upload an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Upload openapi schema","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/openapi-schemas","href":"/pt/reference/products/flowker/upload-openapi-schema"},{"title":"Delete an External OpenAPI Schema","deprecated":null,"version":null,"sidebarTitle":"Delete openapi schema","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/openapi-schemas/{id}","href":"/pt/reference/products/flowker/delete-openapi-schema"},{"title":"List External OpenAPI Schema References","deprecated":null,"version":null,"sidebarTitle":"List openapi schema references","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}/references","href":"/pt/reference/products/flowker/list-openapi-schema-references"},{"title":"Derive an Operation Schema","deprecated":null,"version":null,"sidebarTitle":"Derive openapi operation schema","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/openapi-schemas/{id}/operation-schema","href":"/pt/reference/products/flowker/derive-openapi-operation-schema"}]},{"group":"API de Esquemas XSD","pages":[{"title":"List XSD Schemas","deprecated":null,"version":null,"sidebarTitle":"List xsd schemas","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/xsd-schemas","href":"/pt/reference/products/flowker/list-xsd-schemas"},{"title":"Get an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Get xsd schema","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/xsd-schemas/{id}","href":"/pt/reference/products/flowker/get-xsd-schema"},{"title":"Upload an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Upload xsd schema","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/xsd-schemas","href":"/pt/reference/products/flowker/upload-xsd-schema"},{"title":"Delete an XSD Schema","deprecated":null,"version":null,"sidebarTitle":"Delete xsd schema","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/xsd-schemas/{id}","href":"/pt/reference/products/flowker/delete-xsd-schema"},{"title":"List XSD Schema References","deprecated":null,"version":null,"sidebarTitle":"List xsd schema references","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/xsd-schemas/{id}/references","href":"/pt/reference/products/flowker/list-xsd-schema-references"}]},{"group":"API de Webhooks","pages":[{"title":"Trigger a Webhook","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook"},{"title":"Trigger a Webhook (GET)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook get","openapi":"/pt/openapi/v3-current/flowker.yaml get /v1/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook-get"},{"title":"Trigger a Webhook (PUT)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook put","openapi":"/pt/openapi/v3-current/flowker.yaml put /v1/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook-put"},{"title":"Trigger a Webhook (PATCH)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook patch","openapi":"/pt/openapi/v3-current/flowker.yaml patch /v1/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook-patch"},{"title":"Trigger a Webhook (DELETE)","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook delete","openapi":"/pt/openapi/v3-current/flowker.yaml delete /v1/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook-delete"},{"title":"Trigger a Webhook from Streaming Hub","deprecated":null,"version":null,"sidebarTitle":"Trigger webhook from streaming hub","openapi":"/pt/openapi/v3-current/flowker.yaml post /v1/hub/webhooks/{path}","href":"/pt/reference/products/flowker/trigger-webhook-from-streaming-hub"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Flowker","href":"/pt/reference/products/flowker/flowker-error-list"}]}]},{"dropdown":"Lender","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/core-banking-yellow.png","description":"Produtos de empréstimo, solicitações e gestão da carteira","groups":[{"group":"Produtos de empréstimo do Brasil","pages":[{"title":"List loan products (BR alias)","deprecated":null,"version":null,"sidebarTitle":"List loan products br","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-products","href":"/pt/reference/products/lender/list-loan-products-br"},{"title":"Create loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Create loan product br","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-products","href":"/pt/reference/products/lender/create-loan-product-br"},{"title":"Get loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Get loan product br","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-products/{id}","href":"/pt/reference/products/lender/get-loan-product-br"},{"title":"Activate loan product (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Activate loan product br","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/activate","href":"/pt/reference/products/lender/activate-loan-product-br"},{"title":"Create loan product version (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Create loan product version br","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/versions","href":"/pt/reference/products/lender/create-loan-product-version-br"},{"title":"Promote a loan product version to current (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Promote a loan product version to current br alias","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-products/{id}/promote","href":"/pt/reference/products/lender/promote-a-loan-product-version-to-current-br-alias"},{"title":"Declare the BR norm classification of a loan product version","deprecated":null,"version":null,"sidebarTitle":"Declare the br norm classification of a loan product version","openapi":"/pt/openapi/v3-current/lender.yaml put /api/v1/br/loan-product-versions/{id}/norm-classification","href":"/pt/reference/products/lender/declare-the-br-norm-classification-of-a-loan-product-version"}]},{"group":"Operações de consignado","pages":[{"title":"List open extraordinary-collection instructions","deprecated":null,"version":null,"sidebarTitle":"List open extraordinary collection instructions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/consignado/collection-instructions","href":"/pt/reference/products/lender/list-open-extraordinary-collection-instructions"},{"title":"Ingest the collection agent's Arquivo de Baixa Extraordinária","deprecated":null,"version":null,"sidebarTitle":"Ingest the collection agent s arquivo de baixa extraordinaria","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/consignado/collection-settlements","href":"/pt/reference/products/lender/ingest-the-collection-agent-s-arquivo-de-baixa-extraordinaria"},{"title":"List refused lines of the collection agent's own settlement files","deprecated":null,"version":null,"sidebarTitle":"List refused lines of the collection agent s own settlement files","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/consignado/collection-settlements/refused","href":"/pt/reference/products/lender/list-refused-lines-of-the-collection-agent-s-own-settlement-files"},{"title":"List consignado contract divergences","deprecated":null,"version":null,"sidebarTitle":"List consignado contract divergences","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/divergences","href":"/pt/reference/products/lender/list-consignado-contract-divergences"},{"title":"Get consignado contract divergence detail","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract divergence","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/divergences/{id}","href":"/pt/reference/products/lender/get-consignado-contract-divergence"},{"title":"Assign consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Assign consignado contract divergence","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/assign","href":"/pt/reference/products/lender/assign-consignado-contract-divergence"},{"title":"Dispose consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Dispose consignado contract divergence","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/dispose","href":"/pt/reference/products/lender/dispose-consignado-contract-divergence"},{"title":"Requeue consignado contract divergence","deprecated":null,"version":null,"sidebarTitle":"Requeue consignado contract divergence","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/divergences/{id}/requeue","href":"/pt/reference/products/lender/requeue-consignado-contract-divergence"},{"title":"Create a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Create consignado compensating adjustment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments","href":"/pt/reference/products/lender/create-consignado-compensating-adjustment"},{"title":"Preview a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Preview consignado compensating adjustment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/preview","href":"/pt/reference/products/lender/preview-consignado-compensating-adjustment"},{"title":"Attach evidence to a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Attach consignado compensating adjustment evidence","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/{id}/evidence","href":"/pt/reference/products/lender/attach-consignado-compensating-adjustment-evidence"},{"title":"Reconcile a consignado compensating adjustment","deprecated":null,"version":null,"sidebarTitle":"Reconcile consignado compensating adjustment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/compensating-adjustments/{id}/reconcile","href":"/pt/reference/products/lender/reconcile-consignado-compensating-adjustment"},{"title":"Appoint the tenant's extraordinary-collection agent","deprecated":null,"version":null,"sidebarTitle":"Appoint the tenant s extraordinary collection agent","openapi":"/pt/openapi/v3-current/lender.yaml put /api/v1/internal/br/consignado/collection-agent-channel","href":"/pt/reference/products/lender/appoint-the-tenant-s-extraordinary-collection-agent"},{"title":"List quarantined extraordinary-collection settlement lines","deprecated":null,"version":null,"sidebarTitle":"List quarantined extraordinary collection settlement lines","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/collection-settlements/quarantined","href":"/pt/reference/products/lender/list-quarantined-extraordinary-collection-settlement-lines"},{"title":"Read the inbound-portability lineage of a contract","deprecated":null,"version":null,"sidebarTitle":"Read the inbound portability lineage of a contract","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/contracts/{numeroContrato}/portability-inbound","href":"/pt/reference/products/lender/read-the-inbound-portability-lineage-of-a-contract"},{"title":"Requeue a quarantined consignado inbox item","deprecated":null,"version":null,"sidebarTitle":"Requeue a quarantined consignado inbox item","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/inboxes/{inbox}/{id}/requeue","href":"/pt/reference/products/lender/requeue-a-quarantined-consignado-inbox-item"},{"title":"List over-deduction refunds owed to workers","deprecated":null,"version":null,"sidebarTitle":"List over deduction refunds owed to workers","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/br/consignado/overdeduction-refunds","href":"/pt/reference/products/lender/list-over-deduction-refunds-owed-to-workers"},{"title":"Record that an over-deduction refund was returned","deprecated":null,"version":null,"sidebarTitle":"Record that an over deduction refund was returned","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/internal/br/consignado/overdeduction-refunds/{id}/dispose","href":"/pt/reference/products/lender/record-that-an-over-deduction-refund-was-returned"}]},{"group":"Ciclo de vida do produto","pages":[{"title":"List loan products","deprecated":null,"version":null,"sidebarTitle":"List loan products","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products","href":"/pt/reference/products/lender/list-loan-products"},{"title":"Create loan product","deprecated":null,"version":null,"sidebarTitle":"Create loan product","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products","href":"/pt/reference/products/lender/create-loan-product"},{"title":"Get loan product","deprecated":null,"version":null,"sidebarTitle":"Get loan product","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products/{id}","href":"/pt/reference/products/lender/get-loan-product"},{"title":"Activate loan product","deprecated":null,"version":null,"sidebarTitle":"Activate loan product","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/activate","href":"/pt/reference/products/lender/activate-loan-product"},{"title":"Create loan product version","deprecated":null,"version":null,"sidebarTitle":"Create loan product version","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/versions","href":"/pt/reference/products/lender/create-loan-product-version"},{"title":"Promote a loan product version to current","deprecated":null,"version":null,"sidebarTitle":"Promote a loan product version to current","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/promote","href":"/pt/reference/products/lender/promote-a-loan-product-version-to-current"}]},{"group":"Versões do produto","pages":[{"title":"List loan product versions","deprecated":null,"version":null,"sidebarTitle":"List loan product versions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-product-versions","href":"/pt/reference/products/lender/list-loan-product-versions"},{"title":"Get loan product version","deprecated":null,"version":null,"sidebarTitle":"Get loan product version","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-product-versions/{id}","href":"/pt/reference/products/lender/get-loan-product-version"},{"title":"Declare charge model revision","deprecated":null,"version":null,"sidebarTitle":"Declare charge model revision","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-product-versions/{id}/charge-templates","href":"/pt/reference/products/lender/declare-charge-model-revision"}]},{"group":"Configuração do produto","pages":[{"title":"Create loan product accounting profile","deprecated":null,"version":null,"sidebarTitle":"Create loan product accounting profile","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles","href":"/pt/reference/products/lender/create-loan-product-accounting-profile"},{"title":"Supersede loan product chart of accounts","deprecated":null,"version":null,"sidebarTitle":"Supersede loan product chart of accounts","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles/supersessions","href":"/pt/reference/products/lender/supersede-loan-product-chart-of-accounts"},{"title":"Settle a chart change onto every contract's balances","deprecated":null,"version":null,"sidebarTitle":"Settle a chart change onto every contract s balances","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/accounting-profiles/supersessions/sweeps","href":"/pt/reference/products/lender/settle-a-chart-change-onto-every-contract-s-balances"},{"title":"Apply inherited loan product charge","deprecated":null,"version":null,"sidebarTitle":"Create loan product charges","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{id}/charges","href":"/pt/reference/products/lender/create-loan-product-charges"},{"title":"Get loan product floating rate table","deprecated":null,"version":null,"sidebarTitle":"List loan product floating rates","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products/{id}/floating-rates","href":"/pt/reference/products/lender/list-loan-product-floating-rates"}]},{"group":"Tabelas de taxa flutuante","pages":[{"title":"List floating-rate tables","deprecated":null,"version":null,"sidebarTitle":"List floating rate tables","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/rate-tables","href":"/pt/reference/products/lender/list-floating-rate-tables"},{"title":"Create floating-rate table","deprecated":null,"version":null,"sidebarTitle":"Create floating rate table","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/rate-tables","href":"/pt/reference/products/lender/create-floating-rate-table"},{"title":"Get floating-rate table","deprecated":null,"version":null,"sidebarTitle":"Get floating rate table","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/rate-tables/{id}","href":"/pt/reference/products/lender/get-floating-rate-table"},{"title":"Append floating-rate period","deprecated":null,"version":null,"sidebarTitle":"Append floating rate period","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/rate-tables/{id}/periods","href":"/pt/reference/products/lender/append-floating-rate-period"}]},{"group":"Modelos de documento","pages":[{"title":"List document template versions","deprecated":null,"version":null,"sidebarTitle":"List document template versions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates","href":"/pt/reference/products/lender/list-document-template-versions"},{"title":"Create document template draft","deprecated":null,"version":null,"sidebarTitle":"Create document template draft","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{productId}/document-templates","href":"/pt/reference/products/lender/create-document-template-draft"},{"title":"Get active document template","deprecated":null,"version":null,"sidebarTitle":"Get active document template","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates/active","href":"/pt/reference/products/lender/get-active-document-template"},{"title":"Get document template version","deprecated":null,"version":null,"sidebarTitle":"Get document template version","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-products/{productId}/document-templates/{templateId}","href":"/pt/reference/products/lender/get-document-template-version"},{"title":"Publish document template","deprecated":null,"version":null,"sidebarTitle":"Publish document template","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-products/{productId}/document-templates/{templateId}/publish","href":"/pt/reference/products/lender/publish-document-template"}]},{"group":"Solicitações de Empréstimo","pages":[{"title":"List loan applications","deprecated":null,"version":null,"sidebarTitle":"List loan applications","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-applications","href":"/pt/reference/products/lender/list-loan-applications"},{"title":"Create loan application","deprecated":null,"version":null,"sidebarTitle":"Create loan application","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications","href":"/pt/reference/products/lender/create-loan-application"},{"title":"Get loan application","deprecated":null,"version":null,"sidebarTitle":"Get loan application","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{id}","href":"/pt/reference/products/lender/get-loan-application"},{"title":"Preview amortisation schedule","deprecated":null,"version":null,"sidebarTitle":"Preview loan schedule","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/preview-schedule","href":"/pt/reference/products/lender/preview-loan-schedule"},{"title":"Approve loan application","deprecated":null,"version":null,"sidebarTitle":"Approve loan application","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/approve","href":"/pt/reference/products/lender/approve-loan-application"},{"title":"Disburse loan application","deprecated":null,"version":null,"sidebarTitle":"Disburse loan application","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/disburse","href":"/pt/reference/products/lender/disburse-loan-application"},{"title":"Reject loan application","deprecated":null,"version":null,"sidebarTitle":"Reject loan application","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/reject","href":"/pt/reference/products/lender/reject-loan-application"},{"title":"Withdraw loan application","deprecated":null,"version":null,"sidebarTitle":"Withdraw loan application","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{id}/withdraw","href":"/pt/reference/products/lender/withdraw-loan-application"},{"title":"Ingest BR capitalization clause consent","deprecated":null,"version":null,"sidebarTitle":"Ingest capitalization clause consent","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-applications/{id}/capitalization-consents","href":"/pt/reference/products/lender/ingest-capitalization-clause-consent"}]},{"group":"Instrumentos de crédito","pages":[{"title":"List credit instruments","deprecated":null,"version":null,"sidebarTitle":"List credit instruments","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{applicationId}/credit-instruments","href":"/pt/reference/products/lender/list-credit-instruments"},{"title":"Issue credit instrument","deprecated":null,"version":null,"sidebarTitle":"Issue credit instrument","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-applications/{applicationId}/credit-instruments","href":"/pt/reference/products/lender/issue-credit-instrument"},{"title":"Download credit instrument","deprecated":null,"version":null,"sidebarTitle":"Download credit instrument","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-applications/{applicationId}/credit-instruments/{instrumentId}/download","href":"/pt/reference/products/lender/download-credit-instrument"}]},{"group":"Informações regulatórias e risco","pages":[{"title":"Get loan account CET disclosure","deprecated":null,"version":null,"sidebarTitle":"Get loan account cet disclosure","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/cet-disclosure","href":"/pt/reference/products/lender/get-loan-account-cet-disclosure"},{"title":"Get credit operation descriptor","deprecated":null,"version":null,"sidebarTitle":"Get loan account credit operation descriptor","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/credit-descriptor","href":"/pt/reference/products/lender/get-loan-account-credit-operation-descriptor"},{"title":"Get loan account PDD stage","deprecated":null,"version":null,"sidebarTitle":"Get loan account pdd stage","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/pdd-stage","href":"/pt/reference/products/lender/get-loan-account-pdd-stage"},{"title":"Apply loan account PDD stage transition","deprecated":null,"version":null,"sidebarTitle":"Apply loan account pdd stage transition","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/pdd-stage/transitions","href":"/pt/reference/products/lender/apply-loan-account-pdd-stage-transition"},{"title":"Publish a PDD stage ladder version","deprecated":null,"version":null,"sidebarTitle":"Publish a pdd stage ladder version","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/pdd-stage-ladders","href":"/pt/reference/products/lender/publish-a-pdd-stage-ladder-version"},{"title":"Get the PDD stage ladder in force","deprecated":null,"version":null,"sidebarTitle":"Get the pdd stage ladder in force","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/pdd-stage-ladders/in-force","href":"/pt/reference/products/lender/get-the-pdd-stage-ladder-in-force"},{"title":"List qualitative problem-asset assessments","deprecated":null,"version":null,"sidebarTitle":"List qualitative problem asset assessments","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/problem-asset-assessments","href":"/pt/reference/products/lender/list-qualitative-problem-asset-assessments"},{"title":"Declare a qualitative problem-asset assessment","deprecated":null,"version":null,"sidebarTitle":"Declare a qualitative problem asset assessment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/problem-asset-assessments","href":"/pt/reference/products/lender/declare-a-qualitative-problem-asset-assessment"},{"title":"List contracts overdue for problem-asset re-assessment","deprecated":null,"version":null,"sidebarTitle":"List contracts overdue for problem asset re assessment","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/problem-asset-reassessment-overdue","href":"/pt/reference/products/lender/list-contracts-overdue-for-problem-asset-re-assessment"},{"title":"Set the problem-asset re-assessment horizon of a loan product version","deprecated":null,"version":null,"sidebarTitle":"Set the problem asset re assessment horizon of a loan product version","openapi":"/pt/openapi/v3-current/lender.yaml put /api/v1/br/loan-product-versions/{id}/problem-asset-reassessment-horizon","href":"/pt/reference/products/lender/set-the-problem-asset-re-assessment-horizon-of-a-loan-product-version"}]},{"group":"Quitação e pré-pagamento","pages":[{"title":"Get payoff statement","deprecated":null,"version":null,"sidebarTitle":"Get payoff statement","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/loan-accounts/{id}/payoff-statements/{quote_id}","href":"/pt/reference/products/lender/get-payoff-statement"},{"title":"Create prepayment quote","deprecated":null,"version":null,"sidebarTitle":"Create prepayment quote","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/prepayment-quote","href":"/pt/reference/products/lender/create-prepayment-quote"},{"title":"Prepay loan account (BR alias)","deprecated":null,"version":null,"sidebarTitle":"Prepay loan account br","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/loan-accounts/{id}/prepayments","href":"/pt/reference/products/lender/prepay-loan-account-br"},{"title":"Prepay loan account","deprecated":null,"version":null,"sidebarTitle":"Prepay loan account","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/prepayments","href":"/pt/reference/products/lender/prepay-loan-account"}]},{"group":"Visão geral e auditoria da conta","pages":[{"title":"List loan accounts","deprecated":null,"version":null,"sidebarTitle":"List loan accounts","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts","href":"/pt/reference/products/lender/list-loan-accounts"},{"title":"Get active loan account","deprecated":null,"version":null,"sidebarTitle":"Get active loan account","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}","href":"/pt/reference/products/lender/get-active-loan-account"},{"title":"List loan account audit events","deprecated":null,"version":null,"sidebarTitle":"List loan account audit events huma","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/audit-events","href":"/pt/reference/products/lender/list-loan-account-audit-events-huma"}]},{"group":"Encargos e cronograma","pages":[{"title":"List active loan charges","deprecated":null,"version":null,"sidebarTitle":"List active loan charges","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/charges","href":"/pt/reference/products/lender/list-active-loan-charges"},{"title":"Reschedule loan account","deprecated":null,"version":null,"sidebarTitle":"Reschedule loan account","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/reschedules","href":"/pt/reference/products/lender/reschedule-loan-account"},{"title":"Get active loan schedule","deprecated":null,"version":null,"sidebarTitle":"Get active loan schedule","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/schedule","href":"/pt/reference/products/lender/get-active-loan-schedule"}]},{"group":"Pagamentos","pages":[{"title":"Preview repayment allocation","deprecated":null,"version":null,"sidebarTitle":"Preview repayment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/preview-repayment","href":"/pt/reference/products/lender/preview-repayment"},{"title":"Record repayment","deprecated":null,"version":null,"sidebarTitle":"Record repayment","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/repayments","href":"/pt/reference/products/lender/record-repayment"}]},{"group":"Transações","pages":[{"title":"List active loan transactions","deprecated":null,"version":null,"sidebarTitle":"List active loan transactions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/transactions","href":"/pt/reference/products/lender/list-active-loan-transactions"},{"title":"Reverse loan account transaction","deprecated":null,"version":null,"sidebarTitle":"Reverse loan account transaction","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/loan-accounts/{id}/transactions/{transactionId}/reverse","href":"/pt/reference/products/lender/reverse-loan-account-transaction"}]},{"group":"Recebíveis de pagamento devolvido","pages":[{"title":"List returned payment receivables","deprecated":null,"version":null,"sidebarTitle":"List returned payment receivables","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/returned-payment-receivables","href":"/pt/reference/products/lender/list-returned-payment-receivables"},{"title":"Get returned payment receivable","deprecated":null,"version":null,"sidebarTitle":"Get returned payment receivable","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/returned-payment-receivables/{id}","href":"/pt/reference/products/lender/get-returned-payment-receivable"},{"title":"Record a returned payment receivable collection","deprecated":null,"version":null,"sidebarTitle":"Record a returned payment receivable collection","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/returned-payment-receivables/{id}/collections","href":"/pt/reference/products/lender/record-a-returned-payment-receivable-collection"}]},{"group":"Fundos de cessão","pages":[{"title":"List assignment funds","deprecated":null,"version":null,"sidebarTitle":"List assignment funds","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds","href":"/pt/reference/products/lender/list-assignment-funds"},{"title":"Register or update an assignment fund","deprecated":null,"version":null,"sidebarTitle":"Register or update an assignment fund","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/funds","href":"/pt/reference/products/lender/register-or-update-an-assignment-fund"},{"title":"Get assignment fund","deprecated":null,"version":null,"sidebarTitle":"Get assignment fund","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}","href":"/pt/reference/products/lender/get-assignment-fund"},{"title":"List assignment candidates with eligibility verdicts","deprecated":null,"version":null,"sidebarTitle":"List assignment candidates with eligibility verdicts","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/candidates","href":"/pt/reference/products/lender/list-assignment-candidates-with-eligibility-verdicts"},{"title":"List assignment fund document template versions","deprecated":null,"version":null,"sidebarTitle":"List assignment fund document template versions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates","href":"/pt/reference/products/lender/list-assignment-fund-document-template-versions"},{"title":"Create assignment fund document template draft","deprecated":null,"version":null,"sidebarTitle":"Create assignment fund document template draft","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/funds/{fundId}/document-templates","href":"/pt/reference/products/lender/create-assignment-fund-document-template-draft"},{"title":"Get active assignment fund document template","deprecated":null,"version":null,"sidebarTitle":"Get active assignment fund document template","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates/active","href":"/pt/reference/products/lender/get-active-assignment-fund-document-template"},{"title":"Get assignment fund document template version","deprecated":null,"version":null,"sidebarTitle":"Get assignment fund document template version","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/funds/{fundId}/document-templates/{templateId}","href":"/pt/reference/products/lender/get-assignment-fund-document-template-version"},{"title":"Publish assignment fund document template","deprecated":null,"version":null,"sidebarTitle":"Publish assignment fund document template","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/funds/{fundId}/document-templates/{templateId}/publish","href":"/pt/reference/products/lender/publish-assignment-fund-document-template"}]},{"group":"Lotes de cessão","pages":[{"title":"List assignment sets","deprecated":null,"version":null,"sidebarTitle":"List assignment sets","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/sets","href":"/pt/reference/products/lender/list-assignment-sets"},{"title":"Assemble an assignment set","deprecated":null,"version":null,"sidebarTitle":"Assemble an assignment set","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets","href":"/pt/reference/products/lender/assemble-an-assignment-set"},{"title":"Get assignment set","deprecated":null,"version":null,"sidebarTitle":"Get assignment set","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/sets/{setId}","href":"/pt/reference/products/lender/get-assignment-set"},{"title":"Score an assignment set against its fund's rule","deprecated":null,"version":null,"sidebarTitle":"Score an assignment set against its fund s rule","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/eligibility","href":"/pt/reference/products/lender/score-an-assignment-set-against-its-fund-s-rule"},{"title":"Approve an assignment set","deprecated":null,"version":null,"sidebarTitle":"Approve an assignment set","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/approve","href":"/pt/reference/products/lender/approve-an-assignment-set"},{"title":"Discard an assignment set","deprecated":null,"version":null,"sidebarTitle":"Discard an assignment set","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/discard","href":"/pt/reference/products/lender/discard-an-assignment-set"},{"title":"Record the assignment set's endorsement term","deprecated":null,"version":null,"sidebarTitle":"Record the assignment set s endorsement term","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/term","href":"/pt/reference/products/lender/record-the-assignment-set-s-endorsement-term"},{"title":"Download the offer file of an approved assignment set","deprecated":null,"version":null,"sidebarTitle":"Download the offer file of an approved assignment set","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/sets/{setId}/offer-file","href":"/pt/reference/products/lender/download-the-offer-file-of-an-approved-assignment-set"},{"title":"Ingest the fund administrator's return file for an assignment set","deprecated":null,"version":null,"sidebarTitle":"Ingest the fund administrator s return file for an assignment set","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/remessa","href":"/pt/reference/products/lender/ingest-the-fund-administrator-s-return-file-for-an-assignment-set"},{"title":"Record an externally-observed fact about an assignment set","deprecated":null,"version":null,"sidebarTitle":"Record an externally observed fact about an assignment set","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/facts","href":"/pt/reference/products/lender/record-an-externally-observed-fact-about-an-assignment-set"},{"title":"End one receivable's funding obligation before its term","deprecated":null,"version":null,"sidebarTitle":"End one receivable s funding obligation before its term","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/sets/{setId}/funding-payoff","href":"/pt/reference/products/lender/end-one-receivable-s-funding-obligation-before-its-term"}]},{"group":"Exceções e registradora da cessão","pages":[{"title":"List the assignment exception queue","deprecated":null,"version":null,"sidebarTitle":"List the assignment exception queue","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/exceptions","href":"/pt/reference/products/lender/list-the-assignment-exception-queue"},{"title":"Record a disposition against one exception case","deprecated":null,"version":null,"sidebarTitle":"Record a disposition against one exception case","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/exceptions/{caseId}/resolve","href":"/pt/reference/products/lender/record-a-disposition-against-one-exception-case"},{"title":"Get receivable assignment dossier","deprecated":null,"version":null,"sidebarTitle":"Get receivable assignment dossier","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/assignment/receivables/{receivableRef}/dossier","href":"/pt/reference/products/lender/get-receivable-assignment-dossier"},{"title":"Register a receivable's credit instrument at the registradora","deprecated":null,"version":null,"sidebarTitle":"Register a receivable s credit instrument at the registradora","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/assignment/receivables/{receivableRef}/registry-registration","href":"/pt/reference/products/lender/register-a-receivable-s-credit-instrument-at-the-registradora"}]},{"group":"Contabilidade","pages":[{"title":"List accounting profiles","deprecated":null,"version":null,"sidebarTitle":"List accounting profiles","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/accounting-profiles","href":"/pt/reference/products/lender/list-accounting-profiles"},{"title":"Create accrual run","deprecated":null,"version":null,"sidebarTitle":"Create accrual run","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/accrual-runs","href":"/pt/reference/products/lender/create-accrual-run"},{"title":"List accrual runs","deprecated":null,"version":null,"sidebarTitle":"List accrual runs","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/accrual-runs","href":"/pt/reference/products/lender/list-accrual-runs"},{"title":"Get accrual run","deprecated":null,"version":null,"sidebarTitle":"Get accrual run","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/accrual-runs/{id}","href":"/pt/reference/products/lender/get-accrual-run"},{"title":"List accrual run decisions","deprecated":null,"version":null,"sidebarTitle":"List accrual run decisions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/accrual-runs/{id}/items","href":"/pt/reference/products/lender/list-accrual-run-decisions"},{"title":"Retry accrual run items","deprecated":null,"version":null,"sidebarTitle":"Retry accrual run items","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/accrual-runs/{id}/retry","href":"/pt/reference/products/lender/retry-accrual-run-items"},{"title":"Get journal reference by correlation id","deprecated":null,"version":null,"sidebarTitle":"Get journal reference","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/journal-references","href":"/pt/reference/products/lender/get-journal-reference"},{"title":"Get journal reference by id","deprecated":null,"version":null,"sidebarTitle":"Get journal reference by id","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/journal-references/{id}","href":"/pt/reference/products/lender/get-journal-reference-by-id"},{"title":"Reconcile a contract's deferred origination fee","deprecated":null,"version":null,"sidebarTitle":"Reconcile a contract s deferred origination fee","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/loan-accounts/{id}/deferred-fee-reconciliation","href":"/pt/reference/products/lender/reconcile-a-contract-s-deferred-origination-fee"}]},{"group":"Painéis da carteira","pages":[{"title":"Get portfolio dashboard","deprecated":null,"version":null,"sidebarTitle":"Get portfolio dashboard","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/dashboard/portfolio","href":"/pt/reference/products/lender/get-portfolio-dashboard"},{"title":"List delinquent loans","deprecated":null,"version":null,"sidebarTitle":"List delinquent loans","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/dashboard/delinquent-loans","href":"/pt/reference/products/lender/list-delinquent-loans"},{"title":"List delinquent loans (Brazil)","deprecated":null,"version":null,"sidebarTitle":"List delinquent loans brazil","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/br/dashboard/delinquent-loans","href":"/pt/reference/products/lender/list-delinquent-loans-brazil"}]},{"group":"Jurisdições","pages":[{"title":"List registered jurisdictions","deprecated":null,"version":null,"sidebarTitle":"List jurisdictions","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/jurisdictions","href":"/pt/reference/products/lender/list-jurisdictions"},{"title":"Get jurisdiction by code","deprecated":null,"version":null,"sidebarTitle":"Get jurisdiction","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/jurisdictions/{code}","href":"/pt/reference/products/lender/get-jurisdiction"}]},{"group":"Impostos","pages":[{"title":"Preview jurisdiction tax amounts","deprecated":null,"version":null,"sidebarTitle":"Preview tax","openapi":"/pt/openapi/v3-current/lender.yaml post /api/v1/br/tax/preview","href":"/pt/reference/products/lender/preview-tax"}]},{"group":"Sessão","pages":[{"title":"Get current session","deprecated":null,"version":null,"sidebarTitle":"Get current session","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/me","href":"/pt/reference/products/lender/get-current-session"}]},{"group":"Streaming","pages":[{"title":"List quarantined inbound records","deprecated":null,"version":null,"sidebarTitle":"List quarantined inbound records","openapi":"/pt/openapi/v3-current/lender.yaml get /api/v1/internal/streaming/discards","href":"/pt/reference/products/lender/list-quarantined-inbound-records"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Lender","href":"/pt/reference/products/lender/lender-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Lender","href":"/pt/reference/events/lender"}]}]},{"dropdown":"Reporter","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/reporter-yellow.png","description":"Templates de relatório, geração e prazos","groups":[{"group":"Primeiros passos","pages":[{"title":"Início rápido da API do Reporter","href":"/pt/reference/products/reporter/reporter-developer-quick-start"}]},{"group":"API de Templates","pages":[{"title":"Create a template","deprecated":null,"version":null,"sidebarTitle":"Upload template","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/templates","href":"/pt/reference/products/reporter/upload-template"},{"title":"List templates","deprecated":null,"version":null,"sidebarTitle":"List templates","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates","href":"/pt/reference/products/reporter/list-templates"},{"title":"Get a template","deprecated":null,"version":null,"sidebarTitle":"Retrieve template details","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates/{id}","href":"/pt/reference/products/reporter/retrieve-template-details"},{"title":"Update a template","deprecated":null,"version":null,"sidebarTitle":"Update templates","openapi":"/pt/openapi/v3-current/reporter.yaml patch /v1/templates/{id}","href":"/pt/reference/products/reporter/update-templates"},{"title":"Delete a template","deprecated":null,"version":null,"sidebarTitle":"Delete template","openapi":"/pt/openapi/v3-current/reporter.yaml delete /v1/templates/{id}","href":"/pt/reference/products/reporter/delete-template"},{"title":"Get a template's content","deprecated":null,"version":null,"sidebarTitle":"Get template content","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates/{id}/content","href":"/pt/reference/products/reporter/get-template-content"},{"title":"List the report families in use","deprecated":null,"version":null,"sidebarTitle":"List report families","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates/categories","href":"/pt/reference/products/reporter/list-report-families"},{"title":"File many templates under one report family","deprecated":null,"version":null,"sidebarTitle":"Assign report family","openapi":"/pt/openapi/v3-current/reporter.yaml patch /v1/templates/category","href":"/pt/reference/products/reporter/assign-report-family"},{"title":"Preview a template","deprecated":null,"version":null,"sidebarTitle":"Preview template","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/templates/preview","href":"/pt/reference/products/reporter/preview-template"}]},{"group":"API do Construtor de Templates","pages":[{"title":"Get template block configuration","deprecated":null,"version":null,"sidebarTitle":"List block definitions","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates/blocks-config","href":"/pt/reference/products/reporter/list-block-definitions"},{"title":"Get template filters","deprecated":null,"version":null,"sidebarTitle":"List filter definitions","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/templates/filters","href":"/pt/reference/products/reporter/list-filter-definitions"},{"title":"Generate template code","deprecated":null,"version":null,"sidebarTitle":"Generate template code","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/templates/generate-code","href":"/pt/reference/products/reporter/generate-template-code"},{"title":"Validate template blocks","deprecated":null,"version":null,"sidebarTitle":"Validate template blocks","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/templates/validate","href":"/pt/reference/products/reporter/validate-template-blocks"}]},{"group":"API de Relatórios","pages":[{"title":"Create a report","deprecated":null,"version":null,"sidebarTitle":"Create report","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/reports","href":"/pt/reference/products/reporter/create-report"},{"title":"Get a report","deprecated":null,"version":null,"sidebarTitle":"Check report status","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/reports/{id}","href":"/pt/reference/products/reporter/check-report-status"},{"title":"List reports","deprecated":null,"version":null,"sidebarTitle":"Retrieve reports","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/reports","href":"/pt/reference/products/reporter/retrieve-reports"},{"title":"Download a report","deprecated":null,"version":null,"sidebarTitle":"Download report","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/reports/{id}/download","href":"/pt/reference/products/reporter/download-report"}]},{"group":"API de Prazos","pages":[{"title":"Create a deadline","deprecated":null,"version":null,"sidebarTitle":"Create deadline","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/deadlines","href":"/pt/reference/products/reporter/create-deadline"},{"title":"List deadlines","deprecated":null,"version":null,"sidebarTitle":"Retrieve deadlines","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/deadlines","href":"/pt/reference/products/reporter/retrieve-deadlines"},{"title":"List deadline notifications","deprecated":null,"version":null,"sidebarTitle":"Retrieve deadline notifications","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/deadlines/notifications","href":"/pt/reference/products/reporter/retrieve-deadline-notifications"},{"title":"Update a deadline","deprecated":null,"version":null,"sidebarTitle":"Update deadline","openapi":"/pt/openapi/v3-current/reporter.yaml patch /v1/deadlines/{id}","href":"/pt/reference/products/reporter/update-deadline"},{"title":"Delete a deadline","deprecated":null,"version":null,"sidebarTitle":"Delete deadline","openapi":"/pt/openapi/v3-current/reporter.yaml delete /v1/deadlines/{id}","href":"/pt/reference/products/reporter/delete-deadline"},{"title":"Set deadline delivery state","deprecated":null,"version":null,"sidebarTitle":"Deliver deadline","openapi":"/pt/openapi/v3-current/reporter.yaml patch /v1/deadlines/{id}/deliver","href":"/pt/reference/products/reporter/deliver-deadline"}]},{"group":"API de Fontes de Dados","pages":[{"title":"Create a data source","deprecated":null,"version":null,"sidebarTitle":"Create data source","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/data-sources","href":"/pt/reference/products/reporter/create-data-source"},{"title":"List data sources","deprecated":null,"version":null,"sidebarTitle":"List data sources","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/data-sources","href":"/pt/reference/products/reporter/list-data-sources"},{"title":"Get a data source","deprecated":null,"version":null,"sidebarTitle":"Retrieve data source","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/data-sources/{dataSourceId}","href":"/pt/reference/products/reporter/retrieve-data-source"},{"title":"Update a data source","deprecated":null,"version":null,"sidebarTitle":"Update data source","openapi":"/pt/openapi/v3-current/reporter.yaml patch /v1/data-sources/{dataSourceId}","href":"/pt/reference/products/reporter/update-data-source"},{"title":"Delete a data source","deprecated":null,"version":null,"sidebarTitle":"Delete data source","openapi":"/pt/openapi/v3-current/reporter.yaml delete /v1/data-sources/{dataSourceId}","href":"/pt/reference/products/reporter/delete-data-source"},{"title":"Get a data source schema","deprecated":null,"version":null,"sidebarTitle":"Get data source schema","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/data-sources/{dataSourceId}/schema","href":"/pt/reference/products/reporter/get-data-source-schema"},{"title":"Test a data source connection","deprecated":null,"version":null,"sidebarTitle":"Test data source connection","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/data-sources/{dataSourceId}/test-connection","href":"/pt/reference/products/reporter/test-data-source-connection"}]},{"group":"API de Instituições","pages":[{"title":"Register an institution","deprecated":null,"version":null,"sidebarTitle":"Create institution","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/institutions","href":"/pt/reference/products/reporter/create-institution"},{"title":"List institutions","deprecated":null,"version":null,"sidebarTitle":"List institutions","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/institutions","href":"/pt/reference/products/reporter/list-institutions"},{"title":"Get an institution","deprecated":null,"version":null,"sidebarTitle":"Get institution","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/institutions/{institutionId}","href":"/pt/reference/products/reporter/get-institution"},{"title":"Replace an institution","deprecated":null,"version":null,"sidebarTitle":"Replace institution","openapi":"/pt/openapi/v3-current/reporter.yaml put /v1/institutions/{institutionId}","href":"/pt/reference/products/reporter/replace-institution"},{"title":"Delete an institution","deprecated":null,"version":null,"sidebarTitle":"Delete institution","openapi":"/pt/openapi/v3-current/reporter.yaml delete /v1/institutions/{institutionId}","href":"/pt/reference/products/reporter/delete-institution"},{"title":"Propose institutions from Midaz","deprecated":null,"version":null,"sidebarTitle":"Propose institutions","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/institutions/proposals","href":"/pt/reference/products/reporter/propose-institutions"}]},{"group":"API de Catálogo Regulatório","pages":[{"title":"List the regulatory documents this deployment can file","deprecated":null,"version":null,"sidebarTitle":"List regulatory documents","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/documents","href":"/pt/reference/products/reporter/list-regulatory-documents"},{"title":"Get one regulatory document","deprecated":null,"version":null,"sidebarTitle":"Get regulatory document","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/documents/{documentId}","href":"/pt/reference/products/reporter/get-regulatory-document"},{"title":"Get what a document's file needs","deprecated":null,"version":null,"sidebarTitle":"Get document contract","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/documents/{documentId}/contract","href":"/pt/reference/products/reporter/get-document-contract"}]},{"group":"API de Subscriptions Regulatórias","pages":[{"title":"Activate a regulatory document","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions","href":"/pt/reference/products/reporter/create-subscription"},{"title":"List the documents this tenant files","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions","href":"/pt/reference/products/reporter/list-subscriptions"},{"title":"Get one activated document","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}","href":"/pt/reference/products/reporter/get-subscription"},{"title":"Set the institution that files a subscription","deprecated":null,"version":null,"sidebarTitle":"Set subscription institution","openapi":"/pt/openapi/v3-current/reporter.yaml put /v1/regulatory/subscriptions/{subscriptionId}/institution","href":"/pt/reference/products/reporter/set-subscription-institution"},{"title":"Adopt another version of the subscribed document","deprecated":null,"version":null,"sidebarTitle":"Adopt document version","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions/{subscriptionId}/adopt","href":"/pt/reference/products/reporter/adopt-document-version"},{"title":"Stop filing a document","deprecated":null,"version":null,"sidebarTitle":"Deactivate subscription","openapi":"/pt/openapi/v3-current/reporter.yaml delete /v1/regulatory/subscriptions/{subscriptionId}","href":"/pt/reference/products/reporter/deactivate-subscription"},{"title":"Reactivate a deactivated subscription","deprecated":null,"version":null,"sidebarTitle":"Reactivate subscription","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/subscriptions/{subscriptionId}/reactivate","href":"/pt/reference/products/reporter/reactivate-subscription"}]},{"group":"API de Mapeamentos Regulatórios","pages":[{"title":"Get the mapping in force","deprecated":null,"version":null,"sidebarTitle":"Get subscription mapping","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}/binding","href":"/pt/reference/products/reporter/get-subscription-mapping"},{"title":"Replace the mapping","deprecated":null,"version":null,"sidebarTitle":"Replace subscription mapping","openapi":"/pt/openapi/v3-current/reporter.yaml put /v1/regulatory/subscriptions/{subscriptionId}/binding","href":"/pt/reference/products/reporter/replace-subscription-mapping"},{"title":"Check the mapping against the databases as they are now","deprecated":null,"version":null,"sidebarTitle":"Check mapping readiness","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/subscriptions/{subscriptionId}/gaps","href":"/pt/reference/products/reporter/check-mapping-readiness"}]},{"group":"API de Relatórios Regulatórios","pages":[{"title":"Generate a filing of a subscribed document","deprecated":null,"version":null,"sidebarTitle":"Create regulatory report","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/reports","href":"/pt/reference/products/reporter/create-regulatory-report"},{"title":"Correct a draft and re-render it","deprecated":null,"version":null,"sidebarTitle":"Correct regulatory report","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/reports/{reportId}/overrides","href":"/pt/reference/products/reporter/correct-regulatory-report"},{"title":"Read the trail of corrections","deprecated":null,"version":null,"sidebarTitle":"List report corrections","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/reports/{reportId}/overrides","href":"/pt/reference/products/reporter/list-report-corrections"},{"title":"Approve a draft as the filing","deprecated":null,"version":null,"sidebarTitle":"Approve regulatory report","openapi":"/pt/openapi/v3-current/reporter.yaml post /v1/regulatory/reports/{reportId}/approve","href":"/pt/reference/products/reporter/approve-regulatory-report"},{"title":"Read what a report was made of, frozen","deprecated":null,"version":null,"sidebarTitle":"Get report provenance","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/regulatory/reports/{reportId}/provenance","href":"/pt/reference/products/reporter/get-report-provenance"}]},{"group":"API de Métricas","pages":[{"title":"Get system metrics","deprecated":null,"version":null,"sidebarTitle":"Get metrics","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/metrics","href":"/pt/reference/products/reporter/get-metrics"}]},{"group":"API de Streaming","pages":[{"title":"Get the streaming event manifest","deprecated":null,"version":null,"sidebarTitle":"Get streaming events","openapi":"/pt/openapi/v3-current/reporter.yaml get /v1/streaming/events","href":"/pt/reference/products/reporter/get-streaming-events"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Reporter","href":"/pt/reference/products/reporter/reporter-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Reporter","href":"/pt/reference/events/reporter"}]}]}]},{"anchor":"Trilhos Brasil","icon":"money-bill-transfer","dropdowns":[{"dropdown":"SPB (TED)","icon":"building-columns","description":"Mensageria TED com o BACEN no trilho SPB","groups":[{"group":"Auditoria","pages":[{"title":"List audit records","deprecated":null,"version":null,"sidebarTitle":"List audit records","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/audit-records","href":"/pt/reference/rails/spb/list-audit-records"},{"title":"List audit records for an operation","deprecated":null,"version":null,"sidebarTitle":"List audit records for operation","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}/audit-records","href":"/pt/reference/rails/spb/list-audit-records-for-operation"}]},{"group":"Capacidades","pages":[{"title":"List STR capabilities","deprecated":null,"version":null,"sidebarTitle":"List capabilities","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/capabilities","href":"/pt/reference/rails/spb/list-capabilities"},{"title":"Get capability by ID","deprecated":null,"version":null,"sidebarTitle":"Get capability","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/capabilities/{capabilityId}","href":"/pt/reference/rails/spb/get-capability"}]},{"group":"Certificados","pages":[{"title":"List certificate state","deprecated":null,"version":null,"sidebarTitle":"List certificates","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/certificates","href":"/pt/reference/rails/spb/list-certificates"},{"title":"Activate ICP-Brasil certificate on the RSFN (GEN0006)","deprecated":null,"version":null,"sidebarTitle":"Activate certificate","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/certificates/activate","href":"/pt/reference/rails/spb/activate-certificate"},{"title":"Rotate ICP-Brasil certificate","deprecated":null,"version":null,"sidebarTitle":"Rotate certificate","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/certificates/rotate","href":"/pt/reference/rails/spb/rotate-certificate"}]},{"group":"Recolhimento compulsório (RCO)","pages":[{"title":"List third-party compulsory deposits","deprecated":null,"version":null,"sidebarTitle":"List rco advices","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/rco-advices","href":"/pt/reference/rails/spb/list-rco-advices"},{"title":"Ask for the compulsory period calendar or read a filing back","deprecated":null,"version":null,"sidebarTitle":"Create rco filing query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/rco-filing-queries","href":"/pt/reference/rails/spb/create-rco-filing-query"},{"title":"List compulsory periods and their requirements","deprecated":null,"version":null,"sidebarTitle":"List rco filings","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/rco-filings","href":"/pt/reference/rails/spb/list-rco-filings"},{"title":"File the compulsory statement (RCO0002)","deprecated":null,"version":null,"sidebarTitle":"Create rco filing","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/rco-filings","href":"/pt/reference/rails/spb/create-rco-filing"},{"title":"List commanded compulsory movements","deprecated":null,"version":null,"sidebarTitle":"List rco movements","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/rco-movements","href":"/pt/reference/rails/spb/list-rco-movements"},{"title":"Command a compulsory-account movement","deprecated":null,"version":null,"sidebarTitle":"Create rco movement","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/rco-movements","href":"/pt/reference/rails/spb/create-rco-movement"},{"title":"Read one commanded compulsory movement","deprecated":null,"version":null,"sidebarTitle":"Get rco movement","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/rco-movements/{numCtrlIF}","href":"/pt/reference/rails/spb/get-rco-movement"},{"title":"Run a compulsory compliance read","deprecated":null,"version":null,"sidebarTitle":"Create rco report query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/rco-report-queries","href":"/pt/reference/rails/spb/create-rco-report-query"}]},{"group":"Mensagens","pages":[{"title":"Initiate connectivity (ECO) test","deprecated":null,"version":null,"sidebarTitle":"Create connectivity test","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/connectivity-tests","href":"/pt/reference/rails/spb/create-connectivity-test"},{"title":"List STR messages","deprecated":null,"version":null,"sidebarTitle":"List messages","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/messages","href":"/pt/reference/rails/spb/list-messages"},{"title":"Compose and send a curated STR message","deprecated":null,"version":null,"sidebarTitle":"Compose str message","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/messages/compose","href":"/pt/reference/rails/spb/compose-str-message"},{"title":"Get STR message detail","deprecated":null,"version":null,"sidebarTitle":"Get message status","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/messages/{nuOp}","href":"/pt/reference/rails/spb/get-message-status"},{"title":"Get the signed STR message frame","deprecated":null,"version":null,"sidebarTitle":"Get message frame","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/messages/{nuOp}/frame","href":"/pt/reference/rails/spb/get-message-frame"}]},{"group":"Aprovações de emissão","pages":[{"title":"List emissions pending maker-checker approval","deprecated":null,"version":null,"sidebarTitle":"List emission approvals","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/emission-approvals","href":"/pt/reference/rails/spb/list-emission-approvals"},{"title":"Approve (sign) a parked emission","deprecated":null,"version":null,"sidebarTitle":"Approve emission","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/emission-approvals/{id}/approve","href":"/pt/reference/rails/spb/approve-emission"},{"title":"Deny a parked emission","deprecated":null,"version":null,"sidebarTitle":"Deny emission","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/emission-approvals/{id}/deny","href":"/pt/reference/rails/spb/deny-emission"}]},{"group":"Eventos","pages":[{"title":"List event catalog","deprecated":null,"version":null,"sidebarTitle":"List event catalog","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/events/catalog","href":"/pt/reference/rails/spb/list-event-catalog"}]},{"group":"Avisos GEN","pages":[{"title":"List inbound GEN notices","deprecated":null,"version":null,"sidebarTitle":"List gen notices","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/gen-notices","href":"/pt/reference/rails/spb/list-gen-notices"}]},{"group":"Governança","pages":[{"title":"Read the live alçada governance config","deprecated":null,"version":null,"sidebarTitle":"Get str governance","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/governance","href":"/pt/reference/rails/spb/get-str-governance"},{"title":"Replace the alçada governance config","deprecated":null,"version":null,"sidebarTitle":"Put str governance","openapi":"/pt/openapi/v3-current/spb.yaml put /v1/str/governance","href":"/pt/reference/rails/spb/put-str-governance"}]},{"group":"Inteligência operacional","pages":[{"title":"Get operational aggregates","deprecated":null,"version":null,"sidebarTitle":"Get operational aggregates","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operational-aggregates","href":"/pt/reference/rails/spb/get-operational-aggregates"},{"title":"Get operational summary","deprecated":null,"version":null,"sidebarTitle":"Get operational summary","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operational-summary","href":"/pt/reference/rails/spb/get-operational-summary"}]},{"group":"Operações","pages":[{"title":"List operations","deprecated":null,"version":null,"sidebarTitle":"List operations","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations","href":"/pt/reference/rails/spb/list-operations"},{"title":"Set Conta-PI auto-transfer configuration","deprecated":null,"version":null,"sidebarTitle":"Create auto transfer config","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/auto-transfer-config","href":"/pt/reference/rails/spb/create-auto-transfer-config"},{"title":"Create bank transfer operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers","href":"/pt/reference/rails/spb/create-bank-transfer-operation"},{"title":"Return a TED credit received before Lerian SPB","deprecated":null,"version":null,"sidebarTitle":"Return a ted credit received before lerian spb","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/returns","href":"/pt/reference/rails/spb/return-a-ted-credit-received-before-lerian-spb"},{"title":"Create bank transfer cancellation operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer cancellation operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/{operationId}/cancellations","href":"/pt/reference/rails/spb/create-bank-transfer-cancellation-operation"},{"title":"Create bank transfer return operation","deprecated":null,"version":null,"sidebarTitle":"Create bank transfer return operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/bank-transfers/{operationId}/returns","href":"/pt/reference/rails/spb/create-bank-transfer-return-operation"},{"title":"Deposit a card round again (LDL0022, CodProdt SLC)","deprecated":null,"version":null,"sidebarTitle":"Deposit a card round again ldl0022 codprodt slc","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/card-deposits","href":"/pt/reference/rails/spb/deposit-a-card-round-again-ldl0022-codprodt-slc"},{"title":"Create IBS repasse operation","deprecated":null,"version":null,"sidebarTitle":"Create ibs repasse operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/ibs-repasses","href":"/pt/reference/rails/spb/create-ibs-repasse-operation"},{"title":"Create SILOC operational deposit (LDL0022)","deprecated":null,"version":null,"sidebarTitle":"Create ldl deposit","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/ldl-deposits","href":"/pt/reference/rails/spb/create-ldl-deposit"},{"title":"Create LDL settlement transfer (LDL0004/0006/0008/0011/0014)","deprecated":null,"version":null,"sidebarTitle":"Create ldl settlement","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/ldl-settlements","href":"/pt/reference/rails/spb/create-ldl-settlement"},{"title":"Create Conta-PI liquidity transfer","deprecated":null,"version":null,"sidebarTitle":"Create liquidity transfer operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/liquidity-transfers","href":"/pt/reference/rails/spb/create-liquidity-transfer-operation"},{"title":"Get Conta-PI liquidity transfer status","deprecated":null,"version":null,"sidebarTitle":"Get liquidity transfer","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/liquidity-transfers/{operationId}","href":"/pt/reference/rails/spb/get-liquidity-transfer"},{"title":"Create LTR transfer (LTR0003/0004/0006)","deprecated":null,"version":null,"sidebarTitle":"Create ltr transfer","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/ltr-transfers","href":"/pt/reference/rails/spb/create-ltr-transfer"},{"title":"Create SME electronic-money movement","deprecated":null,"version":null,"sidebarTitle":"Create sme transfer operation","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/sme-transfers","href":"/pt/reference/rails/spb/create-sme-transfer-operation"},{"title":"Get SME electronic-money movement status","deprecated":null,"version":null,"sidebarTitle":"Get sme transfer","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/sme-transfers/{operationId}","href":"/pt/reference/rails/spb/get-sme-transfer"},{"title":"Get operation detail","deprecated":null,"version":null,"sidebarTitle":"Get operation","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}","href":"/pt/reference/rails/spb/get-operation"},{"title":"List operation timeline","deprecated":null,"version":null,"sidebarTitle":"Get operation timeline","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/{operationId}/timeline","href":"/pt/reference/rails/spb/get-operation-timeline"},{"title":"List stuck operations (operator dashboard)","deprecated":null,"version":null,"sidebarTitle":"List stuck operations","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/stuck-operations","href":"/pt/reference/rails/spb/list-stuck-operations"},{"title":"Ask to close a deadline-expired transfer as failed","deprecated":null,"version":null,"sidebarTitle":"Submit stuck operation action","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/stuck-operations/actions","href":"/pt/reference/rails/spb/submit-stuck-operation-action"},{"title":"Approve closing a deadline-expired transfer as failed","deprecated":null,"version":null,"sidebarTitle":"Approve stuck operation action","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/stuck-operations/actions/{railActionRef}/approve","href":"/pt/reference/rails/spb/approve-stuck-operation-action"}]},{"group":"Readiness","pages":[{"title":"Get service readiness","deprecated":null,"version":null,"sidebarTitle":"Get readiness","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/readiness","href":"/pt/reference/rails/spb/get-readiness"}]},{"group":"Conciliação","pages":[{"title":"List quarantined inbound frames (operator triage)","deprecated":null,"version":null,"sidebarTitle":"List inbound quarantine","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/inbound-quarantine","href":"/pt/reference/rails/spb/list-inbound-quarantine"},{"title":"Replay one quarantined inbound frame","deprecated":null,"version":null,"sidebarTitle":"Replay inbound quarantine frame","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/inbound-quarantine/{parkKey}/replay","href":"/pt/reference/rails/spb/replay-inbound-quarantine-frame"},{"title":"List reconciliation cases","deprecated":null,"version":null,"sidebarTitle":"List reconciliation cases","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reconciliations","href":"/pt/reference/rails/spb/list-reconciliation-cases"},{"title":"Get reconciliation case","deprecated":null,"version":null,"sidebarTitle":"Get reconciliation case","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reconciliations/{reconciliationId}","href":"/pt/reference/rails/spb/get-reconciliation-case"},{"title":"Create reconciliation action","deprecated":null,"version":null,"sidebarTitle":"Create reconciliation action","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/reconciliations/{reconciliationId}/actions","href":"/pt/reference/rails/spb/create-reconciliation-action"}]},{"group":"Redesconto (RDC)","pages":[{"title":"Command a rediscount operation","deprecated":null,"version":null,"sidebarTitle":"Create rediscount","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/operations/rediscounts","href":"/pt/reference/rails/spb/create-rediscount"},{"title":"Read rediscount operation status","deprecated":null,"version":null,"sidebarTitle":"Get rediscount","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/operations/rediscounts/{operationId}","href":"/pt/reference/rails/spb/get-rediscount"},{"title":"Submit a rediscount query","deprecated":null,"version":null,"sidebarTitle":"Create rediscount query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/rediscount-queries","href":"/pt/reference/rails/spb/create-rediscount-query"},{"title":"Read rediscount query result","deprecated":null,"version":null,"sidebarTitle":"Get rediscount query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/rediscount-queries/{nuOp}","href":"/pt/reference/rails/spb/get-rediscount-query"}]},{"group":"Relatórios","pages":[{"title":"Movimento financeiro report","deprecated":null,"version":null,"sidebarTitle":"Get report movement","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reports/movement","href":"/pt/reference/rails/spb/get-report-movement"},{"title":"Transações rejeitadas report","deprecated":null,"version":null,"sidebarTitle":"Get report rejected","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reports/rejected","href":"/pt/reference/rails/spb/get-report-rejected"},{"title":"Volumetria report","deprecated":null,"version":null,"sidebarTitle":"Get report volumetria","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reports/volumetria","href":"/pt/reference/rails/spb/get-report-volumetria"}]},{"group":"Consultas de reserva","pages":[{"title":"Submit STR0013 reserve-account balance query","deprecated":null,"version":null,"sidebarTitle":"Create reserve balance query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/reserve-balance-queries","href":"/pt/reference/rails/spb/create-reserve-balance-query"},{"title":"Read STR0013 reserve-balance query result","deprecated":null,"version":null,"sidebarTitle":"Get reserve balance query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reserve-balance-queries/{id}","href":"/pt/reference/rails/spb/get-reserve-balance-query"},{"title":"Submit STR0014 reserve-account statement query (message-mode)","deprecated":null,"version":null,"sidebarTitle":"Create reserve statement query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/reserve-statement-queries","href":"/pt/reference/rails/spb/create-reserve-statement-query"},{"title":"Read STR0014 reserve-statement query result (message-mode)","deprecated":null,"version":null,"sidebarTitle":"Get reserve statement query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/reserve-statement-queries/{id}","href":"/pt/reference/rails/spb/get-reserve-statement-query"}]},{"group":"Responsáveis","pages":[{"title":"Update participant responsibles (GEN0019)","deprecated":null,"version":null,"sidebarTitle":"Update responsibles","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/responsibles","href":"/pt/reference/rails/spb/update-responsibles"}]},{"group":"Agendamento","pages":[{"title":"Get the STR grade of the day","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/schedule","href":"/pt/reference/rails/spb/get-schedule"}]},{"group":"Consultas de agendamento","pages":[{"title":"Submit STR0001 schedule query","deprecated":null,"version":null,"sidebarTitle":"Create schedule query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/schedule-queries","href":"/pt/reference/rails/spb/create-schedule-query"},{"title":"Read STR0001 schedule-query result","deprecated":null,"version":null,"sidebarTitle":"Get schedule query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/schedule-queries/{id}","href":"/pt/reference/rails/spb/get-schedule-query"}]},{"group":"Configurações","pages":[{"title":"Get channel settings","deprecated":null,"version":null,"sidebarTitle":"Get settings","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/settings","href":"/pt/reference/rails/spb/get-settings"},{"title":"Update channel settings","deprecated":null,"version":null,"sidebarTitle":"Update settings","openapi":"/pt/openapi/v3-current/spb.yaml patch /v1/str/settings","href":"/pt/reference/rails/spb/update-settings"}]},{"group":"Cobranças do BACEN (SLB)","pages":[{"title":"Pay BACEN an amount SLB never demanded","deprecated":null,"version":null,"sidebarTitle":"Create slb bacen payment","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/slb-bacen-payments","href":"/pt/reference/rails/spb/create-slb-bacen-payment"},{"title":"Submit SLB0006 entry query","deprecated":null,"version":null,"sidebarTitle":"Create slb entry query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/slb-entry-queries","href":"/pt/reference/rails/spb/create-slb-entry-query"},{"title":"Read SLB0006 entry query result","deprecated":null,"version":null,"sidebarTitle":"Get slb entry query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/slb-entry-queries/{nuOp}","href":"/pt/reference/rails/spb/get-slb-entry-query"},{"title":"List outstanding SLB charges","deprecated":null,"version":null,"sidebarTitle":"List slb obligations","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/slb-obligations","href":"/pt/reference/rails/spb/list-slb-obligations"},{"title":"Read one SLB charge","deprecated":null,"version":null,"sidebarTitle":"Get slb obligation","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/slb-obligations/{numCtrlSLB}","href":"/pt/reference/rails/spb/get-slb-obligation"},{"title":"Authorise payment of an SLB charge","deprecated":null,"version":null,"sidebarTitle":"Create slb payment","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/slb-payments","href":"/pt/reference/rails/spb/create-slb-payment"},{"title":"Read an SLB payment","deprecated":null,"version":null,"sidebarTitle":"Get slb payment","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/slb-payments/{nuOp}","href":"/pt/reference/rails/spb/get-slb-payment"}]},{"group":"Consultas SME","pages":[{"title":"List received electronic-money advices","deprecated":null,"version":null,"sidebarTitle":"List sme advices","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/sme-advices","href":"/pt/reference/rails/spb/list-sme-advices"},{"title":"Submit SME0003 CCME statement (extrato) query","deprecated":null,"version":null,"sidebarTitle":"Create sme statement query","openapi":"/pt/openapi/v3-current/spb.yaml post /v1/str/sme-statement-queries","href":"/pt/reference/rails/spb/create-sme-statement-query"},{"title":"Read SME0003 CCME statement (extrato) query result","deprecated":null,"version":null,"sidebarTitle":"Get sme statement query","openapi":"/pt/openapi/v3-current/spb.yaml get /v1/str/sme-statement-queries/{nuOp}","href":"/pt/reference/rails/spb/get-sme-statement-query"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SPB","href":"/pt/reference/rails/spb/spb-error-list"}]}]},{"dropdown":"SPI (Pix)","icon":"bolt","description":"Mensageria Pix com o BACEN no trilho SPI","groups":[{"group":"SPI · Relatórios de conta e liquidação","pages":[{"title":"Request a Conta PI account report","deprecated":null,"version":null,"sidebarTitle":"Create account report request","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/account-reports/requests","href":"/pt/reference/rails/spi/spi/create-account-report-request"},{"title":"Read a Conta PI balance (camt.053 result)","deprecated":null,"version":null,"sidebarTitle":"Get account report balance","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/account-reports/{correlationId}/balance","href":"/pt/reference/rails/spi/spi/get-account-report-balance"},{"title":"Read a Conta PI extrato (camt.052 RCO lançamentos result)","deprecated":null,"version":null,"sidebarTitle":"Get account report extract","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/account-reports/{correlationId}/extract","href":"/pt/reference/rails/spi/spi/get-account-report-extract"},{"title":"Report internally settled Pix transactions (MED 2.0)","deprecated":null,"version":null,"sidebarTitle":"Create settlement report","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/settlement-reports","href":"/pt/reference/rails/spi/spi/create-settlement-report"}]},{"group":"SPI · Operações e recuperação","pages":[{"title":"Initiate SPI connectivity test","deprecated":null,"version":null,"sidebarTitle":"Create connectivity test","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/connectivity-tests","href":"/pt/reference/rails/spi/spi/create-connectivity-test"},{"title":"Create structured operation","deprecated":null,"version":null,"sidebarTitle":"Create structured operation","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations","href":"/pt/reference/rails/spi/spi/create-structured-operation"},{"title":"List stuck operations (operator dashboard)","deprecated":null,"version":null,"sidebarTitle":"List stuck operations","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/operations/stuck","href":"/pt/reference/rails/spi/spi/list-stuck-operations"},{"title":"Submit an operator verb against a stuck row","deprecated":null,"version":null,"sidebarTitle":"Submit stuck operation action","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/stuck/actions","href":"/pt/reference/rails/spi/spi/submit-stuck-operation-action"},{"title":"Get operation evidence","deprecated":null,"version":null,"sidebarTitle":"Get operation evidence","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/operations/{operationId}/evidence","href":"/pt/reference/rails/spi/spi/get-operation-evidence"},{"title":"Request recovery action","deprecated":null,"version":null,"sidebarTitle":"Request recovery","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/actions","href":"/pt/reference/rails/spi/spi/request-recovery"},{"title":"Evaluate recovery eligibility","deprecated":null,"version":null,"sidebarTitle":"Evaluate recovery","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/evaluate","href":"/pt/reference/rails/spi/spi/evaluate-recovery"},{"title":"Manually resolve operation","deprecated":null,"version":null,"sidebarTitle":"Manual resolve operation","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/recovery/manual-resolution","href":"/pt/reference/rails/spi/spi/manual-resolve-operation"},{"title":"List the replies an operation sent","deprecated":null,"version":null,"sidebarTitle":"List the replies an operation sent","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/operations/{operationId}/replies","href":"/pt/reference/rails/spi/spi/list-the-replies-an-operation-sent"},{"title":"Release a stuck reply","deprecated":null,"version":null,"sidebarTitle":"Release a stuck reply","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/replies/release","href":"/pt/reference/rails/spi/spi/release-a-stuck-reply"},{"title":"Release a kept reservation","deprecated":null,"version":null,"sidebarTitle":"Release a kept reservation","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/operations/{operationId}/reservations/release","href":"/pt/reference/rails/spi/spi/release-a-kept-reservation"},{"title":"Get operation timeline","deprecated":null,"version":null,"sidebarTitle":"Get operation timeline","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/operations/{operationId}/timeline","href":"/pt/reference/rails/spi/spi/get-operation-timeline"},{"title":"Execute recovery action","deprecated":null,"version":null,"sidebarTitle":"Execute recovery","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/recovery/actions/{recoveryActionId}/execute","href":"/pt/reference/rails/spi/spi/execute-recovery"}]},{"group":"SPI · Mandatos","pages":[{"title":"List recorded Pix Automático mandate operations (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"List mandates","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/mandates","href":"/pt/reference/rails/spi/spi/list-mandates"},{"title":"Request confirmation of a Pix Automático mandate (pain.009)","deprecated":null,"version":null,"sidebarTitle":"Create mandate request","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/mandates","href":"/pt/reference/rails/spi/spi/create-mandate-request"},{"title":"Cancel a Pix Automático mandate (pain.011)","deprecated":null,"version":null,"sidebarTitle":"Create mandate cancellation","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/mandates/cancellations","href":"/pt/reference/rails/spi/spi/create-mandate-cancellation"},{"title":"Accept or reject a Pix Automático mandate (pain.012)","deprecated":null,"version":null,"sidebarTitle":"Create mandate resolution","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/mandates/resolutions","href":"/pt/reference/rails/spi/spi/create-mandate-resolution"},{"title":"Inspect a recorded Pix Automático mandate operation (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"Get mandate","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/mandates/{mandateId}","href":"/pt/reference/rails/spi/spi/get-mandate"}]},{"group":"SPI · Responsáveis","pages":[{"title":"Register Conta PI responsible contacts","deprecated":null,"version":null,"sidebarTitle":"Register responsibles","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/responsibles","href":"/pt/reference/rails/spi/spi/register-responsibles"},{"title":"Get a participant's last-known Conta-PI responsibles","deprecated":null,"version":null,"sidebarTitle":"Get responsibles","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/responsibles/{ispb}","href":"/pt/reference/rails/spi/spi/get-responsibles"}]},{"group":"SPI · Agendamentos","pages":[{"title":"List recorded Pix Automático schedule operations (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"List schedules","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/scheduled-payments","href":"/pt/reference/rails/spi/spi/list-schedules"},{"title":"Schedule a Pix Automático payment instruction (pain.013)","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments","href":"/pt/reference/rails/spi/spi/create-scheduled-payment"},{"title":"Request cancellation of a Pix Automático schedule (camt.055)","deprecated":null,"version":null,"sidebarTitle":"Create schedule cancellation","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/cancellations","href":"/pt/reference/rails/spi/spi/create-schedule-cancellation"},{"title":"Resolve a received cancellation request (camt.029)","deprecated":null,"version":null,"sidebarTitle":"Create schedule cancellation resolution","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/cancellations/resolutions","href":"/pt/reference/rails/spi/spi/create-schedule-cancellation-resolution"},{"title":"Accept or reject a Pix Automático scheduled payment (pain.014)","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment resolution","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/scheduled-payments/resolutions","href":"/pt/reference/rails/spi/spi/create-scheduled-payment-resolution"},{"title":"Inspect a recorded Pix Automático schedule operation (internal operator read)","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/scheduled-payments/{scheduleId}","href":"/pt/reference/rails/spi/spi/get-schedule"}]},{"group":"SPI · Aprovações","pages":[{"title":"Create approval request","deprecated":null,"version":null,"sidebarTitle":"Create approval","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/approvals","href":"/pt/reference/rails/spi/spi/create-approval"},{"title":"Get approval","deprecated":null,"version":null,"sidebarTitle":"Get approval","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/approvals/{approvalId}","href":"/pt/reference/rails/spi/spi/get-approval"},{"title":"Decide approval","deprecated":null,"version":null,"sidebarTitle":"Decide approval","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/approvals/{approvalId}/decision","href":"/pt/reference/rails/spi/spi/decide-approval"}]},{"group":"SPI · Capacidades","pages":[{"title":"List SPI capabilities","deprecated":null,"version":null,"sidebarTitle":"List spi capabilities","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/capabilities","href":"/pt/reference/rails/spi/spi/list-spi-capabilities"},{"title":"Get SPI capability by ID","deprecated":null,"version":null,"sidebarTitle":"Get spi capability","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/capabilities/{capabilityId}","href":"/pt/reference/rails/spi/spi/get-spi-capability"}]},{"group":"SPI · Certificados","pages":[{"title":"List Pix certificates","deprecated":null,"version":null,"sidebarTitle":"List pix certificates","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/certificates","href":"/pt/reference/rails/spi/spi/list-pix-certificates"},{"title":"Upload a Pix certificate (public .cer)","deprecated":null,"version":null,"sidebarTitle":"Upload pix certificate","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/certificates","href":"/pt/reference/rails/spi/spi/upload-pix-certificate"},{"title":"Deactivate a Pix certificate","deprecated":null,"version":null,"sidebarTitle":"Deactivate pix certificate","openapi":"/pt/openapi/v3-current/spi.yaml delete /api/v1/spi/certificates/{id}","href":"/pt/reference/rails/spi/spi/deactivate-pix-certificate"},{"title":"Get a Pix certificate with its audit trail","deprecated":null,"version":null,"sidebarTitle":"Get pix certificate","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/certificates/{id}","href":"/pt/reference/rails/spi/spi/get-pix-certificate"}]},{"group":"SPI · Evidências","pages":[{"title":"Create evidence export job","deprecated":null,"version":null,"sidebarTitle":"Create evidence export","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/evidence/exports","href":"/pt/reference/rails/spi/spi/create-evidence-export"},{"title":"Get evidence export job","deprecated":null,"version":null,"sidebarTitle":"Get evidence export","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/evidence/exports/{exportId}","href":"/pt/reference/rails/spi/spi/get-evidence-export"}]},{"group":"SPI · Mensagens","pages":[{"title":"List parked ICOM messages","deprecated":null,"version":null,"sidebarTitle":"List parked icom messages","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/icom/parked","href":"/pt/reference/rails/spi/spi/list-parked-icom-messages"},{"title":"Get one parked ICOM message","deprecated":null,"version":null,"sidebarTitle":"Get parked icom message","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/icom/parked/{resourceId}","href":"/pt/reference/rails/spi/spi/get-parked-icom-message"},{"title":"Replay a parked ICOM message","deprecated":null,"version":null,"sidebarTitle":"Replay parked icom message","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/icom/parked/{resourceId}/replay","href":"/pt/reference/rails/spi/spi/replay-parked-icom-message"},{"title":"List the SPI message log","deprecated":null,"version":null,"sidebarTitle":"List message log","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/messages","href":"/pt/reference/rails/spi/spi/list-message-log"},{"title":"Decide a parked inbound Pix or devolução","deprecated":null,"version":null,"sidebarTitle":"Process inbound message","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/messages/inbound/process","href":"/pt/reference/rails/spi/spi/process-inbound-message"},{"title":"Validate inbound message","deprecated":null,"version":null,"sidebarTitle":"Validate inbound message","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/messages/inbound/validate","href":"/pt/reference/rails/spi/spi/validate-inbound-message"},{"title":"Inspect a message-log entry and its correspondent","deprecated":null,"version":null,"sidebarTitle":"Get message log detail","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/messages/{messageRecordId}","href":"/pt/reference/rails/spi/spi/get-message-log-detail"}]},{"group":"SPI · Pagamentos","pages":[{"title":"List payments sent and received","deprecated":null,"version":null,"sidebarTitle":"List payments","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/payments","href":"/pt/reference/rails/spi/spi/list-payments"},{"title":"Create payment","deprecated":null,"version":null,"sidebarTitle":"Create payment","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/payments","href":"/pt/reference/rails/spi/spi/create-payment"},{"title":"Get payment","deprecated":null,"version":null,"sidebarTitle":"Get payment","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}","href":"/pt/reference/rails/spi/spi/get-payment"},{"title":"Get payment history","deprecated":null,"version":null,"sidebarTitle":"Get payment history","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}/history","href":"/pt/reference/rails/spi/spi/get-payment-history"},{"title":"Initiate payment return","deprecated":null,"version":null,"sidebarTitle":"Initiate payment return","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/payments/{endToEndID}/returns","href":"/pt/reference/rails/spi/spi/initiate-payment-return"},{"title":"Get payment return status","deprecated":null,"version":null,"sidebarTitle":"Get payment return status","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/payments/{endToEndID}/returns/status","href":"/pt/reference/rails/spi/spi/get-payment-return-status"},{"title":"Consultar Pix recebidos","deprecated":null,"version":null,"sidebarTitle":"List received pix","openapi":"/pt/openapi/v3-current/spi.yaml post /api/v1/spi/pix","href":"/pt/reference/rails/spi/spi/list-received-pix"},{"title":"List arriving Pix awaiting a funding decision","deprecated":null,"version":null,"sidebarTitle":"List pix awaiting funding","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/pix/awaiting-funding","href":"/pt/reference/rails/spi/spi/list-pix-awaiting-funding"},{"title":"Consultar devolução","deprecated":null,"version":null,"sidebarTitle":"Get devolucao","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/pix/{e2eid}/devolucao/{id}","href":"/pt/reference/rails/spi/spi/get-devolucao"},{"title":"Solicitar devolução","deprecated":null,"version":null,"sidebarTitle":"Request devolucao","openapi":"/pt/openapi/v3-current/spi.yaml put /api/v1/spi/pix/{e2eid}/devolucao/{id}","href":"/pt/reference/rails/spi/spi/request-devolucao"}]},{"group":"SPI · Relatórios","pages":[{"title":"Conta-PI balance-window report","deprecated":null,"version":null,"sidebarTitle":"Get spi report balances","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/reports/balances","href":"/pt/reference/rails/spi/spi/get-spi-report-balances"},{"title":"Conta-PI extract-list report","deprecated":null,"version":null,"sidebarTitle":"Get spi report extracts","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/reports/extracts","href":"/pt/reference/rails/spi/spi/get-spi-report-extracts"},{"title":"SPI rejected-payments report","deprecated":null,"version":null,"sidebarTitle":"Get spi report rejected","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/reports/rejected","href":"/pt/reference/rails/spi/spi/get-spi-report-rejected"},{"title":"SPI volumetria report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get spi report volumetria","openapi":"/pt/openapi/v3-current/spi.yaml get /api/v1/spi/reports/volumetria","href":"/pt/reference/rails/spi/spi/get-spi-report-volumetria"}]},{"group":"SPI · Interno","pages":[{"title":"Internal rail inbound callback","deprecated":null,"version":null,"sidebarTitle":"Rail inbound callback","openapi":"/pt/openapi/v3-current/spi.yaml post /internal/v1/spi/rail/inbound","href":"/pt/reference/rails/spi/spi/rail-inbound-callback"}]},{"group":"DICT · Reivindicações","pages":[{"title":"List claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/claims","href":"/pt/reference/rails/spi/dict/list-claims"},{"title":"Get claim","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/claims/{claimID}","href":"/pt/reference/rails/spi/dict/get-claim"},{"title":"Abandon a claim BACEN never registered","deprecated":null,"version":null,"sidebarTitle":"Abandon a claim bacen never registered","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/abandon","href":"/pt/reference/rails/spi/dict/abandon-a-claim-bacen-never-registered"},{"title":"Acknowledge claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/acknowledge","href":"/pt/reference/rails/spi/dict/acknowledge-claim"},{"title":"Cancel claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/cancel","href":"/pt/reference/rails/spi/dict/cancel-claim"},{"title":"Complete claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/complete","href":"/pt/reference/rails/spi/dict/complete-claim"},{"title":"Confirm claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/confirm","href":"/pt/reference/rails/spi/dict/confirm-claim"},{"title":"Reject claim (decline)","deprecated":null,"version":null,"sidebarTitle":"Reject claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/claims/{claimID}/reject","href":"/pt/reference/rails/spi/dict/reject-claim"},{"title":"Process claim deadlines","deprecated":null,"version":null,"sidebarTitle":"Process claim deadlines","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/claims/process-deadlines","href":"/pt/reference/rails/spi/dict/process-claim-deadlines"},{"title":"Initiate claim","deprecated":null,"version":null,"sidebarTitle":"Initiate claim","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/participants/{participantISPB}/claims","href":"/pt/reference/rails/spi/dict/initiate-claim"}]},{"group":"DICT · Estatísticas","pages":[{"title":"Get BACEN entry antifraud statistics","deprecated":null,"version":null,"sidebarTitle":"Get entry statistics","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/entries/{key}/statistics","href":"/pt/reference/rails/spi/dict/get-entry-statistics"},{"title":"Get BACEN person antifraud statistics","deprecated":null,"version":null,"sidebarTitle":"Get person statistics","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/persons/statistics","href":"/pt/reference/rails/spi/dict/get-person-statistics"},{"title":"List watched CPFs/CNPJs","deprecated":null,"version":null,"sidebarTitle":"List person watchlist","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/persons/watchlist","href":"/pt/reference/rails/spi/dict/list-person-watchlist"},{"title":"Watch a CPF/CNPJ for antifraud signal","deprecated":null,"version":null,"sidebarTitle":"Add person watchlist document","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/persons/watchlist","href":"/pt/reference/rails/spi/dict/add-person-watchlist-document"},{"title":"Stop watching a CPF/CNPJ","deprecated":null,"version":null,"sidebarTitle":"Remove person watchlist document","openapi":"/pt/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/persons/watchlist/{id}","href":"/pt/reference/rails/spi/dict/remove-person-watchlist-document"}]},{"group":"DICT · Marcadores de fraude","pages":[{"title":"List fraud markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers","href":"/pt/reference/rails/spi/dict/list-fraud-markers"},{"title":"Create fraud marker","deprecated":null,"version":null,"sidebarTitle":"Create fraud marker","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers","href":"/pt/reference/rails/spi/dict/create-fraud-marker"},{"title":"Search the participant's fraud markers at BACEN","deprecated":null,"version":null,"sidebarTitle":"Search the participants fraud markers at bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers/search","href":"/pt/reference/rails/spi/dict/search-the-participants-fraud-markers-at-bacen"},{"title":"Fraud marker statistics","deprecated":null,"version":null,"sidebarTitle":"Fraud marker stats","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers/stats","href":"/pt/reference/rails/spi/dict/fraud-marker-stats"},{"title":"Get fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get fraud marker","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/fraud-markers/{id}","href":"/pt/reference/rails/spi/dict/get-fraud-marker"},{"title":"Cancel fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel fraud marker","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers/{id}/cancel","href":"/pt/reference/rails/spi/dict/cancel-fraud-marker"},{"title":"Refresh DICT fraud marker from BACEN","deprecated":null,"version":null,"sidebarTitle":"Refresh dict fraud marker from bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/fraud-markers/{id}/refresh","href":"/pt/reference/rails/spi/dict/refresh-dict-fraud-marker-from-bacen"}]},{"group":"DICT · Recuperações de fundos","pages":[{"title":"List DICT funds recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries","href":"/pt/reference/rails/spi/dict/list-funds-recoveries"},{"title":"Create DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries","href":"/pt/reference/rails/spi/dict/create-funds-recovery"},{"title":"Take in client-supplied funds-recovery ids","deprecated":null,"version":null,"sidebarTitle":"Intake funds recoveries","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/intake","href":"/pt/reference/rails/spi/dict/intake-funds-recoveries"},{"title":"Get DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}","href":"/pt/reference/rails/spi/dict/get-funds-recovery"},{"title":"Correct an open funds recovery","deprecated":null,"version":null,"sidebarTitle":"Update funds recovery","openapi":"/pt/openapi/v3-current/spi-dict.yaml put /api/v1/dict/funds-recoveries/{id}","href":"/pt/reference/rails/spi/dict/update-funds-recovery"},{"title":"Cancel DICT funds recovery","deprecated":null,"version":null,"sidebarTitle":"Cancel funds recovery","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/{id}/cancel","href":"/pt/reference/rails/spi/dict/cancel-funds-recovery"},{"title":"List a funds recovery's infraction reports","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/infraction-reports","href":"/pt/reference/rails/spi/dict/list-funds-recovery-infraction-reports"},{"title":"Request the refund of a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/funds-recoveries/{id}/refund","href":"/pt/reference/rails/spi/dict/create-funds-recovery-refund"},{"title":"List a funds recovery's refunds","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/refunds","href":"/pt/reference/rails/spi/dict/list-funds-recovery-refunds"},{"title":"Get DICT funds-recovery tracking graph","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery tracking graph","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/funds-recoveries/{id}/tracking-graph","href":"/pt/reference/rails/spi/dict/get-funds-recovery-tracking-graph"}]},{"group":"DICT · Infrações","pages":[{"title":"List DICT infractions","deprecated":null,"version":null,"sidebarTitle":"List infractions","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/infractions","href":"/pt/reference/rails/spi/dict/list-infractions"},{"title":"Get DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Get infraction","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/infractions/{id}","href":"/pt/reference/rails/spi/dict/get-infraction"},{"title":"Acknowledge DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Acknowledge infraction","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/acknowledge","href":"/pt/reference/rails/spi/dict/acknowledge-infraction"},{"title":"Cancel DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Cancel infraction","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/cancel","href":"/pt/reference/rails/spi/dict/cancel-infraction"},{"title":"Close DICT infraction","deprecated":null,"version":null,"sidebarTitle":"Close infraction","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/close","href":"/pt/reference/rails/spi/dict/close-infraction"},{"title":"Refresh DICT infraction from BACEN","deprecated":null,"version":null,"sidebarTitle":"Refresh infraction","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/infractions/{id}/refresh","href":"/pt/reference/rails/spi/dict/refresh-infraction"}]},{"group":"DICT · Interno","pages":[{"title":"Read DICT request-limiting buckets","deprecated":null,"version":null,"sidebarTitle":"Read dict policy buckets","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/internal/policies","href":"/pt/reference/rails/spi/dict/read-dict-policy-buckets"},{"title":"Release an end user's DICT key queries","deprecated":null,"version":null,"sidebarTitle":"Unblock dict query payer","openapi":"/pt/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/internal/query-blocks","href":"/pt/reference/rails/spi/dict/unblock-dict-query-payer"},{"title":"Block an end user's DICT key queries","deprecated":null,"version":null,"sidebarTitle":"Block dict query payer","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/internal/query-blocks","href":"/pt/reference/rails/spi/dict/block-dict-query-payer"},{"title":"Read DICT query-monitoring indicators","deprecated":null,"version":null,"sidebarTitle":"Read dict query monitor","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/internal/query-monitor","href":"/pt/reference/rails/spi/dict/read-dict-query-monitor"}]},{"group":"DICT · Chaves","pages":[{"title":"Delete PIX key","deprecated":null,"version":null,"sidebarTitle":"Delete key","openapi":"/pt/openapi/v3-current/spi-dict.yaml delete /api/v1/dict/keys","href":"/pt/reference/rails/spi/dict/delete-key"},{"title":"List PIX keys","deprecated":null,"version":null,"sidebarTitle":"List keys","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys","href":"/pt/reference/rails/spi/dict/list-keys"},{"title":"Register PIX key","deprecated":null,"version":null,"sidebarTitle":"Register key","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys","href":"/pt/reference/rails/spi/dict/register-key"},{"title":"Batch check PIX key existence","deprecated":null,"version":null,"sidebarTitle":"Check keys","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys/check","href":"/pt/reference/rails/spi/dict/check-keys"},{"title":"Lookup PIX key","deprecated":null,"version":null,"sidebarTitle":"Lookup key","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/keys/lookup","href":"/pt/reference/rails/spi/dict/lookup-key"},{"title":"Search PIX keys","deprecated":null,"version":null,"sidebarTitle":"Search keys","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/search","href":"/pt/reference/rails/spi/dict/search-keys"},{"title":"PIX key statistics","deprecated":null,"version":null,"sidebarTitle":"Key stats","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/keys/stats","href":"/pt/reference/rails/spi/dict/key-stats"},{"title":"Update PIX key","deprecated":null,"version":null,"sidebarTitle":"Update key","openapi":"/pt/openapi/v3-current/spi-dict.yaml put /api/v1/dict/keys/{key}","href":"/pt/reference/rails/spi/dict/update-key"}]},{"group":"DICT · Operações","pages":[{"title":"List DICT poll feed states","deprecated":null,"version":null,"sidebarTitle":"List dict discovery feeds","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/discovery-feeds","href":"/pt/reference/rails/spi/dict/list-dict-discovery-feeds"},{"title":"Abandon one unreadable record on a DICT poll feed","deprecated":null,"version":null,"sidebarTitle":"Abandon dict discovery feed record","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/discovery-feeds/{feed}/abandon-record","href":"/pt/reference/rails/spi/dict/abandon-dict-discovery-feed-record"},{"title":"Unblock a frozen DICT poll feed","deprecated":null,"version":null,"sidebarTitle":"Unblock dict discovery feed","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/discovery-feeds/{feed}/unblock","href":"/pt/reference/rails/spi/dict/unblock-dict-discovery-feed"},{"title":"List DICT MED operation statuses","deprecated":null,"version":null,"sidebarTitle":"List regulatory operations","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/operations","href":"/pt/reference/rails/spi/dict/list-regulatory-operations"},{"title":"Get DICT MED operation status","deprecated":null,"version":null,"sidebarTitle":"Get regulatory operation","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/operations/{id}","href":"/pt/reference/rails/spi/dict/get-regulatory-operation"},{"title":"Resolve a MANUAL_REVIEW DICT MED operation","deprecated":null,"version":null,"sidebarTitle":"Resolve regulatory operation","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/operations/{operationId}/resolution","href":"/pt/reference/rails/spi/dict/resolve-regulatory-operation"}]},{"group":"DICT · Devoluções","pages":[{"title":"List DICT refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/refunds","href":"/pt/reference/rails/spi/dict/list-refunds"},{"title":"Create DICT refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds","href":"/pt/reference/rails/spi/dict/create-refund"},{"title":"Get DICT refund","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/refunds/{id}","href":"/pt/reference/rails/spi/dict/get-refund"},{"title":"Cancel DICT refund","deprecated":null,"version":null,"sidebarTitle":"Cancel refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/cancel","href":"/pt/reference/rails/spi/dict/cancel-refund"},{"title":"Close DICT refund","deprecated":null,"version":null,"sidebarTitle":"Close refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/close","href":"/pt/reference/rails/spi/dict/close-refund"},{"title":"Refresh DICT refund from BACEN","deprecated":null,"version":null,"sidebarTitle":"Refresh refund","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/refunds/{id}/refresh","href":"/pt/reference/rails/spi/dict/refresh-refund"}]},{"group":"DICT · Relatórios","pages":[{"title":"DICT claims-summary report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get dict report claims summary","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/claims-summary","href":"/pt/reference/rails/spi/dict/get-dict-report-claims-summary"},{"title":"DICT keys-summary report (COUNT-only)","deprecated":null,"version":null,"sidebarTitle":"Get dict report keys summary","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/reports/keys-summary","href":"/pt/reference/rails/spi/dict/get-dict-report-keys-summary"}]},{"group":"DICT · VSync","pages":[{"title":"Request a CID set file from BACEN","deprecated":null,"version":null,"sidebarTitle":"Request a cid set file from bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/cids/files","href":"/pt/reference/rails/spi/dict/request-a-cid-set-file-from-bacen"},{"title":"Read a CID set file request","deprecated":null,"version":null,"sidebarTitle":"Read a cid set file request","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/files/{id}","href":"/pt/reference/rails/spi/dict/read-a-cid-set-file-request"},{"title":"Stream a CID set file","deprecated":null,"version":null,"sidebarTitle":"Stream a cid set file","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/files/{id}/content","href":"/pt/reference/rails/spi/dict/stream-a-cid-set-file"},{"title":"Resolve a CID at BACEN","deprecated":null,"version":null,"sidebarTitle":"Resolve a cid at bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/entries/{cid}","href":"/pt/reference/rails/spi/dict/resolve-a-cid-at-bacen"},{"title":"List CID set events at BACEN","deprecated":null,"version":null,"sidebarTitle":"List cid set events at bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml get /api/v1/dict/cids/events","href":"/pt/reference/rails/spi/dict/list-cid-set-events-at-bacen"},{"title":"Verify a CID set against BACEN","deprecated":null,"version":null,"sidebarTitle":"Verify a cid set against bacen","openapi":"/pt/openapi/v3-current/spi-dict.yaml post /api/v1/dict/sync-verifications","href":"/pt/reference/rails/spi/dict/verify-a-cid-set-against-bacen"}]},{"group":"BR Code · BR Code","pages":[{"title":"List BR Code payloads","deprecated":null,"version":null,"sidebarTitle":"List br code payloads","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/","href":"/pt/reference/rails/spi/brcode/list-br-code-payloads"},{"title":"Generate BR Code","deprecated":null,"version":null,"sidebarTitle":"Generate br code","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/","href":"/pt/reference/rails/spi/brcode/generate-br-code"},{"title":"BR Code payload JWK Set","deprecated":null,"version":null,"sidebarTitle":"Get br code jwks","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/.well-known/jwks.json","href":"/pt/reference/rails/spi/brcode/get-br-code-jwks"},{"title":"Decode BR Code","deprecated":null,"version":null,"sidebarTitle":"Decode br code","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/decode","href":"/pt/reference/rails/spi/brcode/decode-br-code"},{"title":"Get BR Code info","deprecated":null,"version":null,"sidebarTitle":"Get br code info","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/info/{payload}","href":"/pt/reference/rails/spi/brcode/get-br-code-info"},{"title":"Resolve a dynamic BR Code (payer side)","deprecated":null,"version":null,"sidebarTitle":"Resolve a dynamic br code payer side","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/resolve","href":"/pt/reference/rails/spi/brcode/resolve-a-dynamic-br-code-payer-side"},{"title":"Validate BR Code","deprecated":null,"version":null,"sidebarTitle":"Validate br code","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/validate","href":"/pt/reference/rails/spi/brcode/validate-br-code"},{"title":"Get BR Code payload","deprecated":null,"version":null,"sidebarTitle":"Get br code payload","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/{id}","href":"/pt/reference/rails/spi/brcode/get-br-code-payload"}]},{"group":"BR Code · Cobranças","pages":[{"title":"Download the CNAB 750 settlement file","deprecated":null,"version":null,"sidebarTitle":"Download liquidacoes","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/liquidacoes","href":"/pt/reference/rails/spi/brcode/download-liquidacoes"},{"title":"Get file batch status","deprecated":null,"version":null,"sidebarTitle":"Get file batch","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/{id}","href":"/pt/reference/rails/spi/brcode/get-file-batch"},{"title":"Download the CNAB 750 retorno","deprecated":null,"version":null,"sidebarTitle":"Download file batch retorno","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/{id}/retorno","href":"/pt/reference/rails/spi/brcode/download-file-batch-retorno"},{"title":"Reconcile charge","deprecated":null,"version":null,"sidebarTitle":"Reconcile charge","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/charges/reconcile","href":"/pt/reference/rails/spi/brcode/reconcile-charge"},{"title":"Get recebedor profile","deprecated":null,"version":null,"sidebarTitle":"Get recebedor profile","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/recebedores/{chave}","href":"/pt/reference/rails/spi/brcode/get-recebedor-profile"},{"title":"Register recebedor profile","deprecated":null,"version":null,"sidebarTitle":"Upsert recebedor profile","openapi":"/pt/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/recebedores/{chave}","href":"/pt/reference/rails/spi/brcode/upsert-recebedor-profile"}]},{"group":"BR Code · COB","pages":[{"title":"List immediate charges","deprecated":null,"version":null,"sidebarTitle":"List cob","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cob","href":"/pt/reference/rails/spi/brcode/list-cob"},{"title":"Create immediate charge (PSP-generated txid)","deprecated":null,"version":null,"sidebarTitle":"Post cob","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cob","href":"/pt/reference/rails/spi/brcode/post-cob"},{"title":"Retrieve immediate charge","deprecated":null,"version":null,"sidebarTitle":"Get cob","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cob/{txid}","href":"/pt/reference/rails/spi/brcode/get-cob"},{"title":"Revise immediate charge","deprecated":null,"version":null,"sidebarTitle":"Patch cob","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cob/{txid}","href":"/pt/reference/rails/spi/brcode/patch-cob"},{"title":"Create immediate charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob","openapi":"/pt/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cob/{txid}","href":"/pt/reference/rails/spi/brcode/put-cob"}]},{"group":"BR Code · COB R","pages":[{"title":"List recurring charges","deprecated":null,"version":null,"sidebarTitle":"List cob r","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobr","href":"/pt/reference/rails/spi/brcode/list-cob-r"},{"title":"Create recurring charge (PSP-generated txid)","deprecated":null,"version":null,"sidebarTitle":"Post cob r","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cobr","href":"/pt/reference/rails/spi/brcode/post-cob-r"},{"title":"Retrieve recurring charge","deprecated":null,"version":null,"sidebarTitle":"Get cob r","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobr/{txid}","href":"/pt/reference/rails/spi/brcode/get-cob-r"},{"title":"Revise recurring charge (cancel)","deprecated":null,"version":null,"sidebarTitle":"Patch cob r","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cobr/{txid}","href":"/pt/reference/rails/spi/brcode/patch-cob-r"},{"title":"Create recurring charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob r","openapi":"/pt/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cobr/{txid}","href":"/pt/reference/rails/spi/brcode/put-cob-r"},{"title":"Request settlement retry","deprecated":null,"version":null,"sidebarTitle":"Post cob r retentativa","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/cobr/{txid}/retentativa/{data}","href":"/pt/reference/rails/spi/brcode/post-cob-r-retentativa"}]},{"group":"BR Code · COB V","pages":[{"title":"List due-date charges","deprecated":null,"version":null,"sidebarTitle":"List cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobv","href":"/pt/reference/rails/spi/brcode/list-cob-v"},{"title":"Retrieve due-date charge","deprecated":null,"version":null,"sidebarTitle":"Get cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cobv/{txid}","href":"/pt/reference/rails/spi/brcode/get-cob-v"},{"title":"Revise due-date charge","deprecated":null,"version":null,"sidebarTitle":"Patch cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/cobv/{txid}","href":"/pt/reference/rails/spi/brcode/patch-cob-v"},{"title":"Create due-date charge (idempotent txid)","deprecated":null,"version":null,"sidebarTitle":"Put cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/cobv/{txid}","href":"/pt/reference/rails/spi/brcode/put-cob-v"}]},{"group":"BR Code · Localização","pages":[{"title":"List locations","deprecated":null,"version":null,"sidebarTitle":"List location","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/loc","href":"/pt/reference/rails/spi/brcode/list-location"},{"title":"Create payload location","deprecated":null,"version":null,"sidebarTitle":"Create location","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/loc","href":"/pt/reference/rails/spi/brcode/create-location"},{"title":"Retrieve location","deprecated":null,"version":null,"sidebarTitle":"Get location","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/loc/{id}","href":"/pt/reference/rails/spi/brcode/get-location"},{"title":"Unlink charge from a location","deprecated":null,"version":null,"sidebarTitle":"Delete location tx id","openapi":"/pt/openapi/v3-current/spi-brcode.yaml delete /api/v1/brcode/loc/{id}/txid","href":"/pt/reference/rails/spi/brcode/delete-location-tx-id"},{"title":"List recurrence locations","deprecated":null,"version":null,"sidebarTitle":"List location rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/locrec","href":"/pt/reference/rails/spi/brcode/list-location-rec"},{"title":"Create recurrence location","deprecated":null,"version":null,"sidebarTitle":"Create location rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/locrec","href":"/pt/reference/rails/spi/brcode/create-location-rec"},{"title":"Retrieve recurrence location","deprecated":null,"version":null,"sidebarTitle":"Get location rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/locrec/{id}","href":"/pt/reference/rails/spi/brcode/get-location-rec"},{"title":"Unlink recurrence from a location","deprecated":null,"version":null,"sidebarTitle":"Delete location rec id rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml delete /api/v1/brcode/locrec/{id}/idRec","href":"/pt/reference/rails/spi/brcode/delete-location-rec-id-rec"}]},{"group":"BR Code · Lotes de COB V","pages":[{"title":"List due-date charge batches","deprecated":null,"version":null,"sidebarTitle":"List lote cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/lotecobv","href":"/pt/reference/rails/spi/brcode/list-lote-cob-v"},{"title":"Retrieve due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Get lote cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/lotecobv/{id}","href":"/pt/reference/rails/spi/brcode/get-lote-cob-v"},{"title":"Revise due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Patch lote cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/lotecobv/{id}","href":"/pt/reference/rails/spi/brcode/patch-lote-cob-v"},{"title":"Create due-date charge batch","deprecated":null,"version":null,"sidebarTitle":"Put lote cob v","openapi":"/pt/openapi/v3-current/spi-brcode.yaml put /api/v1/brcode/lotecobv/{id}","href":"/pt/reference/rails/spi/brcode/put-lote-cob-v"}]},{"group":"BR Code · Payload de COB V","pages":[{"title":"Resolve CobV payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve cob v payload","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/cobv/{locator}","href":"/pt/reference/rails/spi/brcode/resolve-cob-v-payload"}]},{"group":"BR Code · Payload de REC","pages":[{"title":"Resolve Rec payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve rec payload","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/rec/{recUrlAccessToken}","href":"/pt/reference/rails/spi/brcode/resolve-rec-payload"}]},{"group":"BR Code · Payload de COB","pages":[{"title":"Resolve Cob payload (JWS)","deprecated":null,"version":null,"sidebarTitle":"Resolve cob payload","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/payload/{locator}","href":"/pt/reference/rails/spi/brcode/resolve-cob-payload"}]},{"group":"BR Code · REC","pages":[{"title":"List recurrences (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"List rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/rec","href":"/pt/reference/rails/spi/brcode/list-rec"},{"title":"Create recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Post rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/rec","href":"/pt/reference/rails/spi/brcode/post-rec"},{"title":"Retrieve recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Get rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/rec/{idRec}","href":"/pt/reference/rails/spi/brcode/get-rec"},{"title":"Revise recurrence (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Patch rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/rec/{idRec}","href":"/pt/reference/rails/spi/brcode/patch-rec"}]},{"group":"BR Code · Solic REC","pages":[{"title":"Create recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Post solic rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml post /api/v1/brcode/solicrec","href":"/pt/reference/rails/spi/brcode/post-solic-rec"},{"title":"Retrieve recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Get solic rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/solicrec/{idSolicRec}","href":"/pt/reference/rails/spi/brcode/get-solic-rec"},{"title":"Revise (cancel) recurrence request (Pix Automático)","deprecated":null,"version":null,"sidebarTitle":"Patch solic rec","openapi":"/pt/openapi/v3-current/spi-brcode.yaml patch /api/v1/brcode/solicrec/{idSolicRec}","href":"/pt/reference/rails/spi/brcode/patch-solic-rec"}]},{"group":"Core · Operações","pages":[{"title":"Orchestrate Core operation","deprecated":null,"version":null,"sidebarTitle":"Orchestrate operation","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/operations/","href":"/pt/reference/rails/spi/core/orchestrate-operation"}]},{"group":"Core · Participantes","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/pt/openapi/v3-current/spi-core.yaml get /api/v1/core/participants/","href":"/pt/reference/rails/spi/core/list-participants"},{"title":"Request registration of an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Register participant","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/","href":"/pt/reference/rails/spi/core/register-participant"},{"title":"Register the direct participant this rail operates as","deprecated":null,"version":null,"sidebarTitle":"Register direct participant","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/direct","href":"/pt/reference/rails/spi/core/register-direct-participant"},{"title":"Get participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/pt/openapi/v3-current/spi-core.yaml get /api/v1/core/participants/{ispb}","href":"/pt/reference/rails/spi/core/get-participant"},{"title":"Activate participant","deprecated":null,"version":null,"sidebarTitle":"Activate participant","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/activate","href":"/pt/reference/rails/spi/core/activate-participant"},{"title":"Update the participant's MED 2.0 regulator contact","deprecated":null,"version":null,"sidebarTitle":"Update participant contact","openapi":"/pt/openapi/v3-current/spi-core.yaml put /api/v1/core/participants/{ispb}/contact","href":"/pt/reference/rails/spi/core/update-participant-contact"},{"title":"Offboard participant","deprecated":null,"version":null,"sidebarTitle":"Offboard participant","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/offboard","href":"/pt/reference/rails/spi/core/offboard-participant"},{"title":"Suspend participant","deprecated":null,"version":null,"sidebarTitle":"Suspend participant","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/suspend","href":"/pt/reference/rails/spi/core/suspend-participant"},{"title":"Confirm portability relationship end (reda.031)","deprecated":null,"version":null,"sidebarTitle":"Confirm portability relationship end","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/participants/{ispb}/portability/confirm","href":"/pt/reference/rails/spi/core/confirm-portability-relationship-end"}]},{"group":"Core · Roteamento","pages":[{"title":"Resolve payment routing","deprecated":null,"version":null,"sidebarTitle":"Resolve routing","openapi":"/pt/openapi/v3-current/spi-core.yaml post /api/v1/core/routing/resolve","href":"/pt/reference/rails/spi/core/resolve-routing"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SPI","href":"/pt/reference/rails/spi/spi-error-list"}]}]},{"dropdown":"SLC","icon":"credit-card","description":"Mensageria de liquidação de cartões no trilho SLC","groups":[{"group":"Administração","pages":[{"title":"List effective tenant config","deprecated":null,"version":null,"sidebarTitle":"List tenant config","openapi":"/pt/openapi/v3-current/slc.yaml get /admin/config","href":"/pt/reference/rails/slc/list-tenant-config"},{"title":"Reset one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Reset tenant config","openapi":"/pt/openapi/v3-current/slc.yaml delete /admin/config/{key}","href":"/pt/reference/rails/slc/reset-tenant-config"},{"title":"Get one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Get tenant config","openapi":"/pt/openapi/v3-current/slc.yaml get /admin/config/{key}","href":"/pt/reference/rails/slc/get-tenant-config"},{"title":"Set one tenant config key","deprecated":null,"version":null,"sidebarTitle":"Set tenant config","openapi":"/pt/openapi/v3-current/slc.yaml put /admin/config/{key}","href":"/pt/reference/rails/slc/set-tenant-config"},{"title":"List dead letters","deprecated":null,"version":null,"sidebarTitle":"List dead letters","openapi":"/pt/openapi/v3-current/slc.yaml get /admin/dlq/{queue}","href":"/pt/reference/rails/slc/list-dead-letters"},{"title":"Replay a dead letter","deprecated":null,"version":null,"sidebarTitle":"Replay dead letter","openapi":"/pt/openapi/v3-current/slc.yaml post /admin/dlq/{queue}/{id}/replay","href":"/pt/reference/rails/slc/replay-dead-letter"},{"title":"Redispatch an outbox entry","deprecated":null,"version":null,"sidebarTitle":"Redispatch outbox entry","openapi":"/pt/openapi/v3-current/slc.yaml post /admin/outbox/{id}/redispatch","href":"/pt/reference/rails/slc/redispatch-outbox-entry"}]},{"group":"Compensação","pages":[{"title":"List clearing positions","deprecated":null,"version":null,"sidebarTitle":"List clearing positions","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/clearing/positions","href":"/pt/reference/rails/slc/list-clearing-positions"}]},{"group":"Grade de liquidação","pages":[{"title":"Get the settlement grid this instance is enforcing","deprecated":null,"version":null,"sidebarTitle":"Get schedule","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/schedule","href":"/pt/reference/rails/slc/get-schedule"}]},{"group":"Aporte","pages":[{"title":"List recorded client deposit acks across settlement instructions","deprecated":null,"version":null,"sidebarTitle":"List funding acks","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/funding/acks","href":"/pt/reference/rails/slc/list-funding-acks"},{"title":"Record a client settlement-deposit ack","deprecated":null,"version":null,"sidebarTitle":"Record funding ack","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/funding/settlement-instructions/{instructionId}/ack","href":"/pt/reference/rails/slc/record-funding-ack"},{"title":"List the client deposit acks recorded for a settlement instruction","deprecated":null,"version":null,"sidebarTitle":"List settlement instruction acks","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/funding/settlement-instructions/{instructionId}/acks","href":"/pt/reference/rails/slc/list-settlement-instruction-acks"}]},{"group":"LBTR","pages":[{"title":"List the settlement results the câmara announced","deprecated":null,"version":null,"sidebarTitle":"List lbtr results","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/results","href":"/pt/reference/rails/slc/list-lbtr-results"},{"title":"Read one announced settlement result","deprecated":null,"version":null,"sidebarTitle":"Get lbtr result","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/results/{resultId}","href":"/pt/reference/rails/slc/get-lbtr-result"},{"title":"Confirm or diverge from an announced settlement result","deprecated":null,"version":null,"sidebarTitle":"Decide lbtr result","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/lbtr/results/{resultId}/decision","href":"/pt/reference/rails/slc/decide-lbtr-result"},{"title":"List the announced operations between this bank's own non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"List lbtr non settlor operations","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/nonliquidante-operations","href":"/pt/reference/rails/slc/list-lbtr-non-settlor-operations"},{"title":"Read one announced operation between two non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"Get lbtr non settlor operation","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/nonliquidante-operations/{operationId}","href":"/pt/reference/rails/slc/get-lbtr-non-settlor-operation"},{"title":"Confirm or reject an announced operation between two non-liquidantes","deprecated":null,"version":null,"sidebarTitle":"Decide lbtr non settlor operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/lbtr/nonliquidante-operations/{operationId}/decision","href":"/pt/reference/rails/slc/decide-lbtr-non-settlor-operation"},{"title":"Ask the câmara for this institution's LBTR position","deprecated":null,"version":null,"sidebarTitle":"Submit lbtr position query","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/lbtr/position-queries","href":"/pt/reference/rails/slc/submit-lbtr-position-query"},{"title":"List the commands this institution sent to the câmara","deprecated":null,"version":null,"sidebarTitle":"List lbtr commands","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/commands","href":"/pt/reference/rails/slc/list-lbtr-commands"},{"title":"Read one command and the câmara's answer to it","deprecated":null,"version":null,"sidebarTitle":"Get lbtr command","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/lbtr/commands/{commandId}","href":"/pt/reference/rails/slc/get-lbtr-command"}]},{"group":"Conectividade","pages":[{"title":"List cancellation repasses awaiting manual reconciliation","deprecated":null,"version":null,"sidebarTitle":"List cancellation relay intents","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/connectivity/cancellation-relay-intents","href":"/pt/reference/rails/slc/list-cancellation-relay-intents"},{"title":"Record what was established about an unresolved cancellation repasse","deprecated":null,"version":null,"sidebarTitle":"Resolve cancellation relay intents","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/cancellation-relay-intents/resolve","href":"/pt/reference/rails/slc/resolve-cancellation-relay-intents"},{"title":"Trigger a credit-dispatch catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery dispatch","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/dispatch","href":"/pt/reference/rails/slc/recovery-dispatch"},{"title":"Trigger an ASLC022 forward-to-domicile catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery forward","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/forward","href":"/pt/reference/rails/slc/recovery-forward"},{"title":"Un-park operations held after exhausting their outbound attempt budget","deprecated":null,"version":null,"sidebarTitle":"Recovery unpark","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/unpark","href":"/pt/reference/rails/slc/recovery-unpark"},{"title":"Retransmit a QUEUED operation","deprecated":null,"version":null,"sidebarTitle":"Connectivity retransmit operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/operations/{id}/retransmit","href":"/pt/reference/rails/slc/connectivity-retransmit-operation"},{"title":"Report an operation's transmission status","deprecated":null,"version":null,"sidebarTitle":"Connectivity operation transmission status","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/connectivity/operations/{id}/transmission-status","href":"/pt/reference/rails/slc/connectivity-operation-transmission-status"},{"title":"Trigger a return-poll catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery repoll","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/repoll","href":"/pt/reference/rails/slc/recovery-repoll"},{"title":"Reprocess pending returns for one participant","deprecated":null,"version":null,"sidebarTitle":"Recovery reprocess","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/reprocess/{participantIspb}","href":"/pt/reference/rails/slc/recovery-reprocess"},{"title":"Trigger an ASLC028 status-relay catch-up drain","deprecated":null,"version":null,"sidebarTitle":"Recovery status relay","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/connectivity/status-relay","href":"/pt/reference/rails/slc/recovery-status-relay"},{"title":"Test connectivity to Núclea for a participant","deprecated":null,"version":null,"sidebarTitle":"Test connectivity","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/participants/{participantIspb}/test-connectivity","href":"/pt/reference/rails/slc/test-connectivity"}]},{"group":"Operações","pages":[{"title":"List settlement operations","deprecated":null,"version":null,"sidebarTitle":"List operations","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/operations","href":"/pt/reference/rails/slc/list-operations"},{"title":"Create a settlement operation","deprecated":null,"version":null,"sidebarTitle":"Create operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations","href":"/pt/reference/rails/slc/create-operation"},{"title":"Cancel a pending settlement operation","deprecated":null,"version":null,"sidebarTitle":"Cancel operation","openapi":"/pt/openapi/v3-current/slc.yaml delete /v1/operations/{operationId}","href":"/pt/reference/rails/slc/cancel-operation"},{"title":"Get a settlement operation","deprecated":null,"version":null,"sidebarTitle":"Get operation","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/operations/{operationId}","href":"/pt/reference/rails/slc/get-operation"},{"title":"Advance an operation via audited admin override","deprecated":null,"version":null,"sidebarTitle":"Advance operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/advance","href":"/pt/reference/rails/slc/advance-operation"},{"title":"Get operation state history","deprecated":null,"version":null,"sidebarTitle":"Get operation history","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/operations/{operationId}/history","href":"/pt/reference/rails/slc/get-operation-history"},{"title":"Reconcile an operation against the counterpart's settlement status","deprecated":null,"version":null,"sidebarTitle":"Reconcile operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/reconcile","href":"/pt/reference/rails/slc/reconcile-operation"},{"title":"Re-queue a stuck operation","deprecated":null,"version":null,"sidebarTitle":"Requeue operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/requeue","href":"/pt/reference/rails/slc/requeue-operation"},{"title":"Retry a rejected operation","deprecated":null,"version":null,"sidebarTitle":"Retry operation","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations/{operationId}/retry","href":"/pt/reference/rails/slc/retry-operation"},{"title":"Submit a batch of settlement operations","deprecated":null,"version":null,"sidebarTitle":"Create operations batch","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/operations/batch","href":"/pt/reference/rails/slc/create-operations-batch"},{"title":"Look up an operation by NUliquid","deprecated":null,"version":null,"sidebarTitle":"Get operation by n uliquid","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/operations/nuliquid/{nuliquid}","href":"/pt/reference/rails/slc/get-operation-by-n-uliquid"}]},{"group":"Arquivos","pages":[{"title":"Intake an ASLC file","deprecated":null,"version":null,"sidebarTitle":"Intake file","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/files","href":"/pt/reference/rails/slc/intake-file"},{"title":"Get a file status","deprecated":null,"version":null,"sidebarTitle":"Get file","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/files/{id}","href":"/pt/reference/rails/slc/get-file"}]},{"group":"Participantes","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/participants","href":"/pt/reference/rails/slc/list-participants"},{"title":"Create a participant","deprecated":null,"version":null,"sidebarTitle":"Create participant","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/participants","href":"/pt/reference/rails/slc/create-participant"},{"title":"Delete a participant","deprecated":null,"version":null,"sidebarTitle":"Delete participant","openapi":"/pt/openapi/v3-current/slc.yaml delete /v1/participants/{id}","href":"/pt/reference/rails/slc/delete-participant"},{"title":"Get a participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/participants/{id}","href":"/pt/reference/rails/slc/get-participant"},{"title":"Update a participant","deprecated":null,"version":null,"sidebarTitle":"Update participant","openapi":"/pt/openapi/v3-current/slc.yaml put /v1/participants/{id}","href":"/pt/reference/rails/slc/update-participant"},{"title":"Get a participant's operational status","deprecated":null,"version":null,"sidebarTitle":"Get participant operational status","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/participants/{id}/operational-status","href":"/pt/reference/rails/slc/get-participant-operational-status"}]},{"group":"Arranjos","pages":[{"title":"List a participant's arrangements","deprecated":null,"version":null,"sidebarTitle":"List arrangements","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/participants/{id}/arrangements","href":"/pt/reference/rails/slc/list-arrangements"},{"title":"Create an arrangement","deprecated":null,"version":null,"sidebarTitle":"Create arrangement","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/participants/{id}/arrangements","href":"/pt/reference/rails/slc/create-arrangement"},{"title":"Delete an arrangement","deprecated":null,"version":null,"sidebarTitle":"Delete arrangement","openapi":"/pt/openapi/v3-current/slc.yaml delete /v1/participants/{id}/arrangements/{arrangementId}","href":"/pt/reference/rails/slc/delete-arrangement"},{"title":"Get an arrangement","deprecated":null,"version":null,"sidebarTitle":"Get arrangement","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/participants/{id}/arrangements/{arrangementId}","href":"/pt/reference/rails/slc/get-arrangement"},{"title":"Update an arrangement","deprecated":null,"version":null,"sidebarTitle":"Update arrangement","openapi":"/pt/openapi/v3-current/slc.yaml put /v1/participants/{id}/arrangements/{arrangementId}","href":"/pt/reference/rails/slc/update-arrangement"}]},{"group":"Relatórios","pages":[{"title":"List generated reports","deprecated":null,"version":null,"sidebarTitle":"List reports","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/reports","href":"/pt/reference/rails/slc/list-reports"}]},{"group":"Chaves de assinatura","pages":[{"title":"Complete a BYOK Model-A signing-key import (SaaS)","deprecated":null,"version":null,"sidebarTitle":"Signing key import","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/signing-key","href":"/pt/reference/rails/slc/signing-key-import"},{"title":"Start a BYOK Model-A signing-key import (SaaS)","deprecated":null,"version":null,"sidebarTitle":"Signing key import params","openapi":"/pt/openapi/v3-current/slc.yaml post /v1/signing-key/import-params","href":"/pt/reference/rails/slc/signing-key-import-params"}]},{"group":"Esquemas XSD","pages":[{"title":"List embedded XSD schema types","deprecated":null,"version":null,"sidebarTitle":"List xsd schemas","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/xsd-schemas","href":"/pt/reference/rails/slc/list-xsd-schemas"},{"title":"Get one embedded XSD schema","deprecated":null,"version":null,"sidebarTitle":"Get xsd schema","openapi":"/pt/openapi/v3-current/slc.yaml get /v1/xsd-schemas/{type}","href":"/pt/reference/rails/slc/get-xsd-schema"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/pt/openapi/v3-current/slc.yaml get /webhooks","href":"/pt/reference/rails/slc/list-webhooks"},{"title":"Register a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/pt/openapi/v3-current/slc.yaml post /webhooks","href":"/pt/reference/rails/slc/create-webhook"},{"title":"Deactivate a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Delete webhook","openapi":"/pt/openapi/v3-current/slc.yaml delete /webhooks/{id}","href":"/pt/reference/rails/slc/delete-webhook"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/pt/openapi/v3-current/slc.yaml put /webhooks/{id}","href":"/pt/reference/rails/slc/update-webhook"},{"title":"List a webhook's delivery history","deprecated":null,"version":null,"sidebarTitle":"List webhook deliveries","openapi":"/pt/openapi/v3-current/slc.yaml get /webhooks/{id}/deliveries","href":"/pt/reference/rails/slc/list-webhook-deliveries"},{"title":"Replay a failed webhook delivery","deprecated":null,"version":null,"sidebarTitle":"Replay webhook delivery","openapi":"/pt/openapi/v3-current/slc.yaml post /webhooks/{id}/deliveries/{deliveryId}/replay","href":"/pt/reference/rails/slc/replay-webhook-delivery"},{"title":"Send a synthetic test event to a webhook","deprecated":null,"version":null,"sidebarTitle":"Test webhook","openapi":"/pt/openapi/v3-current/slc.yaml post /webhooks/{id}/test","href":"/pt/reference/rails/slc/test-webhook"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SLC","href":"/pt/reference/rails/slc/slc-error-list"}]}]},{"dropdown":"SILOC","icon":"barcode","description":"Mensageria de liquidação diferida no SILOC","groups":[{"group":"Integração","pages":[{"title":"List settlement-coverage capabilities","deprecated":null,"version":null,"sidebarTitle":"List capabilities","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/capabilities","href":"/pt/reference/rails/siloc/list-capabilities"},{"title":"Get notification configuration","deprecated":null,"version":null,"sidebarTitle":"Get notification config","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/notifications/config","href":"/pt/reference/rails/siloc/get-notification-config"},{"title":"Update notification configuration","deprecated":null,"version":null,"sidebarTitle":"Update notification config","openapi":"/pt/openapi/v3-current/siloc.yaml put /api/v1/siloc/notifications/config","href":"/pt/reference/rails/siloc/update-notification-config"}]},{"group":"Conectividade","pages":[{"title":"List regulated certificates","deprecated":null,"version":null,"sidebarTitle":"List certificates","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/certificates","href":"/pt/reference/rails/siloc/list-certificates"},{"title":"Register a certificate reference","deprecated":null,"version":null,"sidebarTitle":"Register certificate","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/certificates","href":"/pt/reference/rails/siloc/register-certificate"},{"title":"Get a certificate","deprecated":null,"version":null,"sidebarTitle":"Get certificate","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/certificates/{certificateId}","href":"/pt/reference/rails/siloc/get-certificate"},{"title":"Revoke a certificate","deprecated":null,"version":null,"sidebarTitle":"Revoke certificate","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/certificates/{certificateId}/revoke","href":"/pt/reference/rails/siloc/revoke-certificate"},{"title":"List parked relay failures","deprecated":null,"version":null,"sidebarTitle":"List relay failures","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/relay-failures","href":"/pt/reference/rails/siloc/list-relay-failures"},{"title":"Replay a parked relay failure","deprecated":null,"version":null,"sidebarTitle":"Replay relay failure","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/dlq/relay-failures/{id}/replay","href":"/pt/reference/rails/siloc/replay-relay-failure"},{"title":"List relayed card-domain messages","deprecated":null,"version":null,"sidebarTitle":"List relayed messages","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/relay/messages","href":"/pt/reference/rails/siloc/list-relayed-messages"},{"title":"Get the card-domain relay status","deprecated":null,"version":null,"sidebarTitle":"Get relay status","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/relay/status","href":"/pt/reference/rails/siloc/get-relay-status"},{"title":"List parked deferred inbound messages","deprecated":null,"version":null,"sidebarTitle":"List parked deferred inbound messages","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/deferred","href":"/pt/reference/rails/siloc/list-parked-deferred-inbound-messages"},{"title":"List quarantined inbound frames","deprecated":null,"version":null,"sidebarTitle":"List quarantined inbound frames","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/dlq/quarantine","href":"/pt/reference/rails/siloc/list-quarantined-inbound-frames"},{"title":"Resolve a quarantined inbound frame","deprecated":null,"version":null,"sidebarTitle":"Resolve a quarantined inbound frame","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/dlq/quarantine/{id}/resolve","href":"/pt/reference/rails/siloc/resolve-a-quarantined-inbound-frame"}]},{"group":"Homologação","pages":[{"title":"List homologation scenarios","deprecated":null,"version":null,"sidebarTitle":"List homologation scenarios","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios","href":"/pt/reference/rails/siloc/list-homologation-scenarios"},{"title":"Get a homologation scenario","deprecated":null,"version":null,"sidebarTitle":"Get a homologation scenario","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios/{scenarioId}","href":"/pt/reference/rails/siloc/get-a-homologation-scenario"},{"title":"Run a homologation scenario","deprecated":null,"version":null,"sidebarTitle":"Run a homologation scenario","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/homologation/scenarios/{scenarioId}/runs","href":"/pt/reference/rails/siloc/run-a-homologation-scenario"},{"title":"List a homologation scenario's runs","deprecated":null,"version":null,"sidebarTitle":"List a homologation scenario s runs","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/homologation/scenarios/{scenarioId}/runs","href":"/pt/reference/rails/siloc/list-a-homologation-scenario-s-runs"}]},{"group":"Participantes","pages":[{"title":"List participants","deprecated":null,"version":null,"sidebarTitle":"List participants","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants","href":"/pt/reference/rails/siloc/list-participants"},{"title":"Register a participant","deprecated":null,"version":null,"sidebarTitle":"Register participant","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/participants","href":"/pt/reference/rails/siloc/register-participant"},{"title":"Get a participant","deprecated":null,"version":null,"sidebarTitle":"Get participant","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants/{participantId}","href":"/pt/reference/rails/siloc/get-participant"},{"title":"Update a participant","deprecated":null,"version":null,"sidebarTitle":"Update participant","openapi":"/pt/openapi/v3-current/siloc.yaml put /api/v1/siloc/participants/{participantId}","href":"/pt/reference/rails/siloc/update-participant"},{"title":"Get a participant's operational status","deprecated":null,"version":null,"sidebarTitle":"Get participant status","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/participants/{participantId}/status","href":"/pt/reference/rails/siloc/get-participant-status"},{"title":"Request this participant to become operante","deprecated":null,"version":null,"sidebarTitle":"Request this participant to become operante","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/operative-status-changes","href":"/pt/reference/rails/siloc/request-this-participant-to-become-operante"},{"title":"Read one PAG0202 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0202 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/operative-status-changes/{id}","href":"/pt/reference/rails/siloc/read-one-pag0202-instruction-and-its-answer"},{"title":"Request this participant to become inoperante","deprecated":null,"version":null,"sidebarTitle":"Request this participant to become inoperante","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/inoperative-status-changes","href":"/pt/reference/rails/siloc/request-this-participant-to-become-inoperante"},{"title":"Read one PAG0201 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0201 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/inoperative-status-changes/{id}","href":"/pt/reference/rails/siloc/read-one-pag0201-instruction-and-its-answer"},{"title":"Withdraw a situação change registered in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Cancel status change","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/status-change-cancellations","href":"/pt/reference/rails/siloc/cancel-status-change"},{"title":"Read one PAG0203 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0203 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/status-change-cancellations/{id}","href":"/pt/reference/rails/siloc/read-one-pag0203-instruction-and-its-answer"}]},{"group":"Ciclos e liquidação","pages":[{"title":"List OT settlement cycles","deprecated":null,"version":null,"sidebarTitle":"List cycles","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles","href":"/pt/reference/rails/siloc/list-cycles"},{"title":"Get an OT settlement cycle","deprecated":null,"version":null,"sidebarTitle":"Get cycle","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}","href":"/pt/reference/rails/siloc/get-cycle"},{"title":"Get a cycle's reconciliation result","deprecated":null,"version":null,"sidebarTitle":"Get cycle reconciliation","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}/reconciliation","href":"/pt/reference/rails/siloc/get-cycle-reconciliation"},{"title":"Get a cycle's recálculo round chain","deprecated":null,"version":null,"sidebarTitle":"Get cycle recalculations","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/cycles/{cycleId}/recalculations","href":"/pt/reference/rails/siloc/get-cycle-recalculations"},{"title":"List OT settlement instructions (obligations)","deprecated":null,"version":null,"sidebarTitle":"List settlement instructions","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions","href":"/pt/reference/rails/siloc/list-settlement-instructions"},{"title":"Get an OT settlement instruction","deprecated":null,"version":null,"sidebarTitle":"Get settlement instruction","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/settlement-instructions/{instructionId}","href":"/pt/reference/rails/siloc/get-settlement-instruction"},{"title":"List the SILOC câmara's official multilateral results","deprecated":null,"version":null,"sidebarTitle":"List the siloc camaras official multilateral results","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/ot-multilateral-results","href":"/pt/reference/rails/siloc/list-the-siloc-camaras-official-multilateral-results"},{"title":"Confirm or dispute the day's net result","deprecated":null,"version":null,"sidebarTitle":"Confirm or dispute the day s net result","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/net-result-confirmations","href":"/pt/reference/rails/siloc/confirm-or-dispute-the-day-s-net-result"},{"title":"Read one LDL0003 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0003 command and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/net-result-confirmations/{id}","href":"/pt/reference/rails/siloc/read-one-ldl0003-command-and-its-answer"},{"title":"Ask the câmara for the net position","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for the net position","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/net-position-queries","href":"/pt/reference/rails/siloc/ask-the-camara-for-the-net-position"},{"title":"Read one LDL0026 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0026 command and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/net-position-queries/{id}","href":"/pt/reference/rails/siloc/read-one-ldl0026-command-and-its-answer"},{"title":"Withdraw balance from the settlement account","deprecated":null,"version":null,"sidebarTitle":"Withdraw balance from the settlement account","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/camara-withdrawals","href":"/pt/reference/rails/siloc/withdraw-balance-from-the-settlement-account"},{"title":"Read one LDL0032 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl0032 command and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/camara-withdrawals/{id}","href":"/pt/reference/rails/siloc/read-one-ldl0032-command-and-its-answer"},{"title":"List câmara bilateral settlement balances","deprecated":null,"version":null,"sidebarTitle":"List camara bilateral settlement balances","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/bilateral-balances","href":"/pt/reference/rails/siloc/list-camara-bilateral-settlement-balances"}]},{"group":"Transferências","pages":[{"title":"Transfer funds between client accounts","deprecated":null,"version":null,"sidebarTitle":"Transfer funds between client accounts","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/client-account-transfers","href":"/pt/reference/rails/siloc/transfer-funds-between-client-accounts"},{"title":"Read one PAG0108 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0108 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/client-account-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0108-instruction-and-its-answer"},{"title":"Transfer funds on behalf of a non-account holder","deprecated":null,"version":null,"sidebarTitle":"Transfer funds on behalf of a non account holder","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/non-account-holder-transfers","href":"/pt/reference/rails/siloc/transfer-funds-on-behalf-of-a-non-account-holder"},{"title":"Read one PAG0107 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0107 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/non-account-holder-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0107-instruction-and-its-answer"},{"title":"Transfer funds for a client at a non-reserve-holding institution","deprecated":null,"version":null,"sidebarTitle":"Transfer to non reserve institution","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/non-reserve-institution-transfers","href":"/pt/reference/rails/siloc/transfer-to-non-reserve-institution"},{"title":"Read one PAG0134 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0134 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/non-reserve-institution-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0134-instruction-and-its-answer"},{"title":"Transfer funds from a client to an institution for a retail operation","deprecated":null,"version":null,"sidebarTitle":"Transfer retail client to institution","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/retail-client-to-institution-transfers","href":"/pt/reference/rails/siloc/transfer-retail-client-to-institution"},{"title":"Read one PAG0142 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0142 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/retail-client-to-institution-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0142-instruction-and-its-answer"},{"title":"Transfer funds from an institution to a client for a retail operation","deprecated":null,"version":null,"sidebarTitle":"Transfer retail institution to client","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/retail-institution-to-client-transfers","href":"/pt/reference/rails/siloc/transfer-retail-institution-to-client"},{"title":"Read one PAG0143 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0143 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/retail-institution-to-client-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0143-instruction-and-its-answer"},{"title":"Transfer funds out of a salary account","deprecated":null,"version":null,"sidebarTitle":"Transfer funds out of a salary account","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/salary-account-transfers","href":"/pt/reference/rails/siloc/transfer-funds-out-of-a-salary-account"},{"title":"Read one PAG0137 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0137 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/salary-account-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0137-instruction-and-its-answer"},{"title":"Transfer funds for a payroll-loan credit","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a payroll loan credit","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/payroll-loan-credit-transfers","href":"/pt/reference/rails/siloc/transfer-funds-for-a-payroll-loan-credit"},{"title":"Read one PAG0141 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0141 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/payroll-loan-credit-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0141-instruction-and-its-answer"},{"title":"Transfer funds for a judicial deposit","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a judicial deposit","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/judicial-deposit-transfers","href":"/pt/reference/rails/siloc/transfer-funds-for-a-judicial-deposit"},{"title":"Read one PAG0121 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0121 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/judicial-deposit-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0121-instruction-and-its-answer"},{"title":"Transfer funds for a judicial release","deprecated":null,"version":null,"sidebarTitle":"Transfer funds for a judicial release","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/judicial-release-transfers","href":"/pt/reference/rails/siloc/transfer-funds-for-a-judicial-release"},{"title":"Read one PAG0151 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0151 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/judicial-release-transfers/{id}","href":"/pt/reference/rails/siloc/read-one-pag0151-instruction-and-its-answer"},{"title":"Transfer funds to settle a barcoded document","deprecated":null,"version":null,"sidebarTitle":"Transfer funds to settle a barcoded document","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/barcode-document-settlements","href":"/pt/reference/rails/siloc/transfer-funds-to-settle-a-barcoded-document"},{"title":"Read one PAG0122 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0122 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/barcode-document-settlements/{id}","href":"/pt/reference/rails/siloc/read-one-pag0122-instruction-and-its-answer"},{"title":"Return funds received in error","deprecated":null,"version":null,"sidebarTitle":"Return funds received in error","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/undue-transfer-refunds","href":"/pt/reference/rails/siloc/return-funds-received-in-error"},{"title":"Read one PAG0111 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0111 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/undue-transfer-refunds/{id}","href":"/pt/reference/rails/siloc/read-one-pag0111-instruction-and-its-answer"}]},{"group":"Garantias","pages":[{"title":"List câmara collateral advisories","deprecated":null,"version":null,"sidebarTitle":"List camara collateral advisories","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/collateral/advisories","href":"/pt/reference/rails/siloc/list-camara-collateral-advisories"},{"title":"Query the assets the câmara accepts as collateral","deprecated":null,"version":null,"sidebarTitle":"Query the assets the camara accepts as collateral","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/eligible-collateral-queries","href":"/pt/reference/rails/siloc/query-the-assets-the-camara-accepts-as-collateral"},{"title":"Read one LDL1013 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1013 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/eligible-collateral-queries/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1013-request-and-its-answer"},{"title":"Ask the câmara to accept a collateral deposit","deprecated":null,"version":null,"sidebarTitle":"Ask the camara to accept a collateral deposit","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposit-acceptance-requests","href":"/pt/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-deposit"},{"title":"Read one LDL1002 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1002 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposit-acceptance-requests/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1002-request-and-its-answer"},{"title":"Request a collateral deposit the câmara already accepted","deprecated":null,"version":null,"sidebarTitle":"Request collateral deposit","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposit-requests","href":"/pt/reference/rails/siloc/request-collateral-deposit"},{"title":"Read one LDL1003 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1003 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposit-requests/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1003-request-and-its-answer"},{"title":"Query the assets deposited at the câmara","deprecated":null,"version":null,"sidebarTitle":"Query the assets deposited at the camara","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/deposited-asset-queries","href":"/pt/reference/rails/siloc/query-the-assets-deposited-at-the-camara"},{"title":"Read one LDL1012 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1012 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/deposited-asset-queries/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1012-request-and-its-answer"},{"title":"Move collateral between holders or purposes","deprecated":null,"version":null,"sidebarTitle":"Move collateral between holders or purposes","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/collateral-movements","href":"/pt/reference/rails/siloc/move-collateral-between-holders-or-purposes"},{"title":"Read one LDL1016 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1016 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/collateral-movements/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1016-request-and-its-answer"},{"title":"Move one holder's collateral by asset number","deprecated":null,"version":null,"sidebarTitle":"Move one holder s collateral by asset number","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/same-holder-collateral-movements","href":"/pt/reference/rails/siloc/move-one-holder-s-collateral-by-asset-number"},{"title":"Read one LDL1017 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1017 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/same-holder-collateral-movements/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1017-request-and-its-answer"},{"title":"Ask the câmara to accept a collateral withdrawal","deprecated":null,"version":null,"sidebarTitle":"Ask the camara to accept a collateral withdrawal","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/withdrawal-acceptance-requests","href":"/pt/reference/rails/siloc/ask-the-camara-to-accept-a-collateral-withdrawal"},{"title":"Read one LDL1006 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1006 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/withdrawal-acceptance-requests/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1006-request-and-its-answer"},{"title":"Confirm a guarantee issuance or amendment","deprecated":null,"version":null,"sidebarTitle":"Confirm a guarantee issuance or amendment","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/guarantee-issuance-confirmations","href":"/pt/reference/rails/siloc/confirm-a-guarantee-issuance-or-amendment"},{"title":"Read one LDL1019 command and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1019 command and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/guarantee-issuance-confirmations/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1019-command-and-its-answer"},{"title":"Ask to amend a guarantee's maturity or amount","deprecated":null,"version":null,"sidebarTitle":"Ask to amend a guarantee s maturity or amount","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/guarantee-maturity-amendments","href":"/pt/reference/rails/siloc/ask-to-amend-a-guarantee-s-maturity-or-amount"},{"title":"Read one LDL1010 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1010 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/guarantee-maturity-amendments/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1010-request-and-its-answer"},{"title":"Query the reference prices the câmara used on a day","deprecated":null,"version":null,"sidebarTitle":"Query reference prices","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/price-history-queries","href":"/pt/reference/rails/siloc/query-reference-prices"},{"title":"Read one LDL1015 request and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one ldl1015 request and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/price-history-queries/{id}","href":"/pt/reference/rails/siloc/read-one-ldl1015-request-and-its-answer"}]},{"group":"Rota de cartões","pages":[{"title":"List the card-route commands Lerian SLC issued","deprecated":null,"version":null,"sidebarTitle":"List the card route commands lerian slc issued","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/card-commands","href":"/pt/reference/rails/siloc/list-the-card-route-commands-lerian-slc-issued"},{"title":"Read one card-route command","deprecated":null,"version":null,"sidebarTitle":"Read one card route command","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/card-commands/{id}","href":"/pt/reference/rails/siloc/read-one-card-route-command"},{"title":"Confirm or diverge from an announced LBTR result","deprecated":null,"version":null,"sidebarTitle":"Confirm or diverge from an announced lbtr result","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-result-decisions","href":"/pt/reference/rails/siloc/confirm-or-diverge-from-an-announced-lbtr-result"},{"title":"Read one LTR0002 decision and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0002 decision and its state","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-result-decisions/{id}","href":"/pt/reference/rails/siloc/read-one-ltr0002-decision-and-its-state"},{"title":"Confirm or reject a settlement between two non-settling members","deprecated":null,"version":null,"sidebarTitle":"Decide non settling member settlement","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-nonliquidante-decisions","href":"/pt/reference/rails/siloc/decide-non-settling-member-settlement"},{"title":"Read one LTR0008 decision and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0008 decision and its state","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-nonliquidante-decisions/{id}","href":"/pt/reference/rails/siloc/read-one-ltr0008-decision-and-its-state"},{"title":"Ask the câmara for the institution's LBTR position","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for the institution s lbtr position","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/ltr-position-queries","href":"/pt/reference/rails/siloc/ask-the-camara-for-the-institution-s-lbtr-position"},{"title":"Read one LTR0009 query and its state","deprecated":null,"version":null,"sidebarTitle":"Read one ltr0009 query and its state","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/ltr-position-queries/{id}","href":"/pt/reference/rails/siloc/read-one-ltr0009-query-and-its-state"}]},{"group":"Lançamentos e extratos","pages":[{"title":"Query the entries the Câmara PAG holds","deprecated":null,"version":null,"sidebarTitle":"Query the entries the camara pag holds","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/entry-queries","href":"/pt/reference/rails/siloc/query-the-entries-the-camara-pag-holds"},{"title":"Read one PAG0113 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0113 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/entry-queries/{id}","href":"/pt/reference/rails/siloc/read-one-pag0113-instruction-and-its-answer"},{"title":"Cancel a pending entry in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Cancel a pending entry in the camara pag","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/pending-entry-cancellations","href":"/pt/reference/rails/siloc/cancel-a-pending-entry-in-the-camara-pag"},{"title":"Read one PAG0112 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0112 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/pending-entry-cancellations/{id}","href":"/pt/reference/rails/siloc/read-one-pag0112-instruction-and-its-answer"},{"title":"Query the synthetic statement in the Câmara PAG","deprecated":null,"version":null,"sidebarTitle":"Query the synthetic statement in the camara pag","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/synthetic-statement-queries","href":"/pt/reference/rails/siloc/query-the-synthetic-statement-in-the-camara-pag"},{"title":"Read one PAG0114 instruction and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one pag0114 instruction and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/synthetic-statement-queries/{id}","href":"/pt/reference/rails/siloc/read-one-pag0114-instruction-and-its-answer"}]},{"group":"Avisos e notificações","pages":[{"title":"List the advices the SILOC câmara sent this institution","deprecated":null,"version":null,"sidebarTitle":"List camara advices","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/advices","href":"/pt/reference/rails/siloc/list-camara-advices"},{"title":"List the PAG transfer credit notices the câmara sent this institution","deprecated":null,"version":null,"sidebarTitle":"List transfer credit notices","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/advices/transfer-credit-notices","href":"/pt/reference/rails/siloc/list-transfer-credit-notices"},{"title":"List file-availability notices from other participants","deprecated":null,"version":null,"sidebarTitle":"List file notices","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/file-notices","href":"/pt/reference/rails/siloc/list-file-notices"}]},{"group":"Alertas e auditoria","pages":[{"title":"List operational alerts","deprecated":null,"version":null,"sidebarTitle":"List alerts","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/alerts","href":"/pt/reference/rails/siloc/list-alerts"},{"title":"Acknowledge an operational alert","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an operational alert","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/alerts/{id}/acknowledge","href":"/pt/reference/rails/siloc/acknowledge-an-operational-alert"},{"title":"List audit records","deprecated":null,"version":null,"sidebarTitle":"List audit records","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/audit-records","href":"/pt/reference/rails/siloc/list-audit-records"},{"title":"List outbound messages of every code","deprecated":null,"version":null,"sidebarTitle":"List outbound messages of every code","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/messages","href":"/pt/reference/rails/siloc/list-outbound-messages-of-every-code"},{"title":"Read one outbound message, whatever its code","deprecated":null,"version":null,"sidebarTitle":"Read one outbound message whatever its code","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/messages/{id}","href":"/pt/reference/rails/siloc/read-one-outbound-message-whatever-its-code"}]},{"group":"Agendamento","pages":[{"title":"Get the business-day calendar","deprecated":null,"version":null,"sidebarTitle":"Get business day calendar","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/calendar","href":"/pt/reference/rails/siloc/get-business-day-calendar"},{"title":"List OT cycle windows","deprecated":null,"version":null,"sidebarTitle":"List schedule windows","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/windows","href":"/pt/reference/rails/siloc/list-schedule-windows"},{"title":"Record a contingency schedule change","deprecated":null,"version":null,"sidebarTitle":"Record schedule change","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/schedule/changes","href":"/pt/reference/rails/siloc/record-schedule-change"},{"title":"List contingency schedule changes","deprecated":null,"version":null,"sidebarTitle":"List schedule changes","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/changes","href":"/pt/reference/rails/siloc/list-schedule-changes"},{"title":"List the grades de horário the câmara published","deprecated":null,"version":null,"sidebarTitle":"List schedule grids","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/grids","href":"/pt/reference/rails/siloc/list-schedule-grids"},{"title":"Get the câmara's last session announcements","deprecated":null,"version":null,"sidebarTitle":"Get the camara s last session announcements","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/schedule/camara-session","href":"/pt/reference/rails/siloc/get-the-camara-s-last-session-announcements"},{"title":"Ask the câmara for its LDL schedule grid","deprecated":null,"version":null,"sidebarTitle":"Ask the camara for its ldl schedule grid","openapi":"/pt/openapi/v3-current/siloc.yaml post /api/v1/siloc/outbound/schedule-queries","href":"/pt/reference/rails/siloc/ask-the-camara-for-its-ldl-schedule-grid"},{"title":"Read one schedule query and its answer","deprecated":null,"version":null,"sidebarTitle":"Read one schedule query and its answer","openapi":"/pt/openapi/v3-current/siloc.yaml get /api/v1/siloc/outbound/schedule-queries/{id}","href":"/pt/reference/rails/siloc/read-one-schedule-query-and-its-answer"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SILOC","href":"/pt/reference/rails/siloc/siloc-error-list"}]}]},{"dropdown":"STA","icon":"file-arrow-up","description":"Transferência de arquivos com o BACEN no trilho STA","groups":[{"group":"Credenciais","pages":[{"title":"List credentials","deprecated":null,"version":null,"sidebarTitle":"Get credentials","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/credentials","href":"/pt/reference/rails/sta/get-credentials"},{"title":"Create a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/credentials","href":"/pt/reference/rails/sta/post-credentials"},{"title":"Read a credential","deprecated":null,"version":null,"sidebarTitle":"Get credentials id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/credentials/{id}","href":"/pt/reference/rails/sta/get-credentials-id"},{"title":"Revoke a credential (LOCAL-only soft-delete)","deprecated":null,"version":null,"sidebarTitle":"Delete credentials id","openapi":"/pt/openapi/v3-current/sta.yaml delete /v1/credentials/{id}","href":"/pt/reference/rails/sta/delete-credentials-id"},{"title":"Update a credential (LOCAL-only)","deprecated":null,"version":null,"sidebarTitle":"Patch credentials id","openapi":"/pt/openapi/v3-current/sta.yaml patch /v1/credentials/{id}","href":"/pt/reference/rails/sta/patch-credentials-id"},{"title":"Rotate the password for a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials id rotate","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/credentials/{id}/rotate","href":"/pt/reference/rails/sta/post-credentials-id-rotate"},{"title":"Test BACEN STA connectivity for a credential","deprecated":null,"version":null,"sidebarTitle":"Post credentials id test","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/credentials/{id}/test","href":"/pt/reference/rails/sta/post-credentials-id-test"}]},{"group":"Configurações de fontes de entrada","pages":[{"title":"List inbound source configs","deprecated":null,"version":null,"sidebarTitle":"Get inbound source configs","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/inbound-source-configs","href":"/pt/reference/rails/sta/get-inbound-source-configs"},{"title":"Create an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Post inbound source configs","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/inbound-source-configs","href":"/pt/reference/rails/sta/post-inbound-source-configs"},{"title":"Read an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Get inbound source configs id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/inbound-source-configs/{id}","href":"/pt/reference/rails/sta/get-inbound-source-configs-id"},{"title":"Delete an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Delete inbound source configs id","openapi":"/pt/openapi/v3-current/sta.yaml delete /v1/inbound-source-configs/{id}","href":"/pt/reference/rails/sta/delete-inbound-source-configs-id"},{"title":"Update an inbound source config","deprecated":null,"version":null,"sidebarTitle":"Patch inbound source configs id","openapi":"/pt/openapi/v3-current/sta.yaml patch /v1/inbound-source-configs/{id}","href":"/pt/reference/rails/sta/patch-inbound-source-configs-id"},{"title":"Trigger an inbound poll","deprecated":null,"version":null,"sidebarTitle":"Post inbound source configs id trigger poll","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/inbound-source-configs/{id}/trigger-poll","href":"/pt/reference/rails/sta/post-inbound-source-configs-id-trigger-poll"}]},{"group":"Transferências","pages":[{"title":"Mark an inbound transfer for urgent processing","deprecated":null,"version":null,"sidebarTitle":"Post inbound transfers id mark urgent","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/inbound/transfers/{id}/mark-urgent","href":"/pt/reference/rails/sta/post-inbound-transfers-id-mark-urgent"},{"title":"List transfers","deprecated":null,"version":null,"sidebarTitle":"Get transfers","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/transfers","href":"/pt/reference/rails/sta/get-transfers"},{"title":"Create outbound transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/transfers","href":"/pt/reference/rails/sta/post-transfers"},{"title":"Read a transfer","deprecated":null,"version":null,"sidebarTitle":"Get transfers id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/transfers/{id}","href":"/pt/reference/rails/sta/get-transfers-id"},{"title":"Cancel a non-terminal transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers id cancel","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/transfers/{id}/cancel","href":"/pt/reference/rails/sta/post-transfers-id-cancel"},{"title":"Retry a stalled outbound transfer","deprecated":null,"version":null,"sidebarTitle":"Post transfers id retry","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/transfers/{id}/retry","href":"/pt/reference/rails/sta/post-transfers-id-retry"}]},{"group":"Auditoria","pages":[{"title":"List transfer history","deprecated":null,"version":null,"sidebarTitle":"Get audit transfer history","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/transfer-history","href":"/pt/reference/rails/sta/get-audit-transfer-history"},{"title":"Read a transfer history entry","deprecated":null,"version":null,"sidebarTitle":"Get audit transfer history id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/transfer-history/{id}","href":"/pt/reference/rails/sta/get-audit-transfer-history-id"},{"title":"List credential access logs","deprecated":null,"version":null,"sidebarTitle":"Get audit credential access logs","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/credential-access-logs","href":"/pt/reference/rails/sta/get-audit-credential-access-logs"},{"title":"Read a credential access log entry","deprecated":null,"version":null,"sidebarTitle":"Get audit credential access logs id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/credential-access-logs/{id}","href":"/pt/reference/rails/sta/get-audit-credential-access-logs-id"},{"title":"List audit exports","deprecated":null,"version":null,"sidebarTitle":"Get audit exports","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/exports","href":"/pt/reference/rails/sta/get-audit-exports"},{"title":"Create an audit export","deprecated":null,"version":null,"sidebarTitle":"Post audit exports","openapi":"/pt/openapi/v3-current/sta.yaml post /v1/audit/exports","href":"/pt/reference/rails/sta/post-audit-exports"},{"title":"Read an audit export","deprecated":null,"version":null,"sidebarTitle":"Get audit exports id","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/exports/{id}","href":"/pt/reference/rails/sta/get-audit-exports-id"},{"title":"Download an audit export object","deprecated":null,"version":null,"sidebarTitle":"Get audit exports id download","openapi":"/pt/openapi/v3-current/sta.yaml get /v1/audit/exports/{id}/download","href":"/pt/reference/rails/sta/get-audit-exports-id-download"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do STA","href":"/pt/reference/rails/sta/sta-error-list"}]}]},{"dropdown":"SISBAJUD","icon":"gavel","description":"Ordens judiciais sobre ativos no trilho SISBAJUD","groups":[{"group":"SISBAJUD Mensageria · Instituições","pages":[{"title":"Create institution config and provision keys","deprecated":null,"version":null,"sidebarTitle":"Create institution config and provision keys","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions","href":"/pt/reference/rails/sisbajud/mensageria/create-institution-config-and-provision-keys"},{"title":"Get institution config by id","deprecated":null,"version":null,"sidebarTitle":"Get institution config by id","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}","href":"/pt/reference/rails/sisbajud/mensageria/get-institution-config-by-id"},{"title":"Update institution config by id","deprecated":null,"version":null,"sidebarTitle":"Update institution config by id","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml patch /v1/institutions/{institutionId}","href":"/pt/reference/rails/sisbajud/mensageria/update-institution-config-by-id"}]},{"group":"SISBAJUD Mensageria · Ordens e arquivos","pages":[{"title":"List orders (admin)","deprecated":null,"version":null,"sidebarTitle":"List orders admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/orders","href":"/pt/reference/rails/sisbajud/mensageria/list-orders-admin"},{"title":"Get order detail (admin)","deprecated":null,"version":null,"sidebarTitle":"Get order detail admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/orders/{id}","href":"/pt/reference/rails/sisbajud/mensageria/get-order-detail-admin"},{"title":"List files (admin)","deprecated":null,"version":null,"sidebarTitle":"List files admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/files","href":"/pt/reference/rails/sisbajud/mensageria/list-files-admin"},{"title":"Get file detail (admin)","deprecated":null,"version":null,"sidebarTitle":"Get file detail admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/files/{id}","href":"/pt/reference/rails/sisbajud/mensageria/get-file-detail-admin"},{"title":"List orders awaiting a human decision (admin)","deprecated":null,"version":null,"sidebarTitle":"List orders awaiting a human decision admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/awaiting-decision-orders","href":"/pt/reference/rails/sisbajud/mensageria/list-orders-awaiting-a-human-decision-admin"},{"title":"List failed orders (admin)","deprecated":null,"version":null,"sidebarTitle":"List failed orders admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/failed-orders","href":"/pt/reference/rails/sisbajud/mensageria/list-failed-orders-admin"},{"title":"Get processing stats (admin)","deprecated":null,"version":null,"sidebarTitle":"Get processing stats admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/stats","href":"/pt/reference/rails/sisbajud/mensageria/get-processing-stats-admin"}]},{"group":"SISBAJUD Mensageria · Monitoramento","pages":[{"title":"Get SLA status (admin)","deprecated":null,"version":null,"sidebarTitle":"Get sla status admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/sla-status","href":"/pt/reference/rails/sisbajud/mensageria/get-sla-status-admin"},{"title":"Verify audit trail integrity (admin)","deprecated":null,"version":null,"sidebarTitle":"Verify audit trail integrity admin","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/audit/verify","href":"/pt/reference/rails/sisbajud/mensageria/verify-audit-trail-integrity-admin"}]},{"group":"SISBAJUD Mensageria · Arquivos de retorno","pages":[{"title":"Force a return-file generation","deprecated":null,"version":null,"sidebarTitle":"Force a return file generation","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/generate","href":"/pt/reference/rails/sisbajud/mensageria/force-a-return-file-generation"},{"title":"Release a failed return file's judicial orders","deprecated":null,"version":null,"sidebarTitle":"Release a failed return file s judicial orders","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/{id}/reconsolidate","href":"/pt/reference/rails/sisbajud/mensageria/release-a-failed-return-file-s-judicial-orders"},{"title":"Resolve a stuck return-file transmission","deprecated":null,"version":null,"sidebarTitle":"Resolve a stuck return file transmission","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/return-file/{id}/resolve-transmission","href":"/pt/reference/rails/sisbajud/mensageria/resolve-a-stuck-return-file-transmission"}]},{"group":"SISBAJUD Mensageria · Solicitações LGPD","pages":[{"title":"Create an LGPD data-subject request","deprecated":null,"version":null,"sidebarTitle":"Create an lgpd data subject request","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/lgpd/requests","href":"/pt/reference/rails/sisbajud/mensageria/create-an-lgpd-data-subject-request"},{"title":"Record the resolution of an LGPD request","deprecated":null,"version":null,"sidebarTitle":"Record the resolution of an lgpd request","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/lgpd/requests/{id}/resolve","href":"/pt/reference/rails/sisbajud/mensageria/record-the-resolution-of-an-lgpd-request"},{"title":"Export a data subject's records","deprecated":null,"version":null,"sidebarTitle":"Export a data subject s records","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml get /v1/institutions/{institutionId}/lgpd/subject-data","href":"/pt/reference/rails/sisbajud/mensageria/export-a-data-subject-s-records"}]},{"group":"SISBAJUD Mensageria · Segurança","pages":[{"title":"Rotate an institution's KEK","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s kek","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/security/kek:rotate","href":"/pt/reference/rails/sisbajud/mensageria/rotate-an-institution-s-kek"},{"title":"Rotate an institution's tokenization keyset","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s tokenization keyset","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/security/keyset:rotate","href":"/pt/reference/rails/sisbajud/mensageria/rotate-an-institution-s-tokenization-keyset"}]},{"group":"SISBAJUD Mensageria · Conformidade","pages":[{"title":"Register a justification on a non-compliance log","deprecated":null,"version":null,"sidebarTitle":"Register a justification on a non compliance log","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/non-compliance-logs/{id}/justification","href":"/pt/reference/rails/sisbajud/mensageria/register-a-justification-on-a-non-compliance-log"}]},{"group":"SISBAJUD Mensageria · Dead letter do Lerian STA","pages":[{"title":"Record the human treatment of a parked STA event","deprecated":null,"version":null,"sidebarTitle":"Record the human treatment of a parked sta event","openapi":"/pt/openapi/v3-current/sisbajud-mensageria.yaml post /v1/institutions/{institutionId}/sta-dlq/{eventId}/acknowledge","href":"/pt/reference/rails/sisbajud/mensageria/record-the-human-treatment-of-a-parked-sta-event"}]},{"group":"SISBAJUD executor · Instituições e conector Midaz","pages":[{"title":"Create institution config and provision keys","deprecated":null,"version":null,"sidebarTitle":"Create institution config and provision keys","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml post /v1/institutions","href":"/pt/reference/rails/sisbajud/executor/create-institution-config-and-provision-keys"},{"title":"Get institution config by id","deprecated":null,"version":null,"sidebarTitle":"Get institution config by id","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}","href":"/pt/reference/rails/sisbajud/executor/get-institution-config-by-id"},{"title":"Update institution config by id","deprecated":null,"version":null,"sidebarTitle":"Update institution config by id","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml patch /v1/institutions/{institutionId}","href":"/pt/reference/rails/sisbajud/executor/update-institution-config-by-id"},{"title":"Replace the institution's connector configuration","deprecated":null,"version":null,"sidebarTitle":"Replace the institution s connector configuration","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml put /v1/institutions/{institutionId}/connector-config","href":"/pt/reference/rails/sisbajud/executor/replace-the-institution-s-connector-configuration"},{"title":"Write the institution's connector credentials","deprecated":null,"version":null,"sidebarTitle":"Write the institution s connector credentials","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml put /v1/institutions/{institutionId}/connector-credentials","href":"/pt/reference/rails/sisbajud/executor/write-the-institution-s-connector-credentials"}]},{"group":"SISBAJUD executor · Ordens que precisam de atenção","pages":[{"title":"List executor failed orders","deprecated":null,"version":null,"sidebarTitle":"List executor failed orders","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}/executor/failed-orders","href":"/pt/reference/rails/sisbajud/executor/list-executor-failed-orders"},{"title":"List executor human decisions","deprecated":null,"version":null,"sidebarTitle":"List executor human decisions","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml get /v1/institutions/{institutionId}/executor/human-decisions","href":"/pt/reference/rails/sisbajud/executor/list-executor-human-decisions"}]},{"group":"SISBAJUD executor · Roteamento de ledger","pages":[{"title":"Preflight the tenant's ledger routing configuration (admin)","deprecated":null,"version":null,"sidebarTitle":"Preflight the tenant s ledger routing configuration admin","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml get /v1/admin/ledger-routing/preflight","href":"/pt/reference/rails/sisbajud/executor/preflight-the-tenant-s-ledger-routing-configuration-admin"}]},{"group":"SISBAJUD executor · Segurança","pages":[{"title":"Rotate an institution's connector-credentials KEK","deprecated":null,"version":null,"sidebarTitle":"Rotate an institution s connector credentials kek","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml post /v1/institutions/{institutionId}/security/credential-kek:rotate","href":"/pt/reference/rails/sisbajud/executor/rotate-an-institution-s-connector-credentials-kek"}]},{"group":"SISBAJUD executor · Auditoria","pages":[{"title":"Verify audit trail integrity (admin)","deprecated":null,"version":null,"sidebarTitle":"Verify audit trail integrity admin","openapi":"/pt/openapi/v3-current/sisbajud-executor.yaml get /v1/admin/audit/verify","href":"/pt/reference/rails/sisbajud/executor/verify-audit-trail-integrity-admin"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SISBAJUD","href":"/pt/reference/rails/sisbajud/sisbajud-error-list"}]}]},{"dropdown":"BC Correios","icon":"envelope","description":"Correspondência com o BACEN pelo BC Correio","groups":[{"group":"Correspondências","pages":[{"title":"List or search mails","deprecated":null,"version":null,"sidebarTitle":"List or search mails","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails","href":"/pt/reference/rails/bc-correios/list-or-search-mails"},{"title":"Count mails","deprecated":null,"version":null,"sidebarTitle":"Count mails","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/count","href":"/pt/reference/rails/bc-correios/count-mails"},{"title":"Send message to BCB","deprecated":null,"version":null,"sidebarTitle":"Send message to bcb","openapi":"/pt/openapi/v3-current/bc-correios.yaml post /api/v1/correios/mails/send","href":"/pt/reference/rails/bc-correios/send-message-to-bcb"},{"title":"Get mail by ID","deprecated":null,"version":null,"sidebarTitle":"Get mail by id","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}","href":"/pt/reference/rails/bc-correios/get-mail-by-id"},{"title":"Get AI analysis status","deprecated":null,"version":null,"sidebarTitle":"Get ai analysis status","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}/ai-status","href":"/pt/reference/rails/bc-correios/get-ai-analysis-status"},{"title":"Archive mail","deprecated":null,"version":null,"sidebarTitle":"Archive mail","openapi":"/pt/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/archive","href":"/pt/reference/rails/bc-correios/archive-mail"},{"title":"Download attachment","deprecated":null,"version":null,"sidebarTitle":"Download attachment","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/mails/{id}/attachments/{attachmentId}","href":"/pt/reference/rails/bc-correios/download-attachment"},{"title":"Mark mail as read","deprecated":null,"version":null,"sidebarTitle":"Mark mail as read","openapi":"/pt/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/read","href":"/pt/reference/rails/bc-correios/mark-mail-as-read"},{"title":"Trigger AI re-analysis","deprecated":null,"version":null,"sidebarTitle":"Trigger ai re analysis","openapi":"/pt/openapi/v3-current/bc-correios.yaml post /api/v1/correios/mails/{id}/reanalyze","href":"/pt/reference/rails/bc-correios/trigger-ai-re-analysis"},{"title":"Restore mail","deprecated":null,"version":null,"sidebarTitle":"Restore mail","openapi":"/pt/openapi/v3-current/bc-correios.yaml put /api/v1/correios/mails/{id}/restore","href":"/pt/reference/rails/bc-correios/restore-mail"}]},{"group":"Configurações","pages":[{"title":"Get tenant settings","deprecated":null,"version":null,"sidebarTitle":"Get tenant settings","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/settings","href":"/pt/reference/rails/bc-correios/get-tenant-settings"},{"title":"Create tenant settings","deprecated":null,"version":null,"sidebarTitle":"Create tenant settings","openapi":"/pt/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings","href":"/pt/reference/rails/bc-correios/create-tenant-settings"},{"title":"Update tenant settings","deprecated":null,"version":null,"sidebarTitle":"Update tenant settings","openapi":"/pt/openapi/v3-current/bc-correios.yaml patch /api/v1/correios/settings","href":"/pt/reference/rails/bc-correios/update-tenant-settings"},{"title":"Update retention policy","deprecated":null,"version":null,"sidebarTitle":"Update retention policy","openapi":"/pt/openapi/v3-current/bc-correios.yaml patch /api/v1/correios/settings/retention","href":"/pt/reference/rails/bc-correios/update-retention-policy"},{"title":"Test AI provider connection","deprecated":null,"version":null,"sidebarTitle":"Test ai provider connection","openapi":"/pt/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings/test-ai-connection","href":"/pt/reference/rails/bc-correios/test-ai-provider-connection"},{"title":"Test BCB connection","deprecated":null,"version":null,"sidebarTitle":"Test bcb connection","openapi":"/pt/openapi/v3-current/bc-correios.yaml post /api/v1/correios/settings/test-connection","href":"/pt/reference/rails/bc-correios/test-bcb-connection"}]},{"group":"Auditoria","pages":[{"title":"Query audit trail","deprecated":null,"version":null,"sidebarTitle":"Query audit trail","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/audit","href":"/pt/reference/rails/bc-correios/query-audit-trail"},{"title":"Export audit trail","deprecated":null,"version":null,"sidebarTitle":"Export audit trail","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/audit/export","href":"/pt/reference/rails/bc-correios/export-audit-trail"}]},{"group":"Painel","pages":[{"title":"Dashboard category breakdown","deprecated":null,"version":null,"sidebarTitle":"Dashboard category breakdown","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/dashboard/categories","href":"/pt/reference/rails/bc-correios/dashboard-category-breakdown"},{"title":"Dashboard summary","deprecated":null,"version":null,"sidebarTitle":"Dashboard summary","openapi":"/pt/openapi/v3-current/bc-correios.yaml get /api/v1/correios/dashboard/summary","href":"/pt/reference/rails/bc-correios/dashboard-summary"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do BC Correios","href":"/pt/reference/rails/bc-correios/bc-correios-error-list"}]}]},{"dropdown":"SRC","icon":"shield-halved","description":"Consultas de restrição com o BACEN pelo BC Protege+","groups":[{"group":"Consultas","pages":[{"title":"List consultations","deprecated":null,"version":null,"sidebarTitle":"List consultations","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/consultations","href":"/pt/reference/rails/src/list-consultations"},{"title":"Create a consultation","deprecated":null,"version":null,"sidebarTitle":"Create a consultation","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/consultations","href":"/pt/reference/rails/src/create-a-consultation"},{"title":"Search consultations","deprecated":null,"version":null,"sidebarTitle":"Search consultations","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/consultations/search","href":"/pt/reference/rails/src/search-consultations"},{"title":"Retrieve a consultation","deprecated":null,"version":null,"sidebarTitle":"Retrieve a consultation","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/consultations/{id}","href":"/pt/reference/rails/src/retrieve-a-consultation"}]},{"group":"Registros da instituição","pages":[{"title":"Register an institution record","deprecated":null,"version":null,"sidebarTitle":"Register an institution record","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/consultations/{id}/institution-record","href":"/pt/reference/rails/src/register-an-institution-record"}]},{"group":"Evidências","pages":[{"title":"Search the evidence trail","deprecated":null,"version":null,"sidebarTitle":"Search the evidence trail","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/evidence","href":"/pt/reference/rails/src/search-the-evidence-trail"},{"title":"Retrieve a consultation's evidence trail","deprecated":null,"version":null,"sidebarTitle":"Retrieve a consultations evidence trail","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/evidence/consultations/{id}","href":"/pt/reference/rails/src/retrieve-a-consultations-evidence-trail"},{"title":"Correct an evidence record","deprecated":null,"version":null,"sidebarTitle":"Correct an evidence record","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/evidence/consultations/{id}/corrections","href":"/pt/reference/rails/src/correct-an-evidence-record"},{"title":"Search evidence records","deprecated":null,"version":null,"sidebarTitle":"Search evidence records","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/evidence/records","href":"/pt/reference/rails/src/search-evidence-records"}]},{"group":"Painel","pages":[{"title":"Retrieve the consultation dashboard","deprecated":null,"version":null,"sidebarTitle":"Retrieve the consultation dashboard","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/dashboard/consultations","href":"/pt/reference/rails/src/retrieve-the-consultation-dashboard"}]},{"group":"Credenciais","pages":[{"title":"Retrieve the credential status","deprecated":null,"version":null,"sidebarTitle":"Retrieve the credential status","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/credentials","href":"/pt/reference/rails/src/retrieve-the-credential-status"}]},{"group":"Casos de operador","pages":[{"title":"List operator cases","deprecated":null,"version":null,"sidebarTitle":"List operator cases","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/operator/cases","href":"/pt/reference/rails/src/list-operator-cases"},{"title":"Retrieve an operator case","deprecated":null,"version":null,"sidebarTitle":"Retrieve an operator case","openapi":"/pt/openapi/v3-current/src.yaml get /v1/src/operator/cases/{leg}/{caseId}","href":"/pt/reference/rails/src/retrieve-an-operator-case"},{"title":"Close a credential-operation case","deprecated":null,"version":null,"sidebarTitle":"Close a credential operation case","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/operator/credential-operations/{caseId}/closure","href":"/pt/reference/rails/src/close-a-credential-operation-case"},{"title":"Acknowledge an invalid-dispatch case","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an invalid dispatch case","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/operator/invalid-dispatches/{caseId}/closure","href":"/pt/reference/rails/src/acknowledge-an-invalid-dispatch-case"},{"title":"Close an orphan-response case","deprecated":null,"version":null,"sidebarTitle":"Close an orphan response case","openapi":"/pt/openapi/v3-current/src.yaml post /v1/src/operator/orphan-responses/{caseId}/closure","href":"/pt/reference/rails/src/close-an-orphan-response-case"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do SRC","href":"/pt/reference/rails/src/src-error-list"}]}]},{"dropdown":"Consignado CLT (Dataprev)","icon":"hand-holding-dollar","description":"Registro de crédito consignado na Dataprev","groups":[{"group":"Configuração do tenant e credenciais","pages":[{"title":"Get the Dataprev credential status","deprecated":null,"version":null,"sidebarTitle":"Get credential status","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/credentials/dataprev","href":"/pt/reference/rails/consignado/get-credential-status"},{"title":"Upload or rotate the Dataprev client certificate","deprecated":null,"version":null,"sidebarTitle":"Put certificate","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/certificate","href":"/pt/reference/rails/consignado/put-certificate"},{"title":"Set the tenant's Dataprev codigoSolicitante","deprecated":null,"version":null,"sidebarTitle":"Put codigo solicitante","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/codigo-solicitante","href":"/pt/reference/rails/consignado/put-codigo-solicitante"},{"title":"Upload or rotate the Dataprev OAuth2 credentials","deprecated":null,"version":null,"sidebarTitle":"Put oauth","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/oauth","href":"/pt/reference/rails/consignado/put-oauth"},{"title":"Set the tenant worker portal base URL","deprecated":null,"version":null,"sidebarTitle":"Put portal base url","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/portal-base-url","href":"/pt/reference/rails/consignado/put-portal-base-url"},{"title":"Revoke the Dataprev credentials","deprecated":null,"version":null,"sidebarTitle":"Revoke credentials","openapi":"/pt/openapi/v3-current/consignado.yaml delete /v1/credentials/dataprev","href":"/pt/reference/rails/consignado/revoke-credentials"},{"title":"List the tenant's registered originadores","deprecated":null,"version":null,"sidebarTitle":"List consignado originadores","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/originadores","href":"/pt/reference/rails/consignado/list-consignado-originadores"},{"title":"Register a new originador","deprecated":null,"version":null,"sidebarTitle":"Create consignado originador","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/originadores","href":"/pt/reference/rails/consignado/create-consignado-originador"},{"title":"Deactivate an originador","deprecated":null,"version":null,"sidebarTitle":"Deactivate consignado originador","openapi":"/pt/openapi/v3-current/consignado.yaml delete /v1/consignado/originadores/{id}","href":"/pt/reference/rails/consignado/deactivate-consignado-originador"}]},{"group":"Dados do trabalhador e margem","pages":[{"title":"Fetch a worker's available consignable margin","deprecated":null,"version":null,"sidebarTitle":"Fetch consignado worker margin","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/workers/margin","href":"/pt/reference/rails/consignado/fetch-consignado-worker-margin"},{"title":"Read the loans closed by employment-link termination","deprecated":null,"version":null,"sidebarTitle":"List consignado employment terminations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/employment-status/terminations","href":"/pt/reference/rails/consignado/list-consignado-employment-terminations"},{"title":"Read workers with a new employment bond after a termination-closed contract","deprecated":null,"version":null,"sidebarTitle":"List consignado vinculos novos","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/trabalhadores/vinculos-novos","href":"/pt/reference/rails/consignado/list-consignado-vinculos-novos"},{"title":"List a worker's authorized employment bonds","deprecated":null,"version":null,"sidebarTitle":"List consignado fgts autorizados","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/autorizados","href":"/pt/reference/rails/consignado/list-consignado-fgts-autorizados"},{"title":"Read a worker's consignable FGTS balance","deprecated":null,"version":null,"sidebarTitle":"Read consignado fgts saldo","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/saldo","href":"/pt/reference/rails/consignado/read-consignado-fgts-saldo"}]},{"group":"Leilões e propostas","pages":[{"title":"List the worker loan requests open for the leilão","deprecated":null,"version":null,"sidebarTitle":"List consignado solicitacoes","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/leilao/solicitacoes","href":"/pt/reference/rails/consignado/list-consignado-solicitacoes"},{"title":"Submit a one-or-two proposal set to the payroll rail","deprecated":null,"version":null,"sidebarTitle":"Submit consignado bid","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/leilao/solicitacoes/{id_solicitacao}/propostas","href":"/pt/reference/rails/consignado/submit-consignado-bid"},{"title":"List the inbound portability requests open for the leilão","deprecated":null,"version":null,"sidebarTitle":"List consignado portabilidade solicitacoes","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/leilao/portabilidade/solicitacoes","href":"/pt/reference/rails/consignado/list-consignado-portabilidade-solicitacoes"},{"title":"Respond to an inbound portability leilão solicitação","deprecated":null,"version":null,"sidebarTitle":"Respond consignado portability auction","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/leilao/portabilidade/solicitacoes/{id_solicitacao_proposta}/propostas","href":"/pt/reference/rails/consignado/respond-consignado-portability-auction"},{"title":"Read one page of a portability's efetivação status","deprecated":null,"version":null,"sidebarTitle":"List consignado portabilidade efetivacoes","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/portabilidade/efetivacoes","href":"/pt/reference/rails/consignado/list-consignado-portabilidade-efetivacoes"},{"title":"List the credits this tenant bid on and where each bid stands","deprecated":null,"version":null,"sidebarTitle":"List consignado bid submissions","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/bid-submissions","href":"/pt/reference/rails/consignado/list-consignado-bid-submissions"}]},{"group":"Registro e documentos do contrato","pages":[{"title":"Averbar a consignado contract on the payroll rail","deprecated":null,"version":null,"sidebarTitle":"Averbar consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/averbacao","href":"/pt/reference/rails/consignado/averbar-consignado-contract"},{"title":"List the tenant's averbação operations","deprecated":null,"version":null,"sidebarTitle":"List consignado averbacao operations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/averbacao-operations","href":"/pt/reference/rails/consignado/list-consignado-averbacao-operations"},{"title":"Get one contract's averbação operation","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract averbacao operation","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/averbacao","href":"/pt/reference/rails/consignado/get-consignado-contract-averbacao-operation"},{"title":"Read the cadastro stored with a consignado averbação","deprecated":null,"version":null,"sidebarTitle":"Read the cadastro stored with a consignado averbacao","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/dados-cadastrais","href":"/pt/reference/rails/consignado/read-the-cadastro-stored-with-a-consignado-averbacao"},{"title":"Import a contract already averbado outside this gateway","deprecated":null,"version":null,"sidebarTitle":"Import consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/import","href":"/pt/reference/rails/consignado/import-consignado-contract"},{"title":"Attach the signed CCB for an accepted averbação","deprecated":null,"version":null,"sidebarTitle":"Attach consignado ccb","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/ccb-attachment","href":"/pt/reference/rails/consignado/attach-consignado-ccb"},{"title":"List confirmed consignado contract registrations","deprecated":null,"version":null,"sidebarTitle":"List consignado contract registrations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contract-registrations","href":"/pt/reference/rails/consignado/list-consignado-contract-registrations"},{"title":"Get current consignado contract registration evidence","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract registration","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contract-registrations/{numero_contrato}","href":"/pt/reference/rails/consignado/get-consignado-contract-registration"},{"title":"Download the rail's document for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract rail document","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/rail-document","href":"/pt/reference/rails/consignado/get-consignado-contract-rail-document"},{"title":"Read one averbado contract's loan status on the rail","deprecated":null,"version":null,"sidebarTitle":"Get consignado rail loan","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/rail-loan","href":"/pt/reference/rails/consignado/get-consignado-rail-loan"},{"title":"Download a retained consignado contract artifact","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract artifact","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/artifacts/{artifact_type}","href":"/pt/reference/rails/consignado/get-consignado-contract-artifact"},{"title":"Confirm a disbursement already paid to the worker","deprecated":null,"version":null,"sidebarTitle":"Confirm consignado disbursement","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/disbursement-confirmation","href":"/pt/reference/rails/consignado/confirm-consignado-disbursement"},{"title":"List the disbursement confirmations recorded for this tenant","deprecated":null,"version":null,"sidebarTitle":"List consignado disbursement confirmations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/disbursement-confirmations","href":"/pt/reference/rails/consignado/list-consignado-disbursement-confirmations"},{"title":"Inform the B3 instrument code of an averbado contract","description":"Informs the B3 instrument code (Código IF, X(14) per the B3 CCB operations manual) the bancarizador received when B3 accepted the CCB registration of an averbado contract.\n\nThe premise that the B3 registration happens AFTER the averbação is a product decision, not a B3 rule: the code is accepted only once the averbação is confirmed, and never on the averbação body.\n\nWritten once. Re-sending the same registro answers 200 with the original registradoEm and publishes no second fact. Sending a different code or date for a contract that already holds one is refused with 409; the API offers no correction. The gateway does not talk to B3 and does not check that the code matches the CCB: that is the informer's responsibility.\n\nIdempotent by value: the registro itself is the key, so no X-Idempotency header is read.","deprecated":null,"version":null,"sidebarTitle":"Inform the b3 instrument code of an averbado contract","openapi":"/pt/openapi/v3-current/consignado.yaml patch /v1/consignado/contracts/{numero_contrato}/registro-b3","href":"/pt/reference/rails/consignado/inform-the-b3-instrument-code-of-an-averbado-contract"},{"title":"Read the B3 instrument code of an averbado contract","deprecated":null,"version":null,"sidebarTitle":"Read the b3 instrument code of an averbado contract","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/registro-b3","href":"/pt/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract"}]},{"group":"Correções do contrato","pages":[{"title":"Record a correction to a registered contract","description":"Records a correction to something the client already asserted about a registered contract, and publishes the fact that names it.\n\nThis is NOT a Dataprev operation: no rail credential is used and no government boundary is crossed. Manual 005 revision 1.13 states the rail's retification fields are no longer used and always return null, so the client is the only authority a correction can have — `source_authority` is always `client`.\n\nNOTHING IS MUTATED. A correction is an append that names what it supersedes, and the record it corrects stays immutable in the database exactly as it was. Correcting the same thing twice appends a second correction that supersedes the first.\n\nThe gateway takes custody of the corrected resource and computes its SHA-256 itself; a client-declared digest is never accepted. The published fact carries a same-origin path back to this gateway plus that digest, and the consumer fetches and verifies it over authenticated M2M.\n\n| correction_type | payment_reference | supersedes |\n|---|---|---|\n| `ccb` | must be empty | the previous CCB correction, or nothing on the first |\n| `disbursement` | required | the confirmed payment it repairs, then the previous correction of that payment |\n\nA disbursement correction naming a payment this deployment holds no confirmation for is refused with 404: a supersession pointing at nothing is worse than no correction.\n\nX-Idempotency is mandatory, opaque, 1..128 bytes, and never defaulted. PostgreSQL is the authority: the same key replays the identical 202 body and publishes no second fact, and the same key carrying a different correction answers 422 without ever returning the earlier body.","deprecated":null,"version":null,"sidebarTitle":"Record consignado contract correction","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/corrections","href":"/pt/reference/rails/consignado/record-consignado-contract-correction"},{"title":"List one contract's correction chain","deprecated":null,"version":null,"sidebarTitle":"List consignado contract corrections","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/corrections","href":"/pt/reference/rails/consignado/list-consignado-contract-corrections"},{"title":"Download the corrected resource a correction fact names","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract correction","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/corrections/{correction_id}","href":"/pt/reference/rails/consignado/get-consignado-contract-correction"}]},{"group":"Ciclo de vida do contrato","pages":[{"title":"Suspend payroll deduction for an averbado contract","deprecated":null,"version":null,"sidebarTitle":"Suspend consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/suspend","href":"/pt/reference/rails/consignado/suspend-consignado-contract"},{"title":"Reactivate a suspended contract","deprecated":null,"version":null,"sidebarTitle":"Reactivate consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/reactivate","href":"/pt/reference/rails/consignado/reactivate-consignado-contract"},{"title":"Alter the mutable terms of an averbado contract","deprecated":null,"version":null,"sidebarTitle":"Alter consignado contract terms","openapi":"/pt/openapi/v3-current/consignado.yaml patch /v1/consignado/contracts/{numero_contrato}/terms","href":"/pt/reference/rails/consignado/alter-consignado-contract-terms"},{"title":"Read the exclusion this gateway holds for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract exclusion","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/exclusion","href":"/pt/reference/rails/consignado/get-consignado-contract-exclusion"},{"title":"Remove an averbado contract from the payroll registry","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/exclusion","href":"/pt/reference/rails/consignado/excluir-consignado-contract"},{"title":"List the tenant's exclusion operations","deprecated":null,"version":null,"sidebarTitle":"List consignado exclusion operations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/exclusion-operations","href":"/pt/reference/rails/consignado/list-consignado-exclusion-operations"},{"title":"Get one exclusion operation's audit trail","deprecated":null,"version":null,"sidebarTitle":"Get consignado exclusion operation audit","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/exclusion-operations/{request_ref}/audit","href":"/pt/reference/rails/consignado/get-consignado-exclusion-operation-audit"},{"title":"Suspend one or more competências by early payment","deprecated":null,"version":null,"sidebarTitle":"Incluir consignado antecipacao parcela","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/antecipacao","href":"/pt/reference/rails/consignado/incluir-consignado-antecipacao-parcela"},{"title":"Withdraw a competência's early-payment suspension","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado antecipacao parcela","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/consignado/contracts/{numero_contrato}/antecipacao/{competencia}","href":"/pt/reference/rails/consignado/excluir-consignado-antecipacao-parcela"},{"title":"List what each averbado contract of this tenant still owes","deprecated":null,"version":null,"sidebarTitle":"List consignado saldo devedor obrigacoes","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/saldo-devedor","href":"/pt/reference/rails/consignado/list-consignado-saldo-devedor-obrigacoes"},{"title":"Get one contract's saldo devedor and its amortization book","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract saldo devedor","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/saldo-devedor","href":"/pt/reference/rails/consignado/get-consignado-contract-saldo-devedor"}]},{"group":"Refinanciamento, renegociação e portabilidade","pages":[{"title":"Refinance one or more active contracts into a new one","deprecated":null,"version":null,"sidebarTitle":"Realizar consignado refinanciamento","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/refinanciamento","href":"/pt/reference/rails/consignado/realizar-consignado-refinanciamento"},{"title":"Reverse a refinancing within its 7 business day window","deprecated":null,"version":null,"sidebarTitle":"Reverter consignado refinanciamento","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/refinanciamento/reversao","href":"/pt/reference/rails/consignado/reverter-consignado-refinanciamento"},{"title":"Renegotiate a contract closed by employment-link termination","deprecated":null,"version":null,"sidebarTitle":"Renegociar consignado contract","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/renegociacao","href":"/pt/reference/rails/consignado/renegociar-consignado-contract"},{"title":"Averbate a portability","deprecated":null,"version":null,"sidebarTitle":"Averbar consignado portabilidade","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/portabilidade/{numero_unico}/averbacao","href":"/pt/reference/rails/consignado/averbar-consignado-portabilidade"},{"title":"Exclude a contract from this institution because the worker ported it out","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado portabilidade","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/contracts/{numero_contrato}/portabilidade/exclusao","href":"/pt/reference/rails/consignado/excluir-consignado-portabilidade"}]},{"group":"Contratos legados","pages":[{"title":"Register a pre-existing (legado) loan","deprecated":null,"version":null,"sidebarTitle":"Incluir consignado emprestimo legado","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/legacy-contracts","href":"/pt/reference/rails/consignado/incluir-consignado-emprestimo-legado"},{"title":"Renegotiate one or more legado loans into a new contract","deprecated":null,"version":null,"sidebarTitle":"Renegociar consignado emprestimo legado","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/legacy-contracts/renegociacao","href":"/pt/reference/rails/consignado/renegociar-consignado-emprestimo-legado"},{"title":"Remove a previously registered legado loan","deprecated":null,"version":null,"sidebarTitle":"Excluir consignado emprestimo legado","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/consignado/legacy-contracts/{numero_contrato}","href":"/pt/reference/rails/consignado/excluir-consignado-emprestimo-legado"}]},{"group":"Garantias do FGTS","pages":[{"title":"Execute the FGTS guarantee for a contract","deprecated":null,"version":null,"sidebarTitle":"Execute consignado fgts guarantee","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/fgts/garantias/execucao","href":"/pt/reference/rails/consignado/execute-consignado-fgts-guarantee"},{"title":"Read the FGTS guarantee execution this gateway holds for a contract","deprecated":null,"version":null,"sidebarTitle":"Get consignado contract fgts guarantee execution","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/contracts/{numero_contrato}/fgts-garantia/execucao","href":"/pt/reference/rails/consignado/get-consignado-contract-fgts-guarantee-execution"}]},{"group":"Conciliação e calendário","pages":[{"title":"Read the rail's operational-calendar competência window","deprecated":null,"version":null,"sidebarTitle":"Get consignado calendar","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/calendar","href":"/pt/reference/rails/consignado/get-consignado-calendar"},{"title":"Read the payroll escrituração records included in a window","deprecated":null,"version":null,"sidebarTitle":"List consignado escrituracoes","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/escrituracoes","href":"/pt/reference/rails/consignado/list-consignado-escrituracoes"},{"title":"Read the CEF D+2 repasse transfers included in a window","deprecated":null,"version":null,"sidebarTitle":"List consignado repasses","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/repasses","href":"/pt/reference/rails/consignado/list-consignado-repasses"},{"title":"List the repasse transfers the rail still owes this tenant","deprecated":null,"version":null,"sidebarTitle":"List consignado repasse expectations","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/repasse-expectations","href":"/pt/reference/rails/consignado/list-consignado-repasse-expectations"}]},{"group":"Fundos e cessões","pages":[{"title":"List the tenant's registered funds","deprecated":null,"version":null,"sidebarTitle":"List consignado fundos","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/fundos","href":"/pt/reference/rails/consignado/list-consignado-fundos"},{"title":"Register a new fund","deprecated":null,"version":null,"sidebarTitle":"Create consignado fundo","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/consignado/fundos","href":"/pt/reference/rails/consignado/create-consignado-fundo"},{"title":"Deactivate a fund","deprecated":null,"version":null,"sidebarTitle":"Deactivate consignado fundo","openapi":"/pt/openapi/v3-current/consignado.yaml delete /v1/consignado/fundos/{id}","href":"/pt/reference/rails/consignado/deactivate-consignado-fundo"},{"title":"List the credits ceded to the caller's own fund","deprecated":null,"version":null,"sidebarTitle":"List consignado fundo creditos cedidos","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/fundo/creditos","href":"/pt/reference/rails/consignado/list-consignado-fundo-creditos-cedidos"},{"title":"List the credits ceded to one fund the caller administers","deprecated":null,"version":null,"sidebarTitle":"List consignado fundo creditos cedidos as bancarizador","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/fundos/{id}/creditos","href":"/pt/reference/rails/consignado/list-consignado-fundo-creditos-cedidos-as-bancarizador"},{"title":"Register a credit's cessão to its attributed fund","deprecated":null,"version":null,"sidebarTitle":"Register consignado cessao","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/consignado/leilao/bid-submissions/cessao","href":"/pt/reference/rails/consignado/register-consignado-cessao"}]},{"group":"Capacidade e uso","pages":[{"title":"Get this tenant's outbound Dataprev rail throughput","deprecated":null,"version":null,"sidebarTitle":"Get consignado throughput","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/throughput","href":"/pt/reference/rails/consignado/get-consignado-throughput"},{"title":"Set this tenant's outbound Dataprev rail throughput","deprecated":null,"version":null,"sidebarTitle":"Put consignado throughput","openapi":"/pt/openapi/v3-current/consignado.yaml put /v1/consignado/throughput","href":"/pt/reference/rails/consignado/put-consignado-throughput"},{"title":"List this tenant's outbound Dataprev rail throughput transitions","deprecated":null,"version":null,"sidebarTitle":"List consignado throughput history","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/throughput/history","href":"/pt/reference/rails/consignado/list-consignado-throughput-history"},{"title":"Get consignado gateway usage for a competência","deprecated":null,"version":null,"sidebarTitle":"Get consignado usage","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/usage","href":"/pt/reference/rails/consignado/get-consignado-usage"}]},{"group":"Monitoramento","pages":[{"title":"Report which operation families this deployment reaches","deprecated":null,"version":null,"sidebarTitle":"Get consignado capabilities","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/capabilities","href":"/pt/reference/rails/consignado/get-consignado-capabilities"},{"title":"Report this process's scheduled Consignado loops","deprecated":null,"version":null,"sidebarTitle":"List consignado scheduled jobs","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/jobs","href":"/pt/reference/rails/consignado/list-consignado-scheduled-jobs"},{"title":"List the tenant's rail commands and the operations that leave no record","deprecated":null,"version":null,"sidebarTitle":"List consignado rail commands","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/rail-commands","href":"/pt/reference/rails/consignado/list-consignado-rail-commands"}]},{"group":"Subscriptions de eventos","pages":[{"title":"List the tenant's hub subscriptions","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/subscriptions","href":"/pt/reference/rails/consignado/list-subscriptions"},{"title":"Create a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/subscriptions","href":"/pt/reference/rails/consignado/create-subscription"},{"title":"Get a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}","href":"/pt/reference/rails/consignado/get-subscription"},{"title":"Reveal a subscription's full destination (admin only)","deprecated":null,"version":null,"sidebarTitle":"Reveal subscription endpoint","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}/endpoint","href":"/pt/reference/rails/consignado/reveal-subscription-endpoint"},{"title":"Get a subscription's delivery health","deprecated":null,"version":null,"sidebarTitle":"Get subscription health","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/subscriptions/{id}/health","href":"/pt/reference/rails/consignado/get-subscription-health"},{"title":"Rotate a subscription signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate subscription secret","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/subscriptions/{id}/rotate","href":"/pt/reference/rails/consignado/rotate-subscription-secret"},{"title":"Send a synchronous test delivery","deprecated":null,"version":null,"sidebarTitle":"Test subscription delivery","openapi":"/pt/openapi/v3-current/consignado.yaml post /v1/subscriptions/{id}/test-delivery","href":"/pt/reference/rails/consignado/test-subscription-delivery"},{"title":"Revoke a hub subscription","deprecated":null,"version":null,"sidebarTitle":"Revoke subscription","openapi":"/pt/openapi/v3-current/consignado.yaml delete /v1/subscriptions/{id}","href":"/pt/reference/rails/consignado/revoke-subscription"},{"title":"Census this tenant's outbox event delivery by status","deprecated":null,"version":null,"sidebarTitle":"Get consignado event delivery","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/event-delivery","href":"/pt/reference/rails/consignado/get-consignado-event-delivery"},{"title":"List the outbox facts this gateway destroyed","deprecated":null,"version":null,"sidebarTitle":"List consignado invalid events","openapi":"/pt/openapi/v3-current/consignado.yaml get /v1/consignado/event-delivery/invalid","href":"/pt/reference/rails/consignado/list-consignado-invalid-events"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Consignado","href":"/pt/reference/rails/consignado/consignado-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Consignado","href":"/pt/reference/events/consignado"}]}]}]},{"anchor":"Interfaces","icon":"plug","dropdowns":[{"dropdown":"Pix Lerian","icon":"bolt","description":"APIs da aplicação Pix para integração e testes com o provedor mock","groups":[{"group":"DICT e chaves Pix","pages":[{"group":"Reivindicações de chaves Pix","pages":[{"title":"List Pix key claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /claims","href":"/pt/reference/interfaces/pix-lerian/dict/list-claims"},{"title":"Open a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Create claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /claims","href":"/pt/reference/interfaces/pix-lerian/dict/create-claim"},{"title":"Get a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Get claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /claims/{claim_id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-claim"},{"title":"Acknowledge a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/acknowledge","href":"/pt/reference/interfaces/pix-lerian/dict/acknowledge-claim"},{"title":"Cancel a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/dict/cancel-claim"},{"title":"Complete a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/complete","href":"/pt/reference/interfaces/pix-lerian/dict/complete-claim"},{"title":"Confirm a Pix key claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /claims/{claim_id}/confirm","href":"/pt/reference/interfaces/pix-lerian/dict/confirm-claim"}]},{"group":"Marcadores de fraude","pages":[{"title":"List fraud markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/fraud-markers","href":"/pt/reference/interfaces/pix-lerian/dict/list-fraud-markers"},{"title":"Create a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Create fraud marker","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/fraud-markers","href":"/pt/reference/interfaces/pix-lerian/dict/create-fraud-marker"},{"title":"Get a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get fraud marker","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/fraud-markers/{fraud_marker_id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-fraud-marker"},{"title":"Cancel a fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel fraud marker","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/fraud-markers/{fraud_marker_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/dict/cancel-fraud-marker"}]},{"group":"Recuperações de fundos","pages":[{"title":"List funds recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries","href":"/pt/reference/interfaces/pix-lerian/dict/list-funds-recoveries"},{"title":"Create a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Create funds recovery","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries","href":"/pt/reference/interfaces/pix-lerian/dict/create-funds-recovery"},{"title":"Get a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-funds-recovery"},{"title":"Update a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Patch funds recovery","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml patch /dict/funds-recoveries/{id}","href":"/pt/reference/interfaces/pix-lerian/dict/patch-funds-recovery"},{"title":"Cancel a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Cancel funds recovery","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries/{id}/cancel","href":"/pt/reference/interfaces/pix-lerian/dict/cancel-funds-recovery"},{"title":"List infraction reports for a funds recovery","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/infraction-reports","href":"/pt/reference/interfaces/pix-lerian/dict/list-funds-recovery-infraction-reports"},{"title":"Initiate a refund for a funds recovery","deprecated":null,"version":null,"sidebarTitle":"Refund funds recovery","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries/{id}/refund","href":"/pt/reference/interfaces/pix-lerian/dict/refund-funds-recovery"},{"title":"List refunds linked to a funds recovery","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/refunds","href":"/pt/reference/interfaces/pix-lerian/dict/list-funds-recovery-refunds"},{"title":"Get a funds recovery tracking graph","deprecated":null,"version":null,"sidebarTitle":"Get funds recovery tracking graph","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/funds-recoveries/{id}/tracking-graph","href":"/pt/reference/interfaces/pix-lerian/dict/get-funds-recovery-tracking-graph"}]},{"group":"Relatos de infração","pages":[{"title":"List infraction reports","deprecated":null,"version":null,"sidebarTitle":"List infraction reports","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports","href":"/pt/reference/interfaces/pix-lerian/dict/list-infraction-reports"},{"title":"Get an infraction report","deprecated":null,"version":null,"sidebarTitle":"Get infraction report","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports/{id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-infraction-report"},{"title":"Acknowledge an infraction report","deprecated":null,"version":null,"sidebarTitle":"Acknowledge infraction report","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/acknowledge","href":"/pt/reference/interfaces/pix-lerian/dict/acknowledge-infraction-report"},{"title":"List balance blocks for an infraction report","deprecated":null,"version":null,"sidebarTitle":"List infraction report balance blocks","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/infraction-reports/{id}/balance-blocks","href":"/pt/reference/interfaces/pix-lerian/dict/list-infraction-report-balance-blocks"},{"title":"Cancel an infraction report","deprecated":null,"version":null,"sidebarTitle":"Cancel infraction report","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/cancel","href":"/pt/reference/interfaces/pix-lerian/dict/cancel-infraction-report"},{"title":"Close an infraction report","deprecated":null,"version":null,"sidebarTitle":"Close infraction report","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/infraction-reports/{id}/close","href":"/pt/reference/interfaces/pix-lerian/dict/close-infraction-report"}]},{"group":"Devoluções","pages":[{"title":"List refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/refunds","href":"/pt/reference/interfaces/pix-lerian/dict/list-refunds"},{"title":"Create a refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds","href":"/pt/reference/interfaces/pix-lerian/dict/create-refund"},{"title":"Get a refund","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /dict/refunds/{id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-refund"},{"title":"Close refund blocks after a manual devolution","deprecated":null,"version":null,"sidebarTitle":"Blocks close refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/blocks/close","href":"/pt/reference/interfaces/pix-lerian/dict/blocks-close-refund"},{"title":"Cancel a refund","deprecated":null,"version":null,"sidebarTitle":"Cancel refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/cancel","href":"/pt/reference/interfaces/pix-lerian/dict/cancel-refund"},{"title":"Close a refund with the analysis outcome (Phase 3)","deprecated":null,"version":null,"sidebarTitle":"Close refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/close","href":"/pt/reference/interfaces/pix-lerian/dict/close-refund"},{"title":"Settle a refund with an aggregated block devolution (Phase 1)","deprecated":null,"version":null,"sidebarTitle":"Settle refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/settle","href":"/pt/reference/interfaces/pix-lerian/dict/settle-refund"},{"title":"Confirm the aggregated settlement (liquidation — Phase 2)","deprecated":null,"version":null,"sidebarTitle":"Confirm settle refund","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/refunds/{id}/settle/confirm","href":"/pt/reference/interfaces/pix-lerian/dict/confirm-settle-refund"}]},{"group":"Registros de chaves Pix","pages":[{"title":"List Pix key entries for an account","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /entries","href":"/pt/reference/interfaces/pix-lerian/dict/list-entries"},{"title":"Create a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Create entry","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /entries","href":"/pt/reference/interfaces/pix-lerian/dict/create-entry"},{"title":"Get a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Get entry","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /entries/{entry_id}","href":"/pt/reference/interfaces/pix-lerian/dict/get-entry"},{"title":"Update a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Update entry","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml patch /entries/{entry_id}","href":"/pt/reference/interfaces/pix-lerian/dict/update-entry"},{"title":"Delete a Pix key entry","deprecated":null,"version":null,"sidebarTitle":"Delete entry","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml delete /entries/{entry_id}","href":"/pt/reference/interfaces/pix-lerian/dict/delete-entry"}]},{"group":"Consulta de chaves Pix","pages":[{"title":"Check whether Pix keys exist","deprecated":null,"version":null,"sidebarTitle":"Check keys existence","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml post /keys/check","href":"/pt/reference/interfaces/pix-lerian/dict/check-keys-existence"},{"title":"Retrieve a Pix key","deprecated":null,"version":null,"sidebarTitle":"Lookup key","openapi":"/pt/openapi/v3-current/pix-lerian-dict.yaml get /keys/{key}","href":"/pt/reference/interfaces/pix-lerian/dict/lookup-key"}]}]},{"group":"Cobranças e BR Codes","pages":[{"group":"BR Codes","pages":[{"title":"Decode a Pix EMV payload","deprecated":null,"version":null,"sidebarTitle":"Decode qrcode","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml post /brcodes/decode","href":"/pt/reference/interfaces/pix-lerian/cob/decode-qrcode"},{"title":"List static BR Codes","deprecated":null,"version":null,"sidebarTitle":"List static brcodes","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /brcodes/static","href":"/pt/reference/interfaces/pix-lerian/cob/list-static-brcodes"},{"title":"Create a static BR Code","deprecated":null,"version":null,"sidebarTitle":"Create static brcode","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml post /brcodes/static","href":"/pt/reference/interfaces/pix-lerian/cob/create-static-brcode"},{"title":"Get a static BR Code by ID","deprecated":null,"version":null,"sidebarTitle":"Get static brcode","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /brcodes/static/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/get-static-brcode"}]},{"group":"Cobranças com vencimento","pages":[{"title":"List due-date collections or retrieve one by txId","deprecated":null,"version":null,"sidebarTitle":"List due date collections","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate","href":"/pt/reference/interfaces/pix-lerian/cob/list-due-date-collections"},{"title":"Create a due-date Pix collection (cobv)","deprecated":null,"version":null,"sidebarTitle":"Create due date collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml post /collections/duedate","href":"/pt/reference/interfaces/pix-lerian/cob/create-due-date-collection"},{"title":"Poll the provider's current view of a due-date collection","deprecated":null,"version":null,"sidebarTitle":"Get due date provider status","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate/provider-status","href":"/pt/reference/interfaces/pix-lerian/cob/get-due-date-provider-status"},{"title":"Get a due-date collection by ID","deprecated":null,"version":null,"sidebarTitle":"Get due date collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /collections/duedate/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/get-due-date-collection"},{"title":"Revise a due-date collection's value modifiers","deprecated":null,"version":null,"sidebarTitle":"Revise due date collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml patch /collections/duedate/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/revise-due-date-collection"},{"title":"Cancel a due-date collection","deprecated":null,"version":null,"sidebarTitle":"Cancel due date collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml delete /collections/duedate/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/cancel-due-date-collection"}]},{"group":"Cobranças imediatas","pages":[{"title":"List immediate collections or retrieve one by txId","deprecated":null,"version":null,"sidebarTitle":"List immediate collections","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /collections/immediate","href":"/pt/reference/interfaces/pix-lerian/cob/list-immediate-collections"},{"title":"Create an immediate Pix collection (cob)","deprecated":null,"version":null,"sidebarTitle":"Create immediate collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml post /collections/immediate","href":"/pt/reference/interfaces/pix-lerian/cob/create-immediate-collection"},{"title":"Get an immediate collection by ID","deprecated":null,"version":null,"sidebarTitle":"Get immediate collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml get /collections/immediate/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/get-immediate-collection"},{"title":"Cancel an immediate collection","deprecated":null,"version":null,"sidebarTitle":"Cancel immediate collection","openapi":"/pt/openapi/v3-current/pix-lerian-cob.yaml delete /collections/immediate/{id}","href":"/pt/reference/interfaces/pix-lerian/cob/cancel-immediate-collection"}]}]},{"group":"Pagamentos e devoluções","pages":[{"group":"Devoluções Pix","pages":[{"title":"List Pix refunds for an account","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /refunds","href":"/pt/reference/interfaces/pix-lerian/spi/list-refunds"},{"title":"Get a Pix refund by ID","deprecated":null,"version":null,"sidebarTitle":"Get refund","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /refunds/{id}","href":"/pt/reference/interfaces/pix-lerian/spi/get-refund"},{"title":"Create an outbound Pix refund (MED)","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /transfers/{id}/refunds","href":"/pt/reference/interfaces/pix-lerian/spi/create-refund"}]},{"group":"Transferências Pix","pages":[{"title":"List Pix transfers for an account","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /transfers","href":"/pt/reference/interfaces/pix-lerian/spi/list-transfers"},{"title":"Initiate a Pix transfer (step 1)","deprecated":null,"version":null,"sidebarTitle":"Initiate transfer","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /transfers/cashout/initiate","href":"/pt/reference/interfaces/pix-lerian/spi/initiate-transfer"},{"title":"Process and confirm a Pix transfer (step 2)","deprecated":null,"version":null,"sidebarTitle":"Process transfer","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /transfers/cashout/process","href":"/pt/reference/interfaces/pix-lerian/spi/process-transfer"},{"title":"Get a Pix transfer by ID","deprecated":null,"version":null,"sidebarTitle":"Get transfer","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /transfers/{id}","href":"/pt/reference/interfaces/pix-lerian/spi/get-transfer"}]},{"group":"Pagamentos agendados","pages":[{"title":"Schedules a proposed limit would make unviable","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment limit impact","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-limit-impact","href":"/pt/reference/interfaces/pix-lerian/spi/get-scheduled-payment-limit-impact"},{"title":"Total scheduled for an account on a date","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment totals","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-totals","href":"/pt/reference/interfaces/pix-lerian/spi/get-scheduled-payment-totals"},{"title":"List scheduled Pix payments","deprecated":null,"version":null,"sidebarTitle":"List scheduled payments","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments","href":"/pt/reference/interfaces/pix-lerian/spi/list-scheduled-payments"},{"title":"Register a scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Create scheduled payment","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payments","href":"/pt/reference/interfaces/pix-lerian/spi/create-scheduled-payment"},{"title":"Read one scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments/{schedule_id}","href":"/pt/reference/interfaces/pix-lerian/spi/get-scheduled-payment"},{"title":"Cancel a scheduled Pix payment","deprecated":null,"version":null,"sidebarTitle":"Cancel scheduled payment","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payments/{schedule_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/spi/cancel-scheduled-payment"},{"title":"Read a scheduled payment's receipt","deprecated":null,"version":null,"sidebarTitle":"Get scheduled payment receipt","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payments/{schedule_id}/receipt","href":"/pt/reference/interfaces/pix-lerian/spi/get-scheduled-payment-receipt"},{"title":"List recurring series","deprecated":null,"version":null,"sidebarTitle":"List recurring series","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-recurrences","href":"/pt/reference/interfaces/pix-lerian/spi/list-recurring-series"},{"title":"Create a recurring series","deprecated":null,"version":null,"sidebarTitle":"Create recurring series","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payment-recurrences","href":"/pt/reference/interfaces/pix-lerian/spi/create-recurring-series"},{"title":"Read one recurring series","deprecated":null,"version":null,"sidebarTitle":"Get recurring series","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-recurrences/{recurrence_id}","href":"/pt/reference/interfaces/pix-lerian/spi/get-recurring-series"},{"title":"Cancel a recurring series","deprecated":null,"version":null,"sidebarTitle":"Cancel recurring series","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml post /scheduled-payment-recurrences/{recurrence_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/spi/cancel-recurring-series"},{"title":"Read a recurring series' receipt","deprecated":null,"version":null,"sidebarTitle":"Get recurring series receipt","openapi":"/pt/openapi/v3-current/pix-lerian-spi.yaml get /scheduled-payment-recurrences/{recurrence_id}/receipt","href":"/pt/reference/interfaces/pix-lerian/spi/get-recurring-series-receipt"}]}]},{"group":"API de Pix Automático","pages":[{"title":"List authorization requests pending the payer's decision","deprecated":null,"version":null,"sidebarTitle":"List authorization requests","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorization-requests","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/list-authorization-requests"},{"title":"Load a recurrence from a scanned QR Code","deprecated":null,"version":null,"sidebarTitle":"Create authorization request from qr code","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorization-requests/from-qr","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/create-authorization-request-from-qr-code"},{"title":"Get one authorization request","deprecated":null,"version":null,"sidebarTitle":"Get authorization request","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorization-requests/{authorization_request_id}","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/get-authorization-request"},{"title":"Accept or reject an authorization request","deprecated":null,"version":null,"sidebarTitle":"Decide authorization request","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorization-requests/{authorization_request_id}/decide","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/decide-authorization-request"},{"title":"List the payer's authorizations","deprecated":null,"version":null,"sidebarTitle":"List authorizations","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/list-authorizations"},{"title":"Get one authorization","deprecated":null,"version":null,"sidebarTitle":"Get authorization","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations/{authorization_id}","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/get-authorization"},{"title":"Update the payer-configurable parameters of an authorization","deprecated":null,"version":null,"sidebarTitle":"Update authorization parameters","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml patch /payer/authorizations/{authorization_id}","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/update-authorization-parameters"},{"title":"Cancel an authorization at the payer's request","deprecated":null,"version":null,"sidebarTitle":"Cancel authorization","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/authorizations/{authorization_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/cancel-authorization"},{"title":"List the state transitions of an authorization","deprecated":null,"version":null,"sidebarTitle":"List authorization history","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/authorizations/{authorization_id}/history","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/list-authorization-history"},{"title":"List scheduled debits","deprecated":null,"version":null,"sidebarTitle":"List scheduled payments","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml get /payer/scheduled-payments","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/list-scheduled-payments"},{"title":"Cancel a single scheduled debit at the payer's request","deprecated":null,"version":null,"sidebarTitle":"Cancel scheduled payment","openapi":"/pt/openapi/v3-current/pix-lerian-pixauto.yaml post /payer/scheduled-payments/{scheduled_payment_id}/cancel","href":"/pt/reference/interfaces/pix-lerian/pix-automatico/cancel-scheduled-payment"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Pix Lerian","href":"/pt/reference/interfaces/pix-lerian/pix-lerian-error-list"}]}]},{"dropdown":"Pix JD","icon":"bolt","description":"Operações Pix pela interface direta JD","groups":[{"group":"APIs do participante direto","pages":[{"group":"Entradas","pages":[{"title":"Register a transactional account closure","deprecated":null,"version":null,"sidebarTitle":"Register a transactional account closure","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/account-closures","href":"/pt/reference/interfaces/pix-jd/register-a-transactional-account-closure"},{"title":"List PIX key entries","deprecated":null,"version":null,"sidebarTitle":"List keys","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/entries","href":"/pt/reference/interfaces/pix-jd/list-keys"},{"title":"Register a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Create key","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/entries","href":"/pt/reference/interfaces/pix-jd/create-key"},{"title":"Verify PIX key existence","deprecated":null,"version":null,"sidebarTitle":"Verify pix key existence","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/entries/verification","href":"/pt/reference/interfaces/pix-jd/verify-pix-key-existence"},{"title":"Delete a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Delete key","openapi":"/pt/openapi/v3-current/pix.yaml delete /v1/entries/{entryId}","href":"/pt/reference/interfaces/pix-jd/delete-key"},{"title":"Change a PIX key entry","deprecated":null,"version":null,"sidebarTitle":"Change a pix key entry","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/entries/{entryId}","href":"/pt/reference/interfaces/pix-jd/change-a-pix-key-entry"},{"title":"Confirm PIX key ownership","deprecated":null,"version":null,"sidebarTitle":"Confirm key","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/entries/{entryId}/confirmation","href":"/pt/reference/interfaces/pix-jd/confirm-key"},{"title":"Get PIX key entry details","deprecated":null,"version":null,"sidebarTitle":"Retrieve key","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/entries/{entryId}/details","href":"/pt/reference/interfaces/pix-jd/retrieve-key"},{"title":"Look up a PIX key before paying it","deprecated":null,"version":null,"sidebarTitle":"Look up a pix key before paying it","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/entries/{entryId}/lookup","href":"/pt/reference/interfaces/pix-jd/look-up-a-pix-key-before-paying-it"},{"title":"Register a holder-ownership removal","deprecated":null,"version":null,"sidebarTitle":"Register a holder ownership removal","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/holder-removals","href":"/pt/reference/interfaces/pix-jd/register-a-holder-ownership-removal"}]},{"group":"Reivindicações","pages":[{"title":"List PIX key claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/claims","href":"/pt/reference/interfaces/pix-jd/list-claims"},{"title":"Open a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Create claim","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/claims","href":"/pt/reference/interfaces/pix-jd/create-claim"},{"title":"Cancel a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Cancel claim","openapi":"/pt/openapi/v3-current/pix.yaml delete /v1/claims/{claimId}","href":"/pt/reference/interfaces/pix-jd/cancel-claim"},{"title":"Get a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Retrieve claim","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/claims/{claimId}","href":"/pt/reference/interfaces/pix-jd/retrieve-claim"},{"title":"Conclude a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Complete claim","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/claims/{claimId}/conclusion","href":"/pt/reference/interfaces/pix-jd/complete-claim"},{"title":"Confirm a PIX key claim","deprecated":null,"version":null,"sidebarTitle":"Confirm claim","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/claims/{claimId}/confirmation","href":"/pt/reference/interfaces/pix-jd/confirm-claim"}]},{"group":"Bancos","pages":[{"title":"List PIX participant bank ids","deprecated":null,"version":null,"sidebarTitle":"List pix participant bank ids","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/banks","href":"/pt/reference/interfaces/pix-jd/list-pix-participant-bank-ids"},{"title":"List SPI participants","deprecated":null,"version":null,"sidebarTitle":"List spi participants","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/banks/participants","href":"/pt/reference/interfaces/pix-jd/list-spi-participants"}]},{"group":"Transações","pages":[{"title":"List PIX transactions","deprecated":null,"version":null,"sidebarTitle":"List transactions","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/transactions","href":"/pt/reference/interfaces/pix-jd/list-transactions"},{"title":"Create a PIX transaction","deprecated":null,"version":null,"sidebarTitle":"Create transaction","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/transactions","href":"/pt/reference/interfaces/pix-jd/create-transaction"},{"title":"Get a PIX transaction status","deprecated":null,"version":null,"sidebarTitle":"Retrieve transaction status","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/transactions/{transactionId}","href":"/pt/reference/interfaces/pix-jd/retrieve-transaction-status"}]},{"group":"Limites","pages":[{"title":"List PIX transaction limits","deprecated":null,"version":null,"sidebarTitle":"Retrieve transaction limits","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/limits","href":"/pt/reference/interfaces/pix-jd/retrieve-transaction-limits"},{"title":"Change a PIX transaction limit","deprecated":null,"version":null,"sidebarTitle":"Update transaction limit","openapi":"/pt/openapi/v3-current/pix.yaml patch /v1/limits","href":"/pt/reference/interfaces/pix-jd/update-transaction-limit"},{"title":"Get available PIX limits","deprecated":null,"version":null,"sidebarTitle":"Retrieve available limits","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/limits/available","href":"/pt/reference/interfaces/pix-jd/retrieve-available-limits"}]},{"group":"QR Codes","pages":[{"title":"Decode a scanned PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Decode qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/qrcodes/decode","href":"/pt/reference/interfaces/pix-jd/decode-qr-code"},{"title":"Decode a PIX QR code via its payload URL","deprecated":null,"version":null,"sidebarTitle":"Decode a pix qr code via its payload url","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/qrcodes/decode/url","href":"/pt/reference/interfaces/pix-jd/decode-a-pix-qr-code-via-its-payload-url"},{"title":"Create an immediate dynamic PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Create dynamic qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/qrcodes/dynamic","href":"/pt/reference/interfaces/pix-jd/create-dynamic-qr-code"},{"title":"Update an immediate dynamic PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Update an immediate dynamic pix qr code","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/qrcodes/dynamic/{documentId}","href":"/pt/reference/interfaces/pix-jd/update-an-immediate-dynamic-pix-qr-code"},{"title":"List the PSP's PIX QR codes","deprecated":null,"version":null,"sidebarTitle":"List the psp s pix qr codes","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/qrcodes/list","href":"/pt/reference/interfaces/pix-jd/list-the-psp-s-pix-qr-codes"},{"title":"Create a static PIX QR code","deprecated":null,"version":null,"sidebarTitle":"Create static qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/qrcodes/static","href":"/pt/reference/interfaces/pix-jd/create-static-qr-code"}]},{"group":"Devoluções","pages":[{"title":"Create a PIX refund","deprecated":null,"version":null,"sidebarTitle":"Create refund","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/refunds","href":"/pt/reference/interfaces/pix-jd/create-refund"},{"title":"List PIX refund reasons","deprecated":null,"version":null,"sidebarTitle":"List refund reasons","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/refunds/reasons","href":"/pt/reference/interfaces/pix-jd/list-refund-reasons"}]},{"group":"PIX Automatico","pages":[{"group":"Solicitações de autorização","pages":[{"title":"List PIX Automatico authorizations","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorizations","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations","href":"/pt/reference/interfaces/pix-jd/list-pix-automatico-authorizations"},{"title":"Request a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Request a pix automatico authorization","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations","href":"/pt/reference/interfaces/pix-jd/request-a-pix-automatico-authorization"},{"title":"Register an inbound PIX Automatico cancellation","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico cancellation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/cancellation/register","href":"/pt/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-cancellation"},{"title":"Validate an inbound PIX Automatico cancellation","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico cancellation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/cancellation/validate","href":"/pt/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-cancellation"},{"title":"Register an inbound PIX Automatico solicitation on the PSP Pagador","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico solicitation on the psp pagador","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/payer/register","href":"/pt/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-solicitation-on-the-psp-pagador"},{"title":"Register an inbound PIX Automatico authorization on the PSP Recebedor","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico authorization on the psp recebedor","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/recipient/register","href":"/pt/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-authorization-on-the-psp-recebedor"},{"title":"Validate an inbound PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico authorization","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/inbound/validate","href":"/pt/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-authorization"}]},{"group":"Gestão de autorizações","pages":[{"title":"Consult a PIX Automatico authorization situation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico authorization situation","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations/{idRecorrencia}","href":"/pt/reference/interfaces/pix-jd/consult-a-pix-automatico-authorization-situation"},{"title":"Cancel a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico authorization","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/cancel","href":"/pt/reference/interfaces/pix-jd/cancel-a-pix-automatico-authorization"},{"title":"Consult a PIX Automatico authorization cancellation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico authorization cancellation","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/authorizations/{idRecorrencia}/cancel/{idCancelamento}","href":"/pt/reference/interfaces/pix-jd/consult-a-pix-automatico-authorization-cancellation"},{"title":"Confirm a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Confirm a pix automatico authorization","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/confirm","href":"/pt/reference/interfaces/pix-jd/confirm-a-pix-automatico-authorization"},{"title":"Update a PIX Automatico authorization max value","deprecated":null,"version":null,"sidebarTitle":"Update a pix automatico authorization max value","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/pix-automatico/authorizations/{idRecorrencia}/max-value","href":"/pt/reference/interfaces/pix-jd/update-a-pix-automatico-authorization-max-value"},{"title":"Respond to a PIX Automatico authorization","deprecated":null,"version":null,"sidebarTitle":"Respond to a pix automatico authorization","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/pix-automatico/authorizations/{idRecorrencia}/respond","href":"/pt/reference/interfaces/pix-jd/respond-to-a-pix-automatico-authorization"},{"title":"Register a PIX Automatico authorization validation","deprecated":null,"version":null,"sidebarTitle":"Register a pix automatico authorization validation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/authorizations/{idRecorrencia}/validation","href":"/pt/reference/interfaces/pix-jd/register-a-pix-automatico-authorization-validation"}]},{"group":"QR Codes compostos","pages":[{"title":"Create a CobV (due-date) composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a cobv due date composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/cobv","href":"/pt/reference/interfaces/pix-jd/create-a-cobv-due-date-composite-pix-automatico-qr-code"},{"title":"Update a CobV (due-date) composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update a cobv due date composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/cobv/{id}","href":"/pt/reference/interfaces/pix-jd/update-a-cobv-due-date-composite-pix-automatico-qr-code"},{"title":"Decode a composite PIX Automatico QR code from its URL","deprecated":null,"version":null,"sidebarTitle":"Decode a composite pix automatico qr code from its url","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/decode","href":"/pt/reference/interfaces/pix-jd/decode-a-composite-pix-automatico-qr-code-from-its-url"},{"title":"Create an immediate dynamic composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create an immediate dynamic composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/dynamic","href":"/pt/reference/interfaces/pix-jd/create-an-immediate-dynamic-composite-pix-automatico-qr-code"},{"title":"Update an immediate dynamic composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update an immediate dynamic composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/dynamic/{id}","href":"/pt/reference/interfaces/pix-jd/update-an-immediate-dynamic-composite-pix-automatico-qr-code"},{"title":"Create a recurrence-only composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a recurrence only composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/recurrence","href":"/pt/reference/interfaces/pix-jd/create-a-recurrence-only-composite-pix-automatico-qr-code"},{"title":"Update a recurrence-only composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Update a recurrence only composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/pix-automatico/composite/recurrence/{id}","href":"/pt/reference/interfaces/pix-jd/update-a-recurrence-only-composite-pix-automatico-qr-code"},{"title":"Create a static composite PIX Automatico QR code","deprecated":null,"version":null,"sidebarTitle":"Create a static composite pix automatico qr code","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/composite/static","href":"/pt/reference/interfaces/pix-jd/create-a-static-composite-pix-automatico-qr-code"}]},{"group":"Eventos de autorização","pages":[{"title":"Receive a PIX Automatico authorization cancellation registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization cancellation registration event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-cancellation-registered","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-cancellation-registration-event"},{"title":"Receive a PIX Automatico authorization cancellation status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization cancellation status event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-cancellation-status","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-cancellation-status-event"},{"title":"Receive a PIX Automatico payer-side authorization registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico payer side authorization registration event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-payer-registered","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-payer-side-authorization-registration-event"},{"title":"Receive a PIX Automatico recipient-side authorization registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico recipient side authorization registration event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-recipient-registered","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-recipient-side-authorization-registration-event"},{"title":"Receive a PIX Automatico authorization status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico authorization status event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/authorization-status","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-authorization-status-event"}]},{"group":"Eventos de agendamento","pages":[{"title":"Receive a PIX Automatico schedule cancellation registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule cancellation registration event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-cancellation-registered","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-cancellation-registration-event"},{"title":"Receive a PIX Automatico schedule cancellation status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule cancellation status event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-cancellation-status","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-cancellation-status-event"},{"title":"Receive a PIX Automatico schedule registration event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule registration event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-registered","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-registration-event"},{"title":"Receive a PIX Automatico schedule status event","deprecated":null,"version":null,"sidebarTitle":"Receive a pix automatico schedule status event","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/events/schedule-status","href":"/pt/reference/interfaces/pix-jd/receive-a-pix-automatico-schedule-status-event"}]},{"group":"Agendamentos e instruções de pagamento","pages":[{"title":"Request a PIX Automatico schedule send","deprecated":null,"version":null,"sidebarTitle":"Request a pix automatico schedule send","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules","href":"/pt/reference/interfaces/pix-jd/request-a-pix-automatico-schedule-send"},{"title":"Register an inbound PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico schedule cancellation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/cancellation/register","href":"/pt/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-schedule-cancellation"},{"title":"Validate an inbound PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico schedule cancellation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/cancellation/validate","href":"/pt/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-schedule-cancellation"},{"title":"Register an inbound PIX Automatico payment instruction","deprecated":null,"version":null,"sidebarTitle":"Register an inbound pix automatico payment instruction","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/register","href":"/pt/reference/interfaces/pix-jd/register-an-inbound-pix-automatico-payment-instruction"},{"title":"Validate an inbound PIX Automatico payment instruction","deprecated":null,"version":null,"sidebarTitle":"Validate an inbound pix automatico payment instruction","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/inbound/validate","href":"/pt/reference/interfaces/pix-jd/validate-an-inbound-pix-automatico-payment-instruction"},{"title":"List PIX Automatico schedules","deprecated":null,"version":null,"sidebarTitle":"List pix automatico schedules","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/list","href":"/pt/reference/interfaces/pix-jd/list-pix-automatico-schedules"},{"title":"Consult a PIX Automatico schedule situation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico schedule situation","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/{endToEndId}","href":"/pt/reference/interfaces/pix-jd/consult-a-pix-automatico-schedule-situation"},{"title":"Cancel a PIX Automatico schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico schedule","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/schedules/{endToEndId}/cancel","href":"/pt/reference/interfaces/pix-jd/cancel-a-pix-automatico-schedule"},{"title":"Consult a PIX Automatico schedule cancellation","deprecated":null,"version":null,"sidebarTitle":"Consult a pix automatico schedule cancellation","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/pix-automatico/schedules/{endToEndId}/cancel/{idCancelamento}","href":"/pt/reference/interfaces/pix-jd/consult-a-pix-automatico-schedule-cancellation"}]},{"group":"Liquidação","pages":[{"title":"Reserve an inbound PIX Automatico debit hold","deprecated":null,"version":null,"sidebarTitle":"Reserve an inbound pix automatico debit hold","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/block","href":"/pt/reference/interfaces/pix-jd/reserve-an-inbound-pix-automatico-debit-hold"},{"title":"Effect an inbound PIX Automatico settlement debit","deprecated":null,"version":null,"sidebarTitle":"Effect an inbound pix automatico settlement debit","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/settlements/inbound/debit","href":"/pt/reference/interfaces/pix-jd/effect-an-inbound-pix-automatico-settlement-debit"},{"title":"Reverse an inbound PIX Automatico settlement debit","deprecated":null,"version":null,"sidebarTitle":"Reverse an inbound pix automatico settlement debit","openapi":"/pt/openapi/v3-current/pix.yaml delete /v1/pix-automatico/settlements/inbound/debit/{endToEndId}","href":"/pt/reference/interfaces/pix-jd/reverse-an-inbound-pix-automatico-settlement-debit"}]},{"group":"JD Courier","pages":[{"title":"Tell the JD Courier which Pix Automático traffic is this engine's","deprecated":null,"version":null,"sidebarTitle":"Tell the jd courier which pix automatico traffic is this engine s","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/pix-automatico/courier-ownership","href":"/pt/reference/interfaces/pix-jd/tell-the-jd-courier-which-pix-automatico-traffic-is-this-engine-s"}]}]},{"group":"MED Infrações","pages":[{"title":"List MED infractions","deprecated":null,"version":null,"sidebarTitle":"List med infractions","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/infractions","href":"/pt/reference/interfaces/pix-jd/list-med-infractions"},{"title":"Get a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Get a med infraction","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/infractions/{idRelatoInfracao}","href":"/pt/reference/interfaces/pix-jd/get-a-med-infraction"},{"title":"Analyze a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Analyze a med infraction","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/infractions/{idRelatoInfracao}/analyze","href":"/pt/reference/interfaces/pix-jd/analyze-a-med-infraction"},{"title":"Cancel a MED infraction","deprecated":null,"version":null,"sidebarTitle":"Cancel a med infraction","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/infractions/{idRelatoInfracao}/cancel","href":"/pt/reference/interfaces/pix-jd/cancel-a-med-infraction"},{"title":"Get a MED infraction from the JDPI base","deprecated":null,"version":null,"sidebarTitle":"Get a med infraction from jdpi","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/infractions/{idRelatoInfracao}/jdpi","href":"/pt/reference/interfaces/pix-jd/get-a-med-infraction-from-jdpi"}]},{"group":"MED Devoluções","pages":[{"title":"List MED refund requests","deprecated":null,"version":null,"sidebarTitle":"List med refund requests","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/refunds","href":"/pt/reference/interfaces/pix-jd/list-med-refund-requests"},{"title":"Open a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Open a med refund request","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/refunds","href":"/pt/reference/interfaces/pix-jd/open-a-med-refund-request"},{"title":"Get the credit status of a MED refund order","deprecated":null,"version":null,"sidebarTitle":"Get a med refund credit status","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/refunds/credits/{endToEndIdDevolucao}","href":"/pt/reference/interfaces/pix-jd/get-a-med-refund-credit-status"},{"title":"List MED refund requests pending my analysis","deprecated":null,"version":null,"sidebarTitle":"List med refund requests pending my analysis","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/refunds/pending-analysis","href":"/pt/reference/interfaces/pix-jd/list-med-refund-requests-pending-my-analysis"},{"title":"Get a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Get a med refund request","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/refunds/{idSolDevolucao}","href":"/pt/reference/interfaces/pix-jd/get-a-med-refund-request"},{"title":"Analyze a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Analyze a med refund request","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/analyze","href":"/pt/reference/interfaces/pix-jd/analyze-a-med-refund-request"},{"title":"Cancel a MED refund request","deprecated":null,"version":null,"sidebarTitle":"Cancel a med refund request","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/cancel","href":"/pt/reference/interfaces/pix-jd/cancel-a-med-refund-request"},{"title":"Effectuate a MED refund debit (THIRD RAIL — moves money)","deprecated":null,"version":null,"sidebarTitle":"Effectuate a med refund debit","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/refunds/{idSolDevolucao}/effectuate","href":"/pt/reference/interfaces/pix-jd/effectuate-a-med-refund-debit"},{"title":"Get a MED refund request from the JDPI base","deprecated":null,"version":null,"sidebarTitle":"Get a med refund request from jdpi","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/refunds/{idSolDevolucao}/jdpi","href":"/pt/reference/interfaces/pix-jd/get-a-med-refund-request-from-jdpi"}]},{"group":"MED Marcadores de Fraude","pages":[{"title":"List MED fraud markers (local base)","deprecated":null,"version":null,"sidebarTitle":"List med fraud markers local base","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/fraud-markers","href":"/pt/reference/interfaces/pix-jd/list-med-fraud-markers-local-base"},{"title":"Register a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Register a med fraud marker","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/fraud-markers","href":"/pt/reference/interfaces/pix-jd/register-a-med-fraud-marker"},{"title":"List MED fraud markers (DICT-direct)","deprecated":null,"version":null,"sidebarTitle":"List med fraud markers dict direct","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/fraud-markers/dict","href":"/pt/reference/interfaces/pix-jd/list-med-fraud-markers-dict-direct"},{"title":"Get a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Get a med fraud marker","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/fraud-markers/{idMarcacaoFraude}","href":"/pt/reference/interfaces/pix-jd/get-a-med-fraud-marker"},{"title":"Cancel a MED fraud marker","deprecated":null,"version":null,"sidebarTitle":"Cancel a med fraud marker","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/fraud-markers/{idMarcacaoFraude}/cancel","href":"/pt/reference/interfaces/pix-jd/cancel-a-med-fraud-marker"}]},{"group":"MED Recuperações","pages":[{"title":"Create a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Create a med value recovery","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/recoveries","href":"/pt/reference/interfaces/pix-jd/create-a-med-value-recovery"},{"title":"List MED recoveries awaiting return","deprecated":null,"version":null,"sidebarTitle":"List med recoveries awaiting return","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/recoveries/awaiting-return","href":"/pt/reference/interfaces/pix-jd/list-med-recoveries-awaiting-return"},{"title":"Get a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Get a med value recovery","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/med/recoveries/{idRecValores}","href":"/pt/reference/interfaces/pix-jd/get-a-med-value-recovery"},{"title":"Amend a MED value recovery","deprecated":null,"version":null,"sidebarTitle":"Amend a med value recovery","openapi":"/pt/openapi/v3-current/pix.yaml put /v1/med/recoveries/{idRecValores}/amend","href":"/pt/reference/interfaces/pix-jd/amend-a-med-value-recovery"},{"title":"Start a MED value recovery return stage","deprecated":null,"version":null,"sidebarTitle":"Start a med value recovery return stage","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/med/recoveries/{idRecValores}/return","href":"/pt/reference/interfaces/pix-jd/start-a-med-value-recovery-return-stage"}]},{"group":"Webhooks","pages":[{"title":"Process an inbound JDPI cash-in","deprecated":null,"version":null,"sidebarTitle":"Process an inbound upstream cash in","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/webhooks/cash-ins","href":"/pt/reference/interfaces/pix-jd/process-an-inbound-upstream-cash-in"},{"title":"Process a payee-bank-initiated PIX devolução","deprecated":null,"version":null,"sidebarTitle":"Process a payee bank initiated pix devolu o","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/webhooks/refunds","href":"/pt/reference/interfaces/pix-jd/process-a-payee-bank-initiated-pix-devolu-o"},{"title":"Validate a receiving account synchronously","deprecated":null,"version":null,"sidebarTitle":"Validate a receiving account synchronously","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/webhooks/validates","href":"/pt/reference/interfaces/pix-jd/validate-a-receiving-account-synchronously"},{"title":"Receive an asynchronous account validation","deprecated":null,"version":null,"sidebarTitle":"Receive an asynchronous account validation","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/webhooks/validates/async","href":"/pt/reference/interfaces/pix-jd/receive-an-asynchronous-account-validation"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Pix JD","href":"/pt/reference/interfaces/pix-jd/pix-jd-error-list"}]},{"group":"Eventos","pages":[{"title":"Eventos do Pix Direct via JD","href":"/pt/reference/events/pix-direct-jd"}]}]},{"group":"APIs de participantes indiretos","pages":[{"title":"Participantes indiretos","sidebarTitle":"Visão geral","href":"/pt/reference/interfaces/pix-jd/indirect-participants"},{"title":"List indirect participants","deprecated":null,"version":null,"sidebarTitle":"List indirect participants","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/indirects","href":"/pt/reference/interfaces/pix-jd/list-indirect-participants"},{"title":"Register an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Register an indirect participant","openapi":"/pt/openapi/v3-current/pix.yaml post /v1/indirects","href":"/pt/reference/interfaces/pix-jd/register-an-indirect-participant"},{"title":"Get an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Get an indirect participant","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}","href":"/pt/reference/interfaces/pix-jd/get-an-indirect-participant"},{"title":"Update an indirect participant","deprecated":null,"version":null,"sidebarTitle":"Update an indirect participant","openapi":"/pt/openapi/v3-current/pix.yaml patch /v1/indirects/{indirectId}","href":"/pt/reference/interfaces/pix-jd/update-an-indirect-participant"},{"title":"Get an indirect participant's JWK Set","deprecated":null,"version":null,"sidebarTitle":"Get an indirect participant jwk set","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}/jwks","href":"/pt/reference/interfaces/pix-jd/get-an-indirect-participant-jwk-set"},{"title":"List an indirect participant's transactions","deprecated":null,"version":null,"sidebarTitle":"List indirect participant transactions","openapi":"/pt/openapi/v3-current/pix.yaml get /v1/indirects/{indirectId}/transactions","href":"/pt/reference/interfaces/pix-jd/list-indirect-participant-transactions"}]}]},{"dropdown":"JD Courier","icon":"route","description":"Coexistência de motores em um canal JD","groups":[{"group":"Motores","pages":[{"title":"List the registered engines","deprecated":null,"version":null,"sidebarTitle":"List the registered engines","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/engines","href":"/pt/reference/interfaces/jd-courier/list-the-registered-engines"},{"title":"Register an engine","deprecated":null,"version":null,"sidebarTitle":"Register an engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/engines","href":"/pt/reference/interfaces/jd-courier/register-an-engine"},{"title":"Enable, disable or rename an engine","deprecated":null,"version":null,"sidebarTitle":"Enable disable or rename an engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml patch /v1/engines/{engineId}","href":"/pt/reference/interfaces/jd-courier/enable-disable-or-rename-an-engine"},{"title":"Issue the engine's SOAP channel credential","deprecated":null,"version":null,"sidebarTitle":"Issue the engine s soap channel credential","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/engines/{engineId}/channel-credential","href":"/pt/reference/interfaces/jd-courier/issue-the-engine-s-soap-channel-credential"},{"title":"Revoke one of the engine's SOAP channel credentials","deprecated":null,"version":null,"sidebarTitle":"Revoke one of the engine s soap channel credentials","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/engines/{engineId}/channel-credential/{credentialId}/revoke","href":"/pt/reference/interfaces/jd-courier/revoke-one-of-the-engine-s-soap-channel-credentials"}]},{"group":"Mapa de titularidade","pages":[{"title":"List ownership assignments","deprecated":null,"version":null,"sidebarTitle":"List ownership assignments","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments","href":"/pt/reference/interfaces/jd-courier/list-ownership-assignments"},{"title":"Assign a key to an engine","deprecated":null,"version":null,"sidebarTitle":"Assign a key to an engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/ownership/assignments","href":"/pt/reference/interfaces/jd-courier/assign-a-key-to-an-engine"},{"title":"Read one ownership assignment","deprecated":null,"version":null,"sidebarTitle":"Read one ownership assignment","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments/{assignmentId}","href":"/pt/reference/interfaces/jd-courier/read-one-ownership-assignment"},{"title":"Unassign a key","deprecated":null,"version":null,"sidebarTitle":"Unassign a key","openapi":"/pt/openapi/v3-current/jd-courier.yaml delete /v1/ownership/assignments/{assignmentId}","href":"/pt/reference/interfaces/jd-courier/unassign-a-key"},{"title":"Move a key to another engine","deprecated":null,"version":null,"sidebarTitle":"Move a key to another engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/ownership/assignments/{assignmentId}/move","href":"/pt/reference/interfaces/jd-courier/move-a-key-to-another-engine"},{"title":"Ownership history for one key","deprecated":null,"version":null,"sidebarTitle":"Ownership history for one key","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/ownership/assignments/{assignmentId}/audit","href":"/pt/reference/interfaces/jd-courier/ownership-history-for-one-key"},{"title":"Ownership history for one key, addressed by the key","deprecated":null,"version":null,"sidebarTitle":"Ownership history for one key addressed by the key","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/ownership/audit/lookup","href":"/pt/reference/interfaces/jd-courier/ownership-history-for-one-key-addressed-by-the-key"}]},{"group":"API dos motores","pages":[{"title":"Resolve which engine owns a key","deprecated":null,"version":null,"sidebarTitle":"Resolve which engine owns a key","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/ownership/lookup","href":"/pt/reference/interfaces/jd-courier/resolve-which-engine-owns-a-key"},{"title":"Claim a Pix Automático recurrence for the calling engine","deprecated":null,"version":null,"sidebarTitle":"Claim a pix automatico recurrence for the calling engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml put /v1/ownership/recurrences/{recurrenceId}","href":"/pt/reference/interfaces/jd-courier/claim-a-pix-automatico-recurrence-for-the-calling-engine"},{"title":"Declare an earlier leg of a Pix Automático payment the calling engine holds","deprecated":null,"version":null,"sidebarTitle":"Declare an earlier leg of a pix automatico payment the calling engine holds","openapi":"/pt/openapi/v3-current/jd-courier.yaml put /v1/ownership/payments/{endToEndId}/legs/{leg}","href":"/pt/reference/interfaces/jd-courier/declare-an-earlier-leg-of-a-pix-automatico-payment-the-calling-engine-holds"}]},{"group":"Canais","pages":[{"title":"List the registered rails, their declared properties and their state","deprecated":null,"version":null,"sidebarTitle":"List the registered rails their declared properties and their state","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/channels","href":"/pt/reference/interfaces/jd-courier/list-the-registered-rails-their-declared-properties-and-their-state"},{"title":"Activate a rail for the caller's tenant","deprecated":null,"version":null,"sidebarTitle":"Activate a rail for the caller s tenant","openapi":"/pt/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/activation","href":"/pt/reference/interfaces/jd-courier/activate-a-rail-for-the-caller-s-tenant"},{"title":"Suspend a rail for the caller's tenant","deprecated":null,"version":null,"sidebarTitle":"Suspend a rail for the caller s tenant","openapi":"/pt/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/activation","href":"/pt/reference/interfaces/jd-courier/suspend-a-rail-for-the-caller-s-tenant"},{"title":"Declare that an engine is in bypass on this rail","deprecated":null,"version":null,"sidebarTitle":"Declare that an engine is in bypass on this rail","openapi":"/pt/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/bypass","href":"/pt/reference/interfaces/jd-courier/declare-that-an-engine-is-in-bypass-on-this-rail"},{"title":"Declare the end of a bypass on this rail","deprecated":null,"version":null,"sidebarTitle":"Declare the end of a bypass on this rail","openapi":"/pt/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/bypass","href":"/pt/reference/interfaces/jd-courier/declare-the-end-of-a-bypass-on-this-rail"},{"title":"List the per-code delivery-mode declarations on a rail","deprecated":null,"version":null,"sidebarTitle":"List the per code delivery mode declarations on a rail","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/channels/{channelId}/delivery-modes","href":"/pt/reference/interfaces/jd-courier/list-the-per-code-delivery-mode-declarations-on-a-rail"},{"title":"Declare the delivery mode for one message code","deprecated":null,"version":null,"sidebarTitle":"Declare the delivery mode for one message code","openapi":"/pt/openapi/v3-current/jd-courier.yaml put /v1/channels/{channelId}/delivery-modes/{messageCode}","href":"/pt/reference/interfaces/jd-courier/declare-the-delivery-mode-for-one-message-code"},{"title":"Revoke a code's declaration and restore the single-owner default","deprecated":null,"version":null,"sidebarTitle":"Revoke a code s declaration and restore the single owner default","openapi":"/pt/openapi/v3-current/jd-courier.yaml delete /v1/channels/{channelId}/delivery-modes/{messageCode}","href":"/pt/reference/interfaces/jd-courier/revoke-a-code-s-declaration-and-restore-the-single-owner-default"},{"title":"Lift a durable channel halt","deprecated":null,"version":null,"sidebarTitle":"Lift a durable channel halt","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/channels/{channelId}/lease/resume","href":"/pt/reference/interfaces/jd-courier/lift-a-durable-channel-halt"}]},{"group":"Mensagens","pages":[{"title":"List retained messages","deprecated":null,"version":null,"sidebarTitle":"List retained messages","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/retained","href":"/pt/reference/interfaces/jd-courier/list-retained-messages"},{"title":"Run a retained message's routing decision again","deprecated":null,"version":null,"sidebarTitle":"Run a retained message s routing decision again","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/retained/{messageId}/reevaluate","href":"/pt/reference/interfaces/jd-courier/run-a-retained-message-s-routing-decision-again"},{"title":"Reopen the delivery of a message to an engine","deprecated":null,"version":null,"sidebarTitle":"Reopen the delivery of a message to an engine","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/messages/{messageId}/redeliver","href":"/pt/reference/interfaces/jd-courier/reopen-the-delivery-of-a-message-to-an-engine"}]},{"group":"Registro de envios","pages":[{"title":"List SPB sends","deprecated":null,"version":null,"sidebarTitle":"List spb sends","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/send-journal","href":"/pt/reference/interfaces/jd-courier/list-spb-sends"},{"title":"One SPB send and its query history","deprecated":null,"version":null,"sidebarTitle":"One spb send and its query history","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/send-journal/{controlId}","href":"/pt/reference/interfaces/jd-courier/one-spb-send-and-its-query-history"},{"title":"Close an indeterminate send by hand","deprecated":null,"version":null,"sidebarTitle":"Close an indeterminate send by hand","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/send-journal/{controlId}/resolve","href":"/pt/reference/interfaces/jd-courier/close-an-indeterminate-send-by-hand"}]},{"group":"Conciliação","pages":[{"title":"Reconciliation report for a rail","deprecated":null,"version":null,"sidebarTitle":"Reconciliation report for a rail","openapi":"/pt/openapi/v3-current/jd-courier.yaml get /v1/channels/{channelId}/reconciliation","href":"/pt/reference/interfaces/jd-courier/reconciliation-report-for-a-rail"},{"title":"Trigger a reconciliation cycle for a rail","deprecated":null,"version":null,"sidebarTitle":"Trigger a reconciliation cycle for a rail","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/channels/{channelId}/reconciliation/tick","href":"/pt/reference/interfaces/jd-courier/trigger-a-reconciliation-cycle-for-a-rail"},{"title":"Close a reconciliation finding","deprecated":null,"version":null,"sidebarTitle":"Close a reconciliation finding","openapi":"/pt/openapi/v3-current/jd-courier.yaml post /v1/assurance/findings/{findingId}/close","href":"/pt/reference/interfaces/jd-courier/close-a-reconciliation-finding"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do JD Courier","href":"/pt/reference/interfaces/jd-courier/jd-courier-error-list"}]}]},{"dropdown":"Pix BTG","icon":"bolt","description":"Operações Pix pela interface indireta BTG","groups":[{"group":"API de DICT","pages":[{"title":"Check Pix Keys Existence","deprecated":null,"version":null,"sidebarTitle":"Check keys existence","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/keys/check","href":"/pt/reference/interfaces/pix-btg/check-keys-existence"},{"title":"Create a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Create entry","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/entries","href":"/pt/reference/interfaces/pix-btg/create-entry"},{"title":"Delete a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Delete an entry","openapi":"/pt/openapi/v3-current/indirect-pix.yaml delete /v1/dict/entries/{entry_id}","href":"/pt/reference/interfaces/pix-btg/delete-an-entry"},{"title":"List All Pix Entries","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries","href":"/pt/reference/interfaces/pix-btg/list-entries"},{"title":"Retrieve a Pix Key","deprecated":null,"version":null,"sidebarTitle":"Retrieve a key","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/keys/{key}","href":"/pt/reference/interfaces/pix-btg/retrieve-a-key"},{"title":"Get a Pix Entry","deprecated":null,"version":null,"sidebarTitle":"Retrieve an entry","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/entries/{entry_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-an-entry"},{"title":"Update a Pix Entry Data","deprecated":null,"version":null,"sidebarTitle":"Update an entry","openapi":"/pt/openapi/v3-current/indirect-pix.yaml patch /v1/dict/entries/{entry_id}","href":"/pt/reference/interfaces/pix-btg/update-an-entry"}]},{"group":"API de Reivindicações","pages":[{"title":"Acknowledge a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Acknowledge a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/acknowledge","href":"/pt/reference/interfaces/pix-btg/acknowledge-a-claim"},{"title":"Cancel a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Cancel a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-a-claim"},{"title":"Complete a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Complete a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/complete","href":"/pt/reference/interfaces/pix-btg/complete-a-claim"},{"title":"Confirm a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Confirm a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims/{claim_id}/confirm","href":"/pt/reference/interfaces/pix-btg/confirm-a-claim"},{"title":"Create a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Create a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/claims","href":"/pt/reference/interfaces/pix-btg/create-a-claim"},{"title":"List Key Claims","deprecated":null,"version":null,"sidebarTitle":"List claims","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/claims","href":"/pt/reference/interfaces/pix-btg/list-claims"},{"title":"Get a Key Claim","deprecated":null,"version":null,"sidebarTitle":"Retrieve a claim","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/claims/{claim_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-a-claim"}]},{"group":"MED · Infrações","pages":[{"title":"Acknowledge an Infraction Report","deprecated":null,"version":null,"sidebarTitle":"Acknowledge an infraction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/acknowledge","href":"/pt/reference/interfaces/pix-btg/acknowledge-an-infraction-report"},{"title":"Cancel an Infraction Report","deprecated":null,"version":null,"sidebarTitle":"Cancel an infraction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-an-infraction-report"},{"title":"Close an Infraction Report","deprecated":true,"version":null,"sidebarTitle":"Close an infraction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports/{infraction_id}/close","href":"/pt/reference/interfaces/pix-btg/close-an-infraction-report"},{"title":"Create an Infraction Report","deprecated":true,"version":null,"sidebarTitle":"Create an infraction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/infraction-reports","href":"/pt/reference/interfaces/pix-btg/create-an-infraction-report"},{"title":"List Infraction Reports","deprecated":null,"version":null,"sidebarTitle":"List infraction reports","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/infraction-reports","href":"/pt/reference/interfaces/pix-btg/list-infraction-reports"},{"title":"Retrieve Infraction Report details","deprecated":null,"version":null,"sidebarTitle":"Retrieve an infraction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/infraction-reports/{infraction_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-an-infraction-report"}]},{"group":"MED · Marcadores de fraude","pages":[{"title":"Cancel a Fraud Marker","deprecated":null,"version":null,"sidebarTitle":"Cancel a fraud marker","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/fraud-markers/{fraud_marker_id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-a-fraud-marker"},{"title":"Create a Fraud Marker","deprecated":null,"version":null,"sidebarTitle":"Create a fraud marker","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/fraud-markers","href":"/pt/reference/interfaces/pix-btg/create-a-fraud-marker"},{"title":"List Fraud Markers","deprecated":null,"version":null,"sidebarTitle":"List fraud markers","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/fraud-markers","href":"/pt/reference/interfaces/pix-btg/list-fraud-markers"}]},{"group":"MED · Solicitações de devolução","pages":[{"title":"Cancel a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Cancel a refund request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests/{refund_id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-a-refund-request"},{"title":"Close a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Close a refund request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests/{refund_id}/close","href":"/pt/reference/interfaces/pix-btg/close-a-refund-request"},{"title":"Create a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Create a refund request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/refund-requests","href":"/pt/reference/interfaces/pix-btg/create-a-refund-request"},{"title":"List Refund Requests","deprecated":null,"version":null,"sidebarTitle":"List refund requests","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/refund-requests","href":"/pt/reference/interfaces/pix-btg/list-refund-requests"},{"title":"Retrieve a Refund Request","deprecated":null,"version":null,"sidebarTitle":"Retrieve a refund request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/refund-requests/{refund_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-a-refund-request"}]},{"group":"MED · Estatísticas","pages":[{"title":"Get Key Statistics","deprecated":null,"version":null,"sidebarTitle":"Retrieve key statistics","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/statistics/keys/{key}","href":"/pt/reference/interfaces/pix-btg/retrieve-key-statistics"},{"title":"Get Person Statistics","deprecated":null,"version":null,"sidebarTitle":"Retrieve person statistics","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/statistics/persons/{tax_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-person-statistics"}]},{"group":"API de Transações","pages":[{"title":"Get a Refund","deprecated":null,"version":null,"sidebarTitle":"Get a refund","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/refunds/{refund_id}","href":"/pt/reference/interfaces/pix-btg/get-a-refund"},{"title":"Initiate a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Initiate a pix transfer","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/transfers/cashout/initiate","href":"/pt/reference/interfaces/pix-btg/initiate-a-pix-transfer"},{"title":"List Pix Transfers","deprecated":null,"version":null,"sidebarTitle":"List pix transfers","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/transfers","href":"/pt/reference/interfaces/pix-btg/list-pix-transfers"},{"title":"List Refunds","deprecated":null,"version":null,"sidebarTitle":"List refunds","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/refunds","href":"/pt/reference/interfaces/pix-btg/list-refunds"},{"title":"Process a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Process a pix transfer","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/transfers/cashout/process","href":"/pt/reference/interfaces/pix-btg/process-a-pix-transfer"},{"title":"Refund a Received Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Refund a received pix transfer","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/transfers/{transfer_id}/refunds","href":"/pt/reference/interfaces/pix-btg/refund-a-received-pix-transfer"},{"title":"Get a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve a pix transfer","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/transfers/{transfer_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-a-pix-transfer"},{"title":"Unblock a Pix Refund","deprecated":null,"version":null,"sidebarTitle":"Unblock a pix refund","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/refunds/{refund_id}/unblock","href":"/pt/reference/interfaces/pix-btg/unblock-a-pix-refund"},{"title":"Unblock a Pix Transfer","deprecated":null,"version":null,"sidebarTitle":"Unblock a pix transfer","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/transfers/{transfer_id}/unblock","href":"/pt/reference/interfaces/pix-btg/unblock-a-pix-transfer"}]},{"group":"API de QR Codes","pages":[{"title":"Create a Static QR Code","deprecated":null,"version":null,"sidebarTitle":"Create a static qr code","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/brcode/static","href":"/pt/reference/interfaces/pix-btg/create-a-static-qr-code"},{"title":"Decode a Pix QR Code","deprecated":null,"version":null,"sidebarTitle":"Decode a pix qr code","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/qrcodes/decode","href":"/pt/reference/interfaces/pix-btg/decode-a-pix-qr-code"},{"title":"List Static QR Codes","deprecated":null,"version":null,"sidebarTitle":"List static qr codes","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/brcode/static","href":"/pt/reference/interfaces/pix-btg/list-static-qr-codes"},{"title":"Retrieve Static QR Code Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve a static qr code","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/brcode/static/{brcode_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-a-static-qr-code"}]},{"group":"API de Cobranças","pages":[{"title":"Create a Dynamic Charge with Due Date","deprecated":null,"version":null,"sidebarTitle":"Create a dynamic charge with due date","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/collections/duedate","href":"/pt/reference/interfaces/pix-btg/create-a-dynamic-charge-with-due-date"},{"title":"Create an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Create an immediate charge","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/collections/immediate","href":"/pt/reference/interfaces/pix-btg/create-an-immediate-charge"},{"title":"Delete an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Delete an immediate charge","openapi":"/pt/openapi/v3-current/indirect-pix.yaml delete /v1/collections/immediate/{collection_id}","href":"/pt/reference/interfaces/pix-btg/delete-an-immediate-charge"},{"title":"List Dynamic Charges with Due Date","deprecated":null,"version":null,"sidebarTitle":"List dynamic charges with due date","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/collections/duedate","href":"/pt/reference/interfaces/pix-btg/list-dynamic-charges-with-due-date"},{"title":"List Immediate Charges","deprecated":null,"version":null,"sidebarTitle":"List immediate charges","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/collections/immediate","href":"/pt/reference/interfaces/pix-btg/list-immediate-charges"},{"title":"Retrieve Dynamic Charge with Due Date Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve dynamic charge with due date details","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/collections/duedate/{collection_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-dynamic-charge-with-due-date-details"},{"title":"Retrieve Immediate Charge Details","deprecated":null,"version":null,"sidebarTitle":"Retrieve immediate charge details","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/collections/immediate/{collection_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-immediate-charge-details"},{"title":"Update a Dynamic Charge with Due Date","deprecated":null,"version":null,"sidebarTitle":"Update a dynamic charge with due date","openapi":"/pt/openapi/v3-current/indirect-pix.yaml patch /v1/collections/duedate/{collection_id}","href":"/pt/reference/interfaces/pix-btg/update-a-dynamic-charge-with-due-date"},{"title":"Update an Immediate Charge","deprecated":null,"version":null,"sidebarTitle":"Update an immediate charge","openapi":"/pt/openapi/v3-current/indirect-pix.yaml put /v1/collections/immediate/{collection_id}","href":"/pt/reference/interfaces/pix-btg/update-an-immediate-charge"},{"title":"Complete a Charge","deprecated":null,"version":null,"sidebarTitle":"Complete a charge","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/admin/collections/{collection_id}/complete","href":"/pt/reference/interfaces/pix-btg/complete-a-charge"}]},{"group":"API de Recuperação de Fundos","pages":[{"title":"Cancel a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Cancel a funds recovery request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries/{funds_recovery_id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-a-funds-recovery-request"},{"title":"Create a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Create a funds recovery request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries","href":"/pt/reference/interfaces/pix-btg/create-a-funds-recovery-request"},{"title":"List Funds Recoveries","deprecated":null,"version":null,"sidebarTitle":"List funds recoveries","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries","href":"/pt/reference/interfaces/pix-btg/list-funds-recoveries"},{"title":"List Infraction Reports","deprecated":null,"version":null,"sidebarTitle":"List funds recovery infraction reports","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/infraction-reports","href":"/pt/reference/interfaces/pix-btg/list-funds-recovery-infraction-reports"},{"title":"List Refunds","deprecated":null,"version":null,"sidebarTitle":"List funds recovery refunds","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/refunds","href":"/pt/reference/interfaces/pix-btg/list-funds-recovery-refunds"},{"title":"Request Refund","deprecated":null,"version":null,"sidebarTitle":"Request funds recovery refund","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/funds-recoveries/{funds_recovery_id}/refund","href":"/pt/reference/interfaces/pix-btg/request-funds-recovery-refund"},{"title":"Retrieve Funds Recovery details","deprecated":null,"version":null,"sidebarTitle":"Retrieve funds recovery details","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}","href":"/pt/reference/interfaces/pix-btg/retrieve-funds-recovery-details"},{"title":"Retrieve Tracking Graph","deprecated":null,"version":null,"sidebarTitle":"Retrieve funds recovery tracking graph","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/funds-recoveries/{funds_recovery_id}/tracking-graph","href":"/pt/reference/interfaces/pix-btg/retrieve-funds-recovery-tracking-graph"},{"title":"Update a Funds Recovery Request","deprecated":null,"version":null,"sidebarTitle":"Update a funds recovery request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml patch /v1/dict/funds-recoveries/{funds_recovery_id}","href":"/pt/reference/interfaces/pix-btg/update-a-funds-recovery-request"}]},{"group":"API de Conciliação","pages":[{"title":"List All Reconciliation Jobs","deprecated":null,"version":null,"sidebarTitle":"List all reconciliation jobs","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/reconciliation","href":"/pt/reference/interfaces/pix-btg/list-all-reconciliation-jobs"},{"title":"List All VSync States","deprecated":null,"version":null,"sidebarTitle":"List all vsync states","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/dict/vsync","href":"/pt/reference/interfaces/pix-btg/list-all-vsync-states"},{"title":"Start Full Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Start full reconciliation","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/dict/reconciliation/full","href":"/pt/reference/interfaces/pix-btg/start-full-reconciliation"}]},{"group":"API de Pix Automático","pages":[{"title":"List Pix Automático Authorization Requests","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorization requests","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorization-requests","href":"/pt/reference/interfaces/pix-btg/list-pix-automatico-authorization-requests"},{"title":"Get a Pix Automático Authorization Request","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico authorization request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorization-requests/{id}","href":"/pt/reference/interfaces/pix-btg/get-a-pix-automatico-authorization-request"},{"title":"Decide on a Pix Automático Authorization Request","deprecated":null,"version":null,"sidebarTitle":"Decide on a pix automatico authorization request","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/authorization-requests/{id}/decision","href":"/pt/reference/interfaces/pix-btg/decide-on-a-pix-automatico-authorization-request"},{"title":"List Pix Automático Authorizations","deprecated":null,"version":null,"sidebarTitle":"List pix automatico authorizations","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations","href":"/pt/reference/interfaces/pix-btg/list-pix-automatico-authorizations"},{"title":"List Pix Automático Charges by Authorization","deprecated":null,"version":null,"sidebarTitle":"List pix automatico charges by authorization","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations/{authorizationId}/charges","href":"/pt/reference/interfaces/pix-btg/list-pix-automatico-charges-by-authorization"},{"title":"Get a Pix Automático Authorization","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico authorization","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/authorizations/{id}","href":"/pt/reference/interfaces/pix-btg/get-a-pix-automatico-authorization"},{"title":"Cancel a Pix Automático Authorization","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix automatico authorization","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/authorizations/{id}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-a-pix-automatico-authorization"},{"title":"Get a Pix Automático Charge","deprecated":null,"version":null,"sidebarTitle":"Get a pix automatico charge","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/recurrences/payer/charges/{id}","href":"/pt/reference/interfaces/pix-btg/get-a-pix-automatico-charge"},{"title":"Confirm a scanned Pix Automático recurrence","deprecated":null,"version":null,"sidebarTitle":"Confirm a scanned pix automatico recurrence","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/qr/confirm","href":"/pt/reference/interfaces/pix-btg/confirm-a-scanned-pix-automatico-recurrence"},{"title":"Pay and confirm a scanned Pix Automático recurrence (J3)","deprecated":null,"version":null,"sidebarTitle":"Pay and confirm a scanned pix automatico recurrence","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/recurrences/payer/qr/pay-and-confirm","href":"/pt/reference/interfaces/pix-btg/pay-and-confirm-a-scanned-pix-automatico-recurrence"}]},{"group":"API de Agendamentos","pages":[{"title":"List Pix Schedules","deprecated":null,"version":null,"sidebarTitle":"List pix schedules","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/schedules","href":"/pt/reference/interfaces/pix-btg/list-pix-schedules"},{"title":"Create a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Create a pix schedule","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/schedules","href":"/pt/reference/interfaces/pix-btg/create-a-pix-schedule"},{"title":"Get a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Get a pix schedule","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/schedules/{schedule_id}","href":"/pt/reference/interfaces/pix-btg/get-a-pix-schedule"},{"title":"Cancel a Pix Schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a pix schedule","openapi":"/pt/openapi/v3-current/indirect-pix.yaml delete /v1/schedules/{schedule_id}","href":"/pt/reference/interfaces/pix-btg/cancel-a-pix-schedule"}]},{"group":"API de Relatórios de Transação","pages":[{"title":"List Transaction Reports","deprecated":null,"version":null,"sidebarTitle":"List transaction reports","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/transaction-reports","href":"/pt/reference/interfaces/pix-btg/list-transaction-reports"},{"title":"Submit a Transaction Report","deprecated":null,"version":null,"sidebarTitle":"Submit a transaction report","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/transaction-reports/{id}/submit","href":"/pt/reference/interfaces/pix-btg/submit-a-transaction-report"}]},{"group":"Tempos de transações","pages":[{"title":"Trigger the asynchronous TemposTransacoes computation","deprecated":null,"version":null,"sidebarTitle":"Create transaction times job","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/statistics/tempos-transacoes/jobs","href":"/pt/reference/interfaces/pix-btg/create-transaction-times-job"},{"title":"List TemposTransacoes report job executions","deprecated":null,"version":null,"sidebarTitle":"List transaction times jobs","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/statistics/tempos-transacoes/jobs","href":"/pt/reference/interfaces/pix-btg/list-transaction-times-jobs"},{"title":"Get the TemposTransacoes job of a reference month","deprecated":null,"version":null,"sidebarTitle":"Get transaction times job","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/statistics/tempos-transacoes/jobs/{referenceMonth}","href":"/pt/reference/interfaces/pix-btg/get-transaction-times-job"},{"title":"Cancel a stuck or long-running TemposTransacoes job","deprecated":null,"version":null,"sidebarTitle":"Cancel transaction times job","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/statistics/tempos-transacoes/jobs/{referenceMonth}/cancel","href":"/pt/reference/interfaces/pix-btg/cancel-transaction-times-job"}]},{"group":"API de Webhooks","pages":[{"title":"List inbound webhooks","deprecated":null,"version":null,"sidebarTitle":"List inbound webhooks","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/inbound","href":"/pt/reference/interfaces/pix-btg/list-inbound-webhooks"},{"title":"Get inbound webhook by id","deprecated":null,"version":null,"sidebarTitle":"Get an inbound webhook","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/inbound/{id}","href":"/pt/reference/interfaces/pix-btg/get-an-inbound-webhook"},{"title":"Retry inbound webhook","deprecated":null,"version":null,"sidebarTitle":"Retry an inbound webhook","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/webhooks/inbound/{id}/retry","href":"/pt/reference/interfaces/pix-btg/retry-an-inbound-webhook"},{"title":"List outbound webhooks","deprecated":null,"version":null,"sidebarTitle":"List outbound webhooks","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/outbound","href":"/pt/reference/interfaces/pix-btg/list-outbound-webhooks"},{"title":"Get outbound webhook by id","deprecated":null,"version":null,"sidebarTitle":"Get an outbound webhook","openapi":"/pt/openapi/v3-current/indirect-pix.yaml get /v1/webhooks/outbound/{id}","href":"/pt/reference/interfaces/pix-btg/get-an-outbound-webhook"},{"title":"Retry outbound webhook","deprecated":null,"version":null,"sidebarTitle":"Retry an outbound webhook","openapi":"/pt/openapi/v3-current/indirect-pix.yaml post /v1/webhooks/outbound/{id}/retry","href":"/pt/reference/interfaces/pix-btg/retry-an-outbound-webhook"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Pix Indireto","href":"/pt/reference/interfaces/pix-btg/indirect-pix-error-list"}]}]},{"dropdown":"TED Lerian","icon":"building-columns","description":"Operações TED com conexão direta ao STR","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API do TED Lerian","sidebarTitle":"Visão geral","href":"/pt/reference/interfaces/ted-lerian/ted-lerian-api-overview"}]},{"group":"API de Transferências","pages":[{"title":"List outgoing/internal transfers (cursor pagination)","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/transfers","href":"/pt/reference/interfaces/ted-lerian/list-transfers"},{"title":"Send a TED (or internal transfer)","deprecated":null,"version":null,"sidebarTitle":"Send a ted","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/transfers","href":"/pt/reference/interfaces/ted-lerian/send-a-ted"},{"title":"Quote the fee and total of a TED with no financial effect","deprecated":null,"version":null,"sidebarTitle":"Quote a transfer fee","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/transfers/fee-quotes","href":"/pt/reference/interfaces/ted-lerian/quote-a-transfer-fee"},{"title":"Get a transfer","deprecated":null,"version":null,"sidebarTitle":"Get a transfer","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/transfers/{transferId}","href":"/pt/reference/interfaces/ted-lerian/get-a-transfer"},{"title":"Cancel a transfer (before sending) or a pending entry in the STR","deprecated":null,"version":null,"sidebarTitle":"Cancel a transfer","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/transfers/{transferId}/cancel","href":"/pt/reference/interfaces/ted-lerian/cancel-a-transfer"},{"title":"Timeline of the transfer transitions","deprecated":null,"version":null,"sidebarTitle":"Get a transfer timeline","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/transfers/{transferId}/timeline","href":"/pt/reference/interfaces/ted-lerian/get-a-transfer-timeline"}]},{"group":"API de TEDs recebidas","pages":[{"title":"List incoming TEDs (cursor pagination)","deprecated":null,"version":null,"sidebarTitle":"List incoming teds","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/incoming-transfers","href":"/pt/reference/interfaces/ted-lerian/list-incoming-teds"},{"title":"Get incoming TED","deprecated":null,"version":null,"sidebarTitle":"Get an incoming ted","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/incoming-transfers/{incomingTransferId}","href":"/pt/reference/interfaces/ted-lerian/get-an-incoming-ted"},{"title":"Resolve manual review of an incoming TED (operator)","deprecated":null,"version":null,"sidebarTitle":"Resolve an incoming ted review","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/incoming-transfers/{incomingTransferId}/resolve-review","href":"/pt/reference/interfaces/ted-lerian/resolve-an-incoming-ted-review"},{"title":"Request a full return of an incoming TED (operator)","deprecated":null,"version":null,"sidebarTitle":"Return an incoming ted","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/incoming-transfers/{incomingTransferId}/return","href":"/pt/reference/interfaces/ted-lerian/return-an-incoming-ted"},{"title":"Timeline of the incoming TED transitions","deprecated":null,"version":null,"sidebarTitle":"Get an incoming ted timeline","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/incoming-transfers/{incomingTransferId}/timeline","href":"/pt/reference/interfaces/ted-lerian/get-an-incoming-ted-timeline"}]},{"group":"API de Conciliação","pages":[{"title":"List held returns with no settled original TED (operator)","deprecated":null,"version":null,"sidebarTitle":"List held returns","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/reconciliation/held-returns","href":"/pt/reference/interfaces/ted-lerian/list-held-returns"},{"title":"Close a held return with ledger evidence (operator)","deprecated":null,"version":null,"sidebarTitle":"Close a held return","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/reconciliation/held-returns/{heldReturnId}/close","href":"/pt/reference/interfaces/ted-lerian/close-a-held-return"},{"title":"Inconsistency findings between ledger and rail (open or resolved), with a count per check","deprecated":null,"version":null,"sidebarTitle":"List inconsistency findings","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/reconciliation/inconsistencies","href":"/pt/reference/interfaces/ted-lerian/list-inconsistency-findings"},{"title":"Operations queue (pending in the STR, awaiting reconciliation, exhausted, manual review)","deprecated":null,"version":null,"sidebarTitle":"List the operations queue","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/reconciliation/queue","href":"/pt/reference/interfaces/ted-lerian/list-the-operations-queue"},{"title":"List pending rail fact reviews (operator)","deprecated":null,"version":null,"sidebarTitle":"List rail fact reviews","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/reconciliation/reviews","href":"/pt/reference/interfaces/ted-lerian/list-rail-fact-reviews"},{"title":"Resolve a review of a rail fact (operator)","deprecated":null,"version":null,"sidebarTitle":"Resolve a rail fact review","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/reconciliation/reviews/{reviewId}/resolve","href":"/pt/reference/interfaces/ted-lerian/resolve-a-rail-fact-review"},{"title":"Trigger an on-demand reconciliation run","deprecated":null,"version":null,"sidebarTitle":"Start a reconciliation run","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/reconciliation/runs","href":"/pt/reference/interfaces/ted-lerian/start-a-reconciliation-run"},{"title":"Unblock a transfer in reconciliation with STR evidence (operator)","deprecated":null,"version":null,"sidebarTitle":"Unblock a transfer","openapi":"/pt/openapi/v3-current/ted-lerian.yaml post /v1/transfers/{transferId}/unblock","href":"/pt/reference/interfaces/ted-lerian/unblock-a-transfer"}]},{"group":"API de Operações","pages":[{"title":"Closing balance reported by the STR and items pending at closing","deprecated":null,"version":null,"sidebarTitle":"Get the closing balance","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/operations/closing-balance","href":"/pt/reference/interfaces/ted-lerian/get-the-closing-balance"},{"title":"Regulatory deadlines (30/60/60 min): distribution and items at risk","deprecated":null,"version":null,"sidebarTitle":"Get the sla report","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/operations/sla","href":"/pt/reference/interfaces/ted-lerian/get-the-sla-report"},{"title":"Totals for the day (volumes, amounts, statuses, window)","deprecated":null,"version":null,"sidebarTitle":"Get the daily summary","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/operations/summary","href":"/pt/reference/interfaces/ted-lerian/get-the-daily-summary"}]},{"group":"API de Políticas","pages":[{"title":"Replace the holidays of a year (editor; audited)","deprecated":null,"version":null,"sidebarTitle":"Replace the holidays of a year","openapi":"/pt/openapi/v3-current/ted-lerian.yaml put /v1/policy/holidays","href":"/pt/reference/interfaces/ted-lerian/replace-the-holidays-of-a-year"},{"title":"ISPB → organization/ledger bindings of the institution","deprecated":null,"version":null,"sidebarTitle":"List ispb bindings","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/policy/ispb-bindings","href":"/pt/reference/interfaces/ted-lerian/list-ispb-bindings"},{"title":"Replace ISPB → organization bindings (editor; audited)","deprecated":null,"version":null,"sidebarTitle":"Replace ispb bindings","openapi":"/pt/openapi/v3-current/ted-lerian.yaml put /v1/policy/ispb-bindings","href":"/pt/reference/interfaces/ted-lerian/replace-ispb-bindings"},{"title":"Get the institution's usage limits","deprecated":null,"version":null,"sidebarTitle":"Get usage limits","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/policy/limits","href":"/pt/reference/interfaces/ted-lerian/get-usage-limits"},{"title":"Set usage limits (editor; audited)","deprecated":null,"version":null,"sidebarTitle":"Set usage limits","openapi":"/pt/openapi/v3-current/ted-lerian.yaml put /v1/policy/limits","href":"/pt/reference/interfaces/ted-lerian/set-usage-limits"},{"title":"Get the effective window (official schedule ⊕ cut-off ⊕ calendar) and the configured cut-off","deprecated":null,"version":null,"sidebarTitle":"Get the operating window","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/policy/window","href":"/pt/reference/interfaces/ted-lerian/get-the-operating-window"},{"title":"Set the institution's cut-off (always equal to or more conservative than the official schedule)","deprecated":null,"version":null,"sidebarTitle":"Set the cut off","openapi":"/pt/openapi/v3-current/ted-lerian.yaml put /v1/policy/window","href":"/pt/reference/interfaces/ted-lerian/set-the-cut-off"}]},{"group":"API de Participantes","pages":[{"title":"STR participant list (COMPE ↔ ISPB resolution)","deprecated":null,"version":null,"sidebarTitle":"List str participants","openapi":"/pt/openapi/v3-current/ted-lerian.yaml get /v1/participants","href":"/pt/reference/interfaces/ted-lerian/list-str-participants"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do TED Lerian","sidebarTitle":"Lista de erros","href":"/pt/reference/interfaces/ted-lerian/ted-lerian-error-list"}]}]},{"dropdown":"TED JD","icon":"building-columns","description":"Operações TED pela interface JD","groups":[{"group":"API de Transferências","pages":[{"title":"Initiate a Transfer","deprecated":null,"version":null,"sidebarTitle":"Initiate transfer","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/initiate","href":"/pt/reference/interfaces/ted-jd/initiate-transfer"},{"title":"Prepare Transfer Signing Payload","deprecated":null,"version":null,"sidebarTitle":"Prepare transfer signing","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/signing/prepare","href":"/pt/reference/interfaces/ted-jd/prepare-transfer-signing"},{"title":"Process a Transfer","deprecated":null,"version":null,"sidebarTitle":"Process transfer","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/process","href":"/pt/reference/interfaces/ted-jd/process-transfer"},{"title":"Get a Transfer","deprecated":null,"version":null,"sidebarTitle":"Retrieve transfer","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/{transferId}","href":"/pt/reference/interfaces/ted-jd/retrieve-transfer"},{"title":"List Transfers","deprecated":null,"version":null,"sidebarTitle":"List transfers","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers","href":"/pt/reference/interfaces/ted-jd/list-transfers"},{"title":"Cancel a Transfer","deprecated":null,"version":null,"sidebarTitle":"Cancel transfer","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/cancel","href":"/pt/reference/interfaces/ted-jd/cancel-transfer"}]},{"group":"Painel e API de Conciliação","pages":[{"title":"Get dashboard summary","deprecated":null,"version":null,"sidebarTitle":"Get dashboard summary","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/dashboard/summary","href":"/pt/reference/interfaces/ted-jd/get-dashboard-summary"},{"title":"List pending reconciliation transfers","deprecated":null,"version":null,"sidebarTitle":"List pending reconciliation","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/reconciliation/pending","href":"/pt/reference/interfaces/ted-jd/list-pending-reconciliation"},{"title":"List unresolved TED IN reconciliation gaps","deprecated":null,"version":null,"sidebarTitle":"List ted in reconciliation gaps","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/reconciliation-gaps","href":"/pt/reference/interfaces/ted-jd/list-ted-in-reconciliation-gaps"},{"title":"Trigger reconciliation sweep","deprecated":null,"version":null,"sidebarTitle":"Trigger reconciliation sweep","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/reconciliation/tick","href":"/pt/reference/interfaces/ted-jd/trigger-reconciliation-sweep"},{"title":"Retry Transfer Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Retry transfer reconciliation","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/reconciliation/retry","href":"/pt/reference/interfaces/ted-jd/retry-transfer-reconciliation"},{"title":"Resolve Transfer Reconciliation","deprecated":null,"version":null,"sidebarTitle":"Resolve transfer reconciliation","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/reconciliation/resolve","href":"/pt/reference/interfaces/ted-jd/resolve-transfer-reconciliation"},{"title":"Repair Transfer Ledger Scope","deprecated":null,"version":null,"sidebarTitle":"Repair transfer ledger scope","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/{transferId}/scope/repair","href":"/pt/reference/interfaces/ted-jd/repair-transfer-ledger-scope"},{"title":"Check Ledger Routing Readiness","deprecated":null,"version":null,"sidebarTitle":"Check ledger routing readiness","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/routing/preflight","href":"/pt/reference/interfaces/ted-jd/check-ledger-routing-readiness"}]},{"group":"API de Operações TED In","pages":[{"title":"Trigger TED IN Poller","deprecated":null,"version":null,"sidebarTitle":"Trigger ted in poll","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/poll","href":"/pt/reference/interfaces/ted-jd/trigger-ted-in-poll"},{"title":"Replay TED IN Backlog","deprecated":null,"version":null,"sidebarTitle":"Replay ted in poll","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/replay","href":"/pt/reference/interfaces/ted-jd/replay-ted-in-poll"},{"title":"Resume TED IN Poller","deprecated":null,"version":null,"sidebarTitle":"Resume ted in poller","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/resume","href":"/pt/reference/interfaces/ted-jd/resume-ted-in-poller"},{"title":"Get TED IN Poller Status","deprecated":null,"version":null,"sidebarTitle":"Get ted in poller status","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/poller","href":"/pt/reference/interfaces/ted-jd/get-ted-in-poller-status"},{"title":"List Retained TED IN Messages","deprecated":null,"version":null,"sidebarTitle":"List retained ted in messages","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/retained","href":"/pt/reference/interfaces/ted-jd/list-retained-ted-in-messages"},{"title":"List Undeliverable TED IN Credits","deprecated":null,"version":null,"sidebarTitle":"List undeliverable ted in credits","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/transfers/ted-in/undeliverables","href":"/pt/reference/interfaces/ted-jd/list-undeliverable-ted-in-credits"},{"title":"Close Unsettled TED IN Credit","deprecated":null,"version":null,"sidebarTitle":"Close unsettled ted in credit","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/unsettled/{messageId}/close","href":"/pt/reference/interfaces/ted-jd/close-unsettled-ted-in-credit"}]},{"group":"API de Webhooks","pages":[{"title":"Create a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/webhooks","href":"/pt/reference/interfaces/ted-jd/create-webhook"},{"title":"List Webhook Registrations","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/webhooks","href":"/pt/reference/interfaces/ted-jd/list-webhooks"},{"title":"Get a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Get webhook","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/webhooks/{webhookId}","href":"/pt/reference/interfaces/ted-jd/get-webhook"},{"title":"Patch a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/pt/openapi/v3-current/ted.yaml patch /v1/webhooks/{webhookId}","href":"/pt/reference/interfaces/ted-jd/update-webhook"},{"title":"Delete a Webhook Registration","deprecated":null,"version":null,"sidebarTitle":"Delete webhook","openapi":"/pt/openapi/v3-current/ted.yaml delete /v1/webhooks/{webhookId}","href":"/pt/reference/interfaces/ted-jd/delete-webhook"},{"title":"Rotate a Webhook Signing Secret","deprecated":null,"version":null,"sidebarTitle":"Rotate webhook signing secret","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/webhooks/{webhookId}/signing-secret/rotate","href":"/pt/reference/interfaces/ted-jd/rotate-webhook-signing-secret"},{"title":"List Webhook Event Types","deprecated":null,"version":null,"sidebarTitle":"List webhook event types","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/webhooks/event-types","href":"/pt/reference/interfaces/ted-jd/list-webhook-event-types"}]},{"group":"API de Webhook DLQ","pages":[{"title":"List DLQ Messages","deprecated":null,"version":null,"sidebarTitle":"List webhook dlq messages","openapi":"/pt/openapi/v3-current/ted.yaml get /v1/webhooks/dlq","href":"/pt/reference/interfaces/ted-jd/list-webhook-dlq-messages"},{"title":"Retry DLQ Message","deprecated":null,"version":null,"sidebarTitle":"Retry webhook dlq message","openapi":"/pt/openapi/v3-current/ted.yaml post /v1/webhooks/dlq/{messageId}/retry","href":"/pt/reference/interfaces/ted-jd/retry-webhook-dlq-message"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Bank Transfer","href":"/pt/reference/interfaces/ted-jd/ted-error-list"}]}]},{"dropdown":"Payments BTG","icon":"barcode","description":"Pagamentos de boleto pela interface BTG","groups":[{"group":"API de Boletos","pages":[{"title":"Issue a single boleto","deprecated":null,"version":null,"sidebarTitle":"Issue boleto","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/boletos","href":"/pt/reference/interfaces/payments-btg/issue-boleto"},{"title":"Issue installment boletos","deprecated":null,"version":null,"sidebarTitle":"Issue installment boletos","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/boletos/installments","href":"/pt/reference/interfaces/payments-btg/issue-installment-boletos"},{"title":"List boletos","deprecated":null,"version":null,"sidebarTitle":"List boletos","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/boletos","href":"/pt/reference/interfaces/payments-btg/list-boletos"},{"title":"Get boleto by ID","deprecated":null,"version":null,"sidebarTitle":"Get boleto","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/boletos/{id}","href":"/pt/reference/interfaces/payments-btg/get-boleto"},{"title":"Get installment series","deprecated":null,"version":null,"sidebarTitle":"Get installment series","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/boletos/installments/{series_id}","href":"/pt/reference/interfaces/payments-btg/get-installment-series"},{"title":"Download boleto PDF","deprecated":null,"version":null,"sidebarTitle":"Download boleto pdf","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/boletos/{id}/pdf","href":"/pt/reference/interfaces/payments-btg/download-boleto-pdf"},{"title":"Cancel an issued boleto","deprecated":null,"version":null,"sidebarTitle":"Cancel boleto","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/boletos/{id}/cancel","href":"/pt/reference/interfaces/payments-btg/cancel-boleto"}]},{"group":"API de Pagamentos","pages":[{"title":"Initiate a payment","deprecated":null,"version":null,"sidebarTitle":"Initiate payment","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/payments","href":"/pt/reference/interfaces/payments-btg/initiate-payment"},{"title":"Initiate a DARF payment","deprecated":null,"version":null,"sidebarTitle":"Initiate darf payment","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/payments/darf","href":"/pt/reference/interfaces/payments-btg/initiate-darf-payment"},{"title":"Consult a bill by digitable line","deprecated":null,"version":null,"sidebarTitle":"Consult a bill by digitable line","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/payments/consult","href":"/pt/reference/interfaces/payments-btg/consult-a-bill-by-digitable-line"},{"title":"List payments","deprecated":null,"version":null,"sidebarTitle":"List payments","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/payments","href":"/pt/reference/interfaces/payments-btg/list-payments"},{"title":"Get payment by ID","deprecated":null,"version":null,"sidebarTitle":"Get payment","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/payments/{id}","href":"/pt/reference/interfaces/payments-btg/get-payment"},{"title":"Cancel a payment","deprecated":null,"version":null,"sidebarTitle":"Cancel payment","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/payments/{id}/cancel","href":"/pt/reference/interfaces/payments-btg/cancel-payment"}]},{"group":"API de Dashboards","pages":[{"title":"Get boleto dashboard","deprecated":null,"version":null,"sidebarTitle":"Get boleto dashboard","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/dashboards/boletos","href":"/pt/reference/interfaces/payments-btg/get-boleto-dashboard"},{"title":"Get payment dashboard","deprecated":null,"version":null,"sidebarTitle":"Get payment dashboard","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/dashboards/payments","href":"/pt/reference/interfaces/payments-btg/get-payment-dashboard"}]},{"group":"API de Administração","pages":[{"title":"Connect provider with the tenant's client credentials","deprecated":null,"version":null,"sidebarTitle":"Connect provider","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/admin/providers/connect","href":"/pt/reference/interfaces/payments-btg/connect-provider"},{"title":"Re-register the tenant's existing webhook subscription at a provider","deprecated":null,"version":null,"sidebarTitle":"Resubscribe provider webhook","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/admin/providers/webhooks/{provider_type}/resubscribe","href":"/pt/reference/interfaces/payments-btg/resubscribe-provider-webhook"},{"title":"Get webhook configuration","deprecated":null,"version":null,"sidebarTitle":"Get webhook configuration","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/admin/webhooks","href":"/pt/reference/interfaces/payments-btg/get-webhook-configuration"},{"title":"Configure outbound webhook","deprecated":null,"version":null,"sidebarTitle":"Configure webhook","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/admin/webhooks","href":"/pt/reference/interfaces/payments-btg/configure-webhook"},{"title":"Preflight the accounting routes of a ledger","deprecated":null,"version":null,"sidebarTitle":"Preflight accounting routes","openapi":"/pt/openapi/v3-current/payments.yaml get /v1/admin/accounting-routes/preflight","href":"/pt/reference/interfaces/payments-btg/preflight-accounting-routes"},{"title":"Re-present a quarantined provider webhook","deprecated":null,"version":null,"sidebarTitle":"Represent quarantined webhook","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/admin/quarantine/webhooks/{id}/represent","href":"/pt/reference/interfaces/payments-btg/represent-quarantined-webhook"}]},{"group":"API de Webhooks","pages":[{"title":"Receive a provider webhook","deprecated":null,"version":null,"sidebarTitle":"Receive provider webhook","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/webhooks/btg","href":"/pt/reference/interfaces/payments-btg/receive-provider-webhook"},{"title":"Receive a provider webhook on a tenant connection","deprecated":null,"version":null,"sidebarTitle":"Receive provider webhook by connection","openapi":"/pt/openapi/v3-current/payments.yaml post /v1/webhooks/btg/{connection_token}","href":"/pt/reference/interfaces/payments-btg/receive-provider-webhook-by-connection"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Payments","href":"/pt/reference/interfaces/payments-btg/payments-error-list"}]}]}]},{"anchor":"Plataforma","icon":"layer-group","dropdowns":[{"dropdown":"Access Manager","icon":"https://mintlify.s3.us-west-1.amazonaws.com/lerian-49cb71fc/images/icons/access-manager-yellow.png","description":"Autenticação, autorização e identidade","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API do Access Manager","href":"/pt/reference/platform/access-manager/am-api-introduction"}]},{"group":"Autenticação","pages":[{"title":"Auth APIs","sidebarTitle":"Visão geral","href":"/pt/reference/platform/access-manager/am-auth-apis"},{"title":"Request an access token","deprecated":null,"version":null,"sidebarTitle":"Request access token","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/login/oauth/access_token","href":"/pt/reference/platform/access-manager/request-access-token"},{"title":"Exchange a refresh token for an access token","deprecated":null,"version":null,"sidebarTitle":"Refresh token","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/login/oauth/refresh_token","href":"/pt/reference/platform/access-manager/refresh-token"},{"title":"Log out","deprecated":null,"version":null,"sidebarTitle":"End user session","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/logout","href":"/pt/reference/platform/access-manager/end-user-session"}]},{"group":"Login único","pages":[{"title":"Discover how an email signs in","deprecated":null,"version":null,"sidebarTitle":"Discover how an email signs in","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/sso/discover","href":"/pt/reference/platform/access-manager/discover-how-an-email-signs-in"},{"title":"Start an SSO login","deprecated":null,"version":null,"sidebarTitle":"Start an sso login","openapi":"/pt/openapi/v3-current/AM-auth.yaml get /v1/sso/start","href":"/pt/reference/platform/access-manager/start-an-sso-login"}]},{"group":"Autorização","pages":[{"title":"Enforce a user permission","deprecated":null,"version":null,"sidebarTitle":"Validate user permission","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/authorize","href":"/pt/reference/platform/access-manager/validate-user-permission"}]},{"group":"Informações do usuário","pages":[{"title":"Get OIDC user info","deprecated":null,"version":null,"sidebarTitle":"Retrieve user information","openapi":"/pt/openapi/v3-current/AM-auth.yaml get /v1/userinfo","href":"/pt/reference/platform/access-manager/retrieve-user-information"},{"title":"List the caller's permissions","deprecated":null,"version":null,"sidebarTitle":"Retrieve user permissions","openapi":"/pt/openapi/v3-current/AM-auth.yaml get /v1/permissions","href":"/pt/reference/platform/access-manager/retrieve-user-permissions"}]},{"group":"MFA de login","pages":[{"title":"Initiate an MFA challenge","deprecated":null,"version":null,"sidebarTitle":"Initiate mfa challenge","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/login/mfa/challenge","href":"/pt/reference/platform/access-manager/initiate-mfa-challenge"},{"title":"Verify an MFA challenge","deprecated":null,"version":null,"sidebarTitle":"Verify mfa login","openapi":"/pt/openapi/v3-current/AM-auth.yaml post /v1/login/mfa/verify","href":"/pt/reference/platform/access-manager/verify-mfa-login"}]},{"group":"Visão geral de identidade","pages":[{"title":"Identity APIs","sidebarTitle":"Visão geral","href":"/pt/reference/platform/access-manager/am-identity-apis"}]},{"group":"Grupos","pages":[{"title":"List Groups","deprecated":null,"version":null,"sidebarTitle":"List groups","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/groups","href":"/pt/reference/platform/access-manager/list-groups"},{"title":"Create a Group","deprecated":null,"version":null,"sidebarTitle":"Create a group","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/groups","href":"/pt/reference/platform/access-manager/create-a-group"},{"title":"Retrieve Group details","deprecated":null,"version":null,"sidebarTitle":"Retrieve group details","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/groups/{id}","href":"/pt/reference/platform/access-manager/retrieve-group-details"},{"title":"Update a Group","deprecated":null,"version":null,"sidebarTitle":"Update a group","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/groups/{id}","href":"/pt/reference/platform/access-manager/update-a-group"},{"title":"Delete a Group","deprecated":null,"version":null,"sidebarTitle":"Delete a group","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/groups/{id}","href":"/pt/reference/platform/access-manager/delete-a-group"},{"title":"Add Members to a Group","deprecated":null,"version":null,"sidebarTitle":"Assigns users to a group","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/groups/{id}/users","href":"/pt/reference/platform/access-manager/assigns-users-to-a-group"},{"title":"Remove Members from a Group in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple users from a group batch","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/groups/{id}/users/remove","href":"/pt/reference/platform/access-manager/removes-multiple-users-from-a-group-batch"},{"title":"Remove one Member from a Group","deprecated":null,"version":null,"sidebarTitle":"Removes a single user from a group","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/groups/{id}/users/{userId}","href":"/pt/reference/platform/access-manager/removes-a-single-user-from-a-group"}]},{"group":"Aplicações","pages":[{"title":"Create an Application","deprecated":null,"version":null,"sidebarTitle":"Create an application","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/applications","href":"/pt/reference/platform/access-manager/create-an-application"},{"title":"List Applications","deprecated":null,"version":null,"sidebarTitle":"List applications","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/applications","href":"/pt/reference/platform/access-manager/list-applications"},{"title":"List Available Applications","deprecated":null,"version":null,"sidebarTitle":"List available applications","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/applications/available","href":"/pt/reference/platform/access-manager/list-available-applications"},{"title":"Retrieve Application details","deprecated":null,"version":null,"sidebarTitle":"Retrieve application details","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/applications/{id}","href":"/pt/reference/platform/access-manager/retrieve-application-details"},{"title":"Delete an Application","deprecated":null,"version":null,"sidebarTitle":"Delete application","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/applications/{id}","href":"/pt/reference/platform/access-manager/delete-application"}]},{"group":"Parceiros","pages":[{"title":"List partners","deprecated":null,"version":null,"sidebarTitle":"List partners","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/partners","href":"/pt/reference/platform/access-manager/list-partners"},{"title":"Create a partner","deprecated":null,"version":null,"sidebarTitle":"Create a partner","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/partners","href":"/pt/reference/platform/access-manager/create-a-partner"},{"title":"Retrieve a partner","deprecated":null,"version":null,"sidebarTitle":"Retrieve a partner","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/partners/{id}","href":"/pt/reference/platform/access-manager/retrieve-a-partner"},{"title":"Update a partner","deprecated":null,"version":null,"sidebarTitle":"Update a partner","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/partners/{id}","href":"/pt/reference/platform/access-manager/update-a-partner"},{"title":"Delete a partner","deprecated":null,"version":null,"sidebarTitle":"Delete a partner","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/partners/{id}","href":"/pt/reference/platform/access-manager/delete-a-partner"},{"title":"Retrieve the partner ceiling of a product","deprecated":null,"version":null,"sidebarTitle":"Retrieve the partner ceiling of a product","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/partners/ceiling","href":"/pt/reference/platform/access-manager/retrieve-the-partner-ceiling-of-a-product"},{"title":"List scope catalogs","deprecated":null,"version":null,"sidebarTitle":"List scope catalogs","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/scope-catalog","href":"/pt/reference/platform/access-manager/list-scope-catalogs"},{"title":"Retrieve a product's scope catalog","deprecated":null,"version":null,"sidebarTitle":"Retrieve a product s scope catalog","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/scope-catalog/{product}","href":"/pt/reference/platform/access-manager/retrieve-a-product-s-scope-catalog"}]},{"group":"Usuários","pages":[{"title":"Create a user","deprecated":null,"version":null,"sidebarTitle":"Create user","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users","href":"/pt/reference/platform/access-manager/create-user"},{"title":"List Users","deprecated":null,"version":null,"sidebarTitle":"List users","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users","href":"/pt/reference/platform/access-manager/list-users"},{"title":"Retrieve User details","deprecated":null,"version":null,"sidebarTitle":"Retrieve user details","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}","href":"/pt/reference/platform/access-manager/retrieve-user-details"},{"title":"Update a user","deprecated":null,"version":null,"sidebarTitle":"Update user","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}","href":"/pt/reference/platform/access-manager/update-user"},{"title":"Delete a user","deprecated":null,"version":null,"sidebarTitle":"Delete user","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}","href":"/pt/reference/platform/access-manager/delete-user"},{"title":"List own tenants","deprecated":null,"version":null,"sidebarTitle":"List own tenants","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/tenants","href":"/pt/reference/platform/access-manager/list-own-tenants"},{"title":"Set own default tenant","deprecated":null,"version":null,"sidebarTitle":"Set own default tenant","openapi":"/pt/openapi/v3-current/AM-identity.yaml put /v1/users/{id}/tenants/default","href":"/pt/reference/platform/access-manager/set-own-default-tenant"},{"title":"Retrieve own user profile","deprecated":null,"version":null,"sidebarTitle":"Retrieve the caller s own profile","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/profile","href":"/pt/reference/platform/access-manager/retrieve-the-caller-s-own-profile"},{"title":"Get user effective permissions","deprecated":null,"version":null,"sidebarTitle":"Get effective permissions","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/effective-permissions","href":"/pt/reference/platform/access-manager/get-effective-permissions"},{"title":"Set own user phone number","deprecated":null,"version":null,"sidebarTitle":"Set the caller s phone number","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/phone","href":"/pt/reference/platform/access-manager/set-the-caller-s-phone-number"},{"title":"Remove user phone number","deprecated":null,"version":null,"sidebarTitle":"Remove an user s phone number","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/phone","href":"/pt/reference/platform/access-manager/remove-an-user-s-phone-number"},{"title":"Reset a user password","deprecated":null,"version":null,"sidebarTitle":"Reset user password","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/reset-password","href":"/pt/reference/platform/access-manager/reset-user-password"},{"title":"Update a user password","deprecated":null,"version":null,"sidebarTitle":"Update user password","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/update-password","href":"/pt/reference/platform/access-manager/update-user-password"},{"title":"Request a password reset code","deprecated":null,"version":null,"sidebarTitle":"Request a password reset code","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/forgot-password/send-code","href":"/pt/reference/platform/access-manager/request-a-password-reset-code"},{"title":"Reset a password with a verification code","deprecated":null,"version":null,"sidebarTitle":"Reset a password with a verification code","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/forgot-password/reset","href":"/pt/reference/platform/access-manager/reset-a-password-with-a-verification-code"},{"title":"List the Direct Permissions of a User","deprecated":null,"version":null,"sidebarTitle":"Returns the permissions assigned to a user","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/permissions","href":"/pt/reference/platform/access-manager/returns-the-permissions-assigned-to-a-user"},{"title":"Add Permissions to a User","deprecated":null,"version":null,"sidebarTitle":"Assigns permissions to a user","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/permissions","href":"/pt/reference/platform/access-manager/assigns-permissions-to-a-user"},{"title":"Remove Permissions from a User in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple permissions from a user batch","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/permissions/remove","href":"/pt/reference/platform/access-manager/removes-multiple-permissions-from-a-user-batch"},{"title":"Remove one Permission from a User","deprecated":null,"version":null,"sidebarTitle":"Removes a single permission from a user","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/permissions/{permId}","href":"/pt/reference/platform/access-manager/removes-a-single-permission-from-a-user"}]},{"group":"MFA da conta","pages":[{"title":"Initiate MFA Setup","deprecated":null,"version":null,"sidebarTitle":"Initiate mfa setup","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/setup","href":"/pt/reference/platform/access-manager/initiate-mfa-setup"},{"title":"Verify MFA Setup","deprecated":null,"version":null,"sidebarTitle":"Verify mfa passcode","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/verify","href":"/pt/reference/platform/access-manager/verify-mfa-passcode"},{"title":"Enable MFA","deprecated":null,"version":null,"sidebarTitle":"Enable mfa","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/enable","href":"/pt/reference/platform/access-manager/enable-mfa"},{"title":"Get MFA Status","deprecated":null,"version":null,"sidebarTitle":"Get mfa status","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/users/{id}/mfa","href":"/pt/reference/platform/access-manager/get-mfa-status"},{"title":"Request an MFA disable confirmation code","deprecated":null,"version":null,"sidebarTitle":"Request an mfa disable confirmation code","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/disable/challenge","href":"/pt/reference/platform/access-manager/request-an-mfa-disable-confirmation-code"},{"title":"Disable MFA","deprecated":null,"version":null,"sidebarTitle":"Disable mfa","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa","href":"/pt/reference/platform/access-manager/disable-mfa"},{"title":"Set Preferred MFA Method","deprecated":null,"version":null,"sidebarTitle":"Set preferred mfa method","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/users/{id}/mfa/preferred","href":"/pt/reference/platform/access-manager/set-preferred-mfa-method"},{"title":"Disable a single MFA channel","deprecated":null,"version":null,"sidebarTitle":"Disable a single mfa channel","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa/{mfaType}","href":"/pt/reference/platform/access-manager/disable-a-single-mfa-channel"},{"title":"Regenerate MFA Recovery Codes","deprecated":null,"version":null,"sidebarTitle":"Regenerate mfa recovery codes","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/recovery-codes","href":"/pt/reference/platform/access-manager/regenerate-mfa-recovery-codes"},{"title":"Admin Enable MFA","deprecated":null,"version":null,"sidebarTitle":"Admin enable mfa","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/users/{id}/mfa/admin/enable","href":"/pt/reference/platform/access-manager/admin-enable-mfa"},{"title":"Admin Disable MFA","deprecated":null,"version":null,"sidebarTitle":"Admin disable mfa","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/users/{id}/mfa/admin/{mfaType}","href":"/pt/reference/platform/access-manager/admin-disable-mfa"}]},{"group":"Provedores de identidade","pages":[{"title":"List Providers","deprecated":null,"version":null,"sidebarTitle":"List providers","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/providers","href":"/pt/reference/platform/access-manager/list-providers"},{"title":"Create a Provider","deprecated":null,"version":null,"sidebarTitle":"Create a provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/providers","href":"/pt/reference/platform/access-manager/create-a-provider"},{"title":"Retrieve Provider details","deprecated":null,"version":null,"sidebarTitle":"Retrieve a provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/providers/{id}","href":"/pt/reference/platform/access-manager/retrieve-a-provider"},{"title":"Update a Provider","deprecated":null,"version":null,"sidebarTitle":"Update a provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/providers/{id}","href":"/pt/reference/platform/access-manager/update-a-provider"},{"title":"Delete a Provider","deprecated":null,"version":null,"sidebarTitle":"Delete a provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/providers/{id}","href":"/pt/reference/platform/access-manager/delete-a-provider"},{"title":"Test send through a Provider","deprecated":null,"version":null,"sidebarTitle":"Test send through a provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/providers/{id}/test-send","href":"/pt/reference/platform/access-manager/test-send-through-a-provider"}]},{"group":"Provedores de aplicações","pages":[{"title":"List Application Providers","deprecated":null,"version":null,"sidebarTitle":"List application providers","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/applications/{id}/providers","href":"/pt/reference/platform/access-manager/list-application-providers"},{"title":"Link Provider to Application","deprecated":null,"version":null,"sidebarTitle":"Link provider to application","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/applications/{id}/providers","href":"/pt/reference/platform/access-manager/link-provider-to-application"},{"title":"Update Provider Link","deprecated":null,"version":null,"sidebarTitle":"Update application provider link","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/applications/{id}/providers/{providerId}","href":"/pt/reference/platform/access-manager/update-application-provider-link"},{"title":"Unlink Provider from Application","deprecated":null,"version":null,"sidebarTitle":"Unlink provider from application","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/applications/{id}/providers/{providerId}","href":"/pt/reference/platform/access-manager/unlink-provider-from-application"},{"title":"Set Provider as Default","deprecated":null,"version":null,"sidebarTitle":"Set default application provider","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/applications/{id}/providers/{providerId}/default","href":"/pt/reference/platform/access-manager/set-default-application-provider"}]},{"group":"Permissões","pages":[{"title":"List Permissions","deprecated":null,"version":null,"sidebarTitle":"List permissions","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/permissions","href":"/pt/reference/platform/access-manager/list-permissions"},{"title":"Retrieve Permission details","deprecated":null,"version":null,"sidebarTitle":"Retrieve permission details","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/permissions/{id}","href":"/pt/reference/platform/access-manager/retrieve-permission-details"}]},{"group":"Funções","pages":[{"title":"List Roles","deprecated":null,"version":null,"sidebarTitle":"List roles","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/roles","href":"/pt/reference/platform/access-manager/list-roles"},{"title":"Create a Role","deprecated":null,"version":null,"sidebarTitle":"Create a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles","href":"/pt/reference/platform/access-manager/create-a-role"},{"title":"Retrieve Role details","deprecated":null,"version":null,"sidebarTitle":"Retrieve role details","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/roles/{id}","href":"/pt/reference/platform/access-manager/retrieve-role-details"},{"title":"Update a Role","deprecated":null,"version":null,"sidebarTitle":"Update a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/roles/{id}","href":"/pt/reference/platform/access-manager/update-a-role"},{"title":"Delete a Role","deprecated":null,"version":null,"sidebarTitle":"Delete a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}","href":"/pt/reference/platform/access-manager/delete-a-role"},{"title":"Grant a Role to Groups","deprecated":null,"version":null,"sidebarTitle":"Assigns groups to a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/groups","href":"/pt/reference/platform/access-manager/assigns-groups-to-a-role"},{"title":"Revoke a Role from Groups in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple groups from a role batch","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/groups/remove","href":"/pt/reference/platform/access-manager/removes-multiple-groups-from-a-role-batch"},{"title":"Revoke a Role from one Group","deprecated":null,"version":null,"sidebarTitle":"Removes a single group from a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/groups/{groupId}","href":"/pt/reference/platform/access-manager/removes-a-single-group-from-a-role"},{"title":"List the Permissions of a Role","deprecated":null,"version":null,"sidebarTitle":"Returns the permissions assigned to a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/roles/{id}/permissions","href":"/pt/reference/platform/access-manager/returns-the-permissions-assigned-to-a-role"},{"title":"Add Permissions to a Role","deprecated":null,"version":null,"sidebarTitle":"Assigns permissions to a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/permissions","href":"/pt/reference/platform/access-manager/assigns-permissions-to-a-role"},{"title":"Remove Permissions from a Role in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple permissions from a role batch","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/permissions/remove","href":"/pt/reference/platform/access-manager/removes-multiple-permissions-from-a-role-batch"},{"title":"Remove one Permission from a Role","deprecated":null,"version":null,"sidebarTitle":"Removes a single permission from a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/permissions/{permId}","href":"/pt/reference/platform/access-manager/removes-a-single-permission-from-a-role"},{"title":"Grant a Role to Users","deprecated":null,"version":null,"sidebarTitle":"Assigns users to a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/users","href":"/pt/reference/platform/access-manager/assigns-users-to-a-role"},{"title":"Revoke a Role from Users in Batch","deprecated":null,"version":null,"sidebarTitle":"Removes multiple users from a role batch","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/roles/{id}/users/remove","href":"/pt/reference/platform/access-manager/removes-multiple-users-from-a-role-batch"},{"title":"Revoke a Role from one User","deprecated":null,"version":null,"sidebarTitle":"Removes a single user from a role","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/roles/{id}/users/{userId}","href":"/pt/reference/platform/access-manager/removes-a-single-user-from-a-role"}]},{"group":"Políticas de segurança","pages":[{"title":"Get Organization IP Allowlist","deprecated":null,"version":null,"sidebarTitle":"Get organization ip allowlist","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/security/ip-allowlist","href":"/pt/reference/platform/access-manager/get-organization-ip-allowlist"},{"title":"Set Organization IP Allowlist","deprecated":null,"version":null,"sidebarTitle":"Set organization ip allowlist","openapi":"/pt/openapi/v3-current/AM-identity.yaml put /v1/security/ip-allowlist","href":"/pt/reference/platform/access-manager/set-organization-ip-allowlist"},{"title":"Update SSO login policy","deprecated":null,"version":null,"sidebarTitle":"Update sso login policy","openapi":"/pt/openapi/v3-current/AM-identity.yaml patch /v1/sso/policy","href":"/pt/reference/platform/access-manager/update-sso-login-policy"},{"title":"Get SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Get sso provider configuration","openapi":"/pt/openapi/v3-current/AM-identity.yaml get /v1/sso/provider","href":"/pt/reference/platform/access-manager/get-sso-provider-configuration"},{"title":"Upsert SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Upsert sso provider configuration","openapi":"/pt/openapi/v3-current/AM-identity.yaml put /v1/sso/provider","href":"/pt/reference/platform/access-manager/upsert-sso-provider-configuration"},{"title":"Delete SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Delete sso provider configuration","openapi":"/pt/openapi/v3-current/AM-identity.yaml delete /v1/sso/provider","href":"/pt/reference/platform/access-manager/delete-sso-provider-configuration"},{"title":"Preflight an SSO provider configuration","deprecated":null,"version":null,"sidebarTitle":"Preflight an sso provider configuration","openapi":"/pt/openapi/v3-current/AM-identity.yaml post /v1/sso/provider/preflight","href":"/pt/reference/platform/access-manager/preflight-an-sso-provider-configuration"}]},{"group":"Declarações de plugins","pages":[{"title":"Upsert a plugin declaration","deprecated":null,"version":null,"sidebarTitle":"Upsert a plugin declaration","openapi":"/pt/openapi/v3-current/AM-identity.yaml put /v1/declarations/{slug}","href":"/pt/reference/platform/access-manager/upsert-a-plugin-declaration"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Access Manager","href":"/pt/reference/platform/access-manager/access-manager-error-list"}]}]},{"dropdown":"Streaming Hub","icon":"tower-broadcast","description":"Subscriptions de eventos e entrega","groups":[{"group":"Catálogo","pages":[{"title":"List the event catalog","deprecated":null,"version":null,"sidebarTitle":"Get event catalog","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/catalog","href":"/pt/reference/platform/streaming-hub/get-event-catalog"}]},{"group":"Subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"sidebarTitle":"Create subscription","openapi":"/pt/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions","href":"/pt/reference/platform/streaming-hub/create-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions","href":"/pt/reference/platform/streaming-hub/list-subscriptions"},{"title":"Get a subscription","deprecated":null,"version":null,"sidebarTitle":"Get subscription","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}","href":"/pt/reference/platform/streaming-hub/get-subscription"},{"title":"Read a subscription's full destination","deprecated":null,"version":null,"sidebarTitle":"Get subscription endpoint","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/endpoint","href":"/pt/reference/platform/streaming-hub/get-subscription-endpoint"},{"title":"Get subscription delivery health","deprecated":null,"version":null,"sidebarTitle":"Get subscription health","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/health","href":"/pt/reference/platform/streaming-hub/get-subscription-health"},{"title":"Re-pin a subscription's schema major","deprecated":null,"version":null,"sidebarTitle":"Update subscription schema pin","openapi":"/pt/openapi/v3-current/streaming-hub.yaml patch /v1/subscriptions/{id}","href":"/pt/reference/platform/streaming-hub/update-subscription-schema-pin"},{"title":"Delete a subscription","deprecated":null,"version":null,"sidebarTitle":"Delete subscription","openapi":"/pt/openapi/v3-current/streaming-hub.yaml delete /v1/subscriptions/{id}","href":"/pt/reference/platform/streaming-hub/delete-subscription"},{"title":"Ping a webhook subscription","deprecated":null,"version":null,"sidebarTitle":"Ping subscription","openapi":"/pt/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/ping","href":"/pt/reference/platform/streaming-hub/ping-subscription"},{"title":"Re-verify and re-enable a subscription","deprecated":null,"version":null,"sidebarTitle":"Verify subscription","openapi":"/pt/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/verify","href":"/pt/reference/platform/streaming-hub/verify-subscription"},{"title":"Set or rotate a queue credential","deprecated":null,"version":null,"sidebarTitle":"Set subscription credential","openapi":"/pt/openapi/v3-current/streaming-hub.yaml put /v1/subscriptions/{id}/credential","href":"/pt/reference/platform/streaming-hub/set-subscription-credential"},{"title":"Rotate the signing secret","deprecated":null,"version":null,"sidebarTitle":"Rotate subscription secret","openapi":"/pt/openapi/v3-current/streaming-hub.yaml post /v1/subscriptions/{id}/secret/rotate","href":"/pt/reference/platform/streaming-hub/rotate-subscription-secret"},{"title":"Get AWS delegated-grant setup artifacts","deprecated":null,"version":null,"sidebarTitle":"Get subscription setup artifacts","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/setup-artifacts","href":"/pt/reference/platform/streaming-hub/get-subscription-setup-artifacts"},{"title":"Register an AWS delegated grant","deprecated":null,"version":null,"sidebarTitle":"Set subscription delegated grant","openapi":"/pt/openapi/v3-current/streaming-hub.yaml put /v1/subscriptions/{id}/delegated-grant","href":"/pt/reference/platform/streaming-hub/set-subscription-delegated-grant"}]},{"group":"Entrega de eventos","pages":[{"title":"Pull entitled events","deprecated":null,"version":null,"sidebarTitle":"Pull events","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/events","href":"/pt/reference/platform/streaming-hub/pull-events"}]},{"group":"Painel","pages":[{"title":"Get the operational dashboard snapshot","deprecated":null,"version":null,"sidebarTitle":"Get dashboard","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/dashboard","href":"/pt/reference/platform/streaming-hub/get-dashboard"},{"title":"List the subscriptions needing attention","deprecated":null,"version":null,"sidebarTitle":"List subscriptions needing attention","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /v1/dashboard/subscriptions","href":"/pt/reference/platform/streaming-hub/list-subscriptions-needing-attention"}]},{"group":"Administração","pages":[{"title":"List dead-letter observations","deprecated":null,"version":null,"sidebarTitle":"List dlq observations","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /admin/dlq","href":"/pt/reference/platform/streaming-hub/list-dlq-observations"}]},{"group":"Operacional","pages":[{"title":"Liveness probe","deprecated":null,"version":null,"sidebarTitle":"Liveness probe","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /healthz","href":"/pt/reference/platform/streaming-hub/liveness-probe"},{"title":"Readiness probe","deprecated":null,"version":null,"sidebarTitle":"Readiness probe","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /readyz","href":"/pt/reference/platform/streaming-hub/readiness-probe"},{"title":"Build identity","deprecated":null,"version":null,"sidebarTitle":"Get version","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /version","href":"/pt/reference/platform/streaming-hub/get-version"},{"title":"Runtime snapshot","deprecated":null,"version":null,"sidebarTitle":"Get runtime","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /runtime","href":"/pt/reference/platform/streaming-hub/get-runtime"},{"title":"Prometheus metrics","deprecated":null,"version":null,"sidebarTitle":"Get metrics","openapi":"/pt/openapi/v3-current/streaming-hub.yaml get /metrics","href":"/pt/reference/platform/streaming-hub/get-metrics"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Streaming Hub","href":"/pt/reference/platform/streaming-hub/streaming-hub-error-list"}]}]},{"dropdown":"System Facts","icon":"clipboard-list","description":"Registre e correlacione fatos de negócio entre serviços","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API do System Facts","href":"/pt/reference/platform/system-facts/api-overview"}]},{"group":"Tipos de referência","pages":[{"title":"List reference types","deprecated":null,"version":null,"sidebarTitle":"List reference types","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/reference-types","href":"/pt/reference/platform/system-facts/list-reference-types"},{"title":"Read a reference type","deprecated":null,"version":null,"sidebarTitle":"Read a reference type","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/reference-types/{type}","href":"/pt/reference/platform/system-facts/read-a-reference-type"},{"title":"Register a reference type","deprecated":null,"version":null,"sidebarTitle":"Register a reference type","openapi":"/pt/openapi/v3-current/system-facts.yaml put /v1/reference-types/{type}","href":"/pt/reference/platform/system-facts/register-a-reference-type"}]},{"group":"Contratos","pages":[{"title":"List contract versions","deprecated":null,"version":null,"sidebarTitle":"List contract versions","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/contracts","href":"/pt/reference/platform/system-facts/list-contract-versions"},{"title":"List the versions of a fact type","deprecated":null,"version":null,"sidebarTitle":"List the versions of a fact type","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/contracts/{producer}/{namespace}/{type}","href":"/pt/reference/platform/system-facts/list-the-versions-of-a-fact-type"},{"title":"Read a contract version","deprecated":null,"version":null,"sidebarTitle":"Read a contract version","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}","href":"/pt/reference/platform/system-facts/read-a-contract-version"},{"title":"Register a contract version","deprecated":null,"version":null,"sidebarTitle":"Register a contract version","openapi":"/pt/openapi/v3-current/system-facts.yaml put /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}","href":"/pt/reference/platform/system-facts/register-a-contract-version"},{"title":"Deprecate a contract version","deprecated":null,"version":null,"sidebarTitle":"Deprecate a contract version","openapi":"/pt/openapi/v3-current/system-facts.yaml post /v1/contracts/{producer}/{namespace}/{type}/{schemaVersion}/deprecate","href":"/pt/reference/platform/system-facts/deprecate-a-contract-version"}]},{"group":"Fatos","pages":[{"title":"Send a fact","deprecated":null,"version":null,"sidebarTitle":"Send a fact","openapi":"/pt/openapi/v3-current/system-facts.yaml post /v1/facts","href":"/pt/reference/platform/system-facts/send-a-fact"}]},{"group":"Fluxos","pages":[{"title":"List facts by a searchable reference","deprecated":null,"version":null,"sidebarTitle":"List facts by a searchable reference","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/flows","href":"/pt/reference/platform/system-facts/list-facts-by-a-searchable-reference"},{"title":"Find the flow of a reference","deprecated":null,"version":null,"sidebarTitle":"Find the flow of a reference","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/flows/by-reference","href":"/pt/reference/platform/system-facts/find-the-flow-of-a-reference"},{"title":"Read a flow","deprecated":null,"version":null,"sidebarTitle":"Read a flow","openapi":"/pt/openapi/v3-current/system-facts.yaml get /v1/flows/{flowAggregationId}","href":"/pt/reference/platform/system-facts/read-a-flow"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros da API do System Facts","href":"/pt/reference/platform/system-facts/system-facts-error-list"}]}]},{"dropdown":"Systemplane","icon":"sliders","description":"Entradas de configuração de runtime e catálogo","groups":[{"group":"Visão geral","pages":[{"title":"API administrativa do Systemplane","href":"/pt/reference/platform/systemplane/overview"}]},{"group":"Entradas","pages":[{"title":"List entries in a namespace","deprecated":null,"version":null,"sidebarTitle":"List entries","openapi":"/pt/openapi/v3-current/systemplane.yaml get /system/{namespace}","href":"/pt/reference/platform/systemplane/list-entries"},{"title":"Get one entry","deprecated":null,"version":null,"sidebarTitle":"Get entry","openapi":"/pt/openapi/v3-current/systemplane.yaml get /system/{namespace}/{key}","href":"/pt/reference/platform/systemplane/get-entry"},{"title":"Write one entry","deprecated":null,"version":null,"sidebarTitle":"Put entry","openapi":"/pt/openapi/v3-current/systemplane.yaml put /system/{namespace}/{key}","href":"/pt/reference/platform/systemplane/put-entry"},{"title":"Delete one entry","deprecated":null,"version":null,"sidebarTitle":"Delete entry","openapi":"/pt/openapi/v3-current/systemplane.yaml delete /system/{namespace}/{key}","href":"/pt/reference/platform/systemplane/delete-entry"}]},{"group":"Catálogo","pages":[{"title":"List the key catalog","deprecated":null,"version":null,"sidebarTitle":"Catalog list","openapi":"/pt/openapi/v3-current/systemplane.yaml get /system/-/catalog","href":"/pt/reference/platform/systemplane/catalog-list"},{"title":"Get one key's write contract","deprecated":null,"version":null,"sidebarTitle":"Catalog detail","openapi":"/pt/openapi/v3-current/systemplane.yaml get /system/-/catalog/{namespace}/{key}","href":"/pt/reference/platform/systemplane/catalog-detail"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros do Systemplane","href":"/pt/reference/platform/systemplane/systemplane-error-list"}]}]},{"dropdown":"Narya","icon":"server","description":"Execute agentes de código por trás de uma única API HTTP","groups":[{"group":"Visão geral","pages":[{"title":"Visão geral da API do host do Narya","href":"/pt/reference/platform/narya/host-api-overview"}]},{"group":"Host","pages":[{"title":"Describe the host process","deprecated":null,"version":null,"sidebarTitle":"Describe the host process","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/host","href":"/pt/reference/platform/narya/describe-the-host-process"},{"title":"Run the read-only health walk","deprecated":null,"version":null,"sidebarTitle":"Run the read only health walk","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/doctor","href":"/pt/reference/platform/narya/run-the-read-only-health-walk"},{"title":"Report every declared external tool server's health and cost","deprecated":null,"version":null,"sidebarTitle":"Report every declared external tool server s health and cost","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/tool-servers","href":"/pt/reference/platform/narya/report-every-declared-external-tool-server-s-health-and-cost"}]},{"group":"Sessões","pages":[{"title":"List sessions","deprecated":null,"version":null,"sidebarTitle":"List sessions","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions","href":"/pt/reference/platform/narya/list-sessions"},{"title":"Create a session","deprecated":null,"version":null,"sidebarTitle":"Create a session","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions","href":"/pt/reference/platform/narya/create-a-session"},{"title":"Get a session","deprecated":null,"version":null,"sidebarTitle":"Get a session","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}","href":"/pt/reference/platform/narya/get-a-session"},{"title":"Archive a session","deprecated":null,"version":null,"sidebarTitle":"Archive a session","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}","href":"/pt/reference/platform/narya/archive-a-session"},{"title":"Switch the session's model","deprecated":null,"version":null,"sidebarTitle":"Switch the session s model","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/model","href":"/pt/reference/platform/narya/switch-the-session-s-model"},{"title":"Rename the session","deprecated":null,"version":null,"sidebarTitle":"Rename the session","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/title","href":"/pt/reference/platform/narya/rename-the-session"},{"title":"Record whether anybody is watching this session","deprecated":null,"version":null,"sidebarTitle":"Record whether anybody is watching this session","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/posture","href":"/pt/reference/platform/narya/record-whether-anybody-is-watching-this-session"},{"title":"Hold this session back from the organisation, or hand it back","deprecated":null,"version":null,"sidebarTitle":"Hold this session back from the organisation or hand it back","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/visibility","href":"/pt/reference/platform/narya/hold-this-session-back-from-the-organisation-or-hand-it-back"},{"title":"Put this session into a named response style","deprecated":null,"version":null,"sidebarTitle":"Put this session into a named response style","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/style","href":"/pt/reference/platform/narya/put-this-session-into-a-named-response-style"},{"title":"Move a session to another directory","deprecated":null,"version":null,"sidebarTitle":"Move a session to another directory","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/repository","href":"/pt/reference/platform/narya/move-a-session-to-another-directory"},{"title":"Record that a reader has looked at this session","deprecated":null,"version":null,"sidebarTitle":"Record that a reader has looked at this session","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/viewed","href":"/pt/reference/platform/narya/record-that-a-reader-has-looked-at-this-session"},{"title":"Say whether this session pays to stay warm, and how much","deprecated":null,"version":null,"sidebarTitle":"Say whether this session pays to stay warm and how much","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/warming","href":"/pt/reference/platform/narya/say-whether-this-session-pays-to-stay-warm-and-how-much"},{"title":"Branch a session at an earlier entry","deprecated":null,"version":null,"sidebarTitle":"Branch a session at an earlier entry","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/branch","href":"/pt/reference/platform/narya/branch-a-session-at-an-earlier-entry"},{"title":"Go back to an earlier point, on a new branch","deprecated":null,"version":null,"sidebarTitle":"Go back to an earlier point on a new branch","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/rewind","href":"/pt/reference/platform/narya/go-back-to-an-earlier-point-on-a-new-branch"},{"title":"Read a session's transcript","deprecated":null,"version":null,"sidebarTitle":"Read a session s transcript","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/entries","href":"/pt/reference/platform/narya/read-a-session-s-transcript"},{"title":"Read one file a transcript row carried","deprecated":null,"version":null,"sidebarTitle":"Read one file a transcript row carried","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/media/{mediaKey}","href":"/pt/reference/platform/narya/read-one-file-a-transcript-row-carried"},{"title":"Summarise this conversation, on demand","deprecated":null,"version":null,"sidebarTitle":"Summarise this conversation on demand","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/summary","href":"/pt/reference/platform/narya/summarise-this-conversation-on-demand"},{"title":"Label one entry of a transcript","deprecated":null,"version":null,"sidebarTitle":"Label one entry of a transcript","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/sessions/{sessionId}/entries/{entryId}/label","href":"/pt/reference/platform/narya/label-one-entry-of-a-transcript"},{"title":"Read the branched family a session belongs to","deprecated":null,"version":null,"sidebarTitle":"Read the branched family a session belongs to","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/tree","href":"/pt/reference/platform/narya/read-the-branched-family-a-session-belongs-to"},{"title":"Read what one conversation cost, broken down by model","deprecated":null,"version":null,"sidebarTitle":"Read what one conversation cost broken down by model","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/usage","href":"/pt/reference/platform/narya/read-what-one-conversation-cost-broken-down-by-model"},{"title":"Read what a session changed on disk","deprecated":null,"version":null,"sidebarTitle":"Read what a session changed on disk","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/changes","href":"/pt/reference/platform/narya/read-what-a-session-changed-on-disk"},{"title":"Drop a message still waiting behind a running turn","deprecated":null,"version":null,"sidebarTitle":"Drop a message still waiting behind a running turn","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/inputs/{entryId}","href":"/pt/reference/platform/narya/drop-a-message-still-waiting-behind-a-running-turn"},{"title":"Get the repository's saved composer draft","deprecated":null,"version":null,"sidebarTitle":"Get the repository s saved composer draft","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/drafts","href":"/pt/reference/platform/narya/get-the-repository-s-saved-composer-draft"},{"title":"Save the repository's composer draft","deprecated":null,"version":null,"sidebarTitle":"Save the repository s composer draft","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/drafts","href":"/pt/reference/platform/narya/save-the-repository-s-composer-draft"},{"title":"Read whether a repository's instruction files may be loaded","deprecated":null,"version":null,"sidebarTitle":"Read whether a repository s instruction files may be loaded","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/repository-trust","href":"/pt/reference/platform/narya/read-whether-a-repository-s-instruction-files-may-be-loaded"},{"title":"Record a repository's instruction-file answer","deprecated":null,"version":null,"sidebarTitle":"Record a repository s instruction file answer","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/repository-trust","href":"/pt/reference/platform/narya/record-a-repository-s-instruction-file-answer"}]},{"group":"Mensagens","pages":[{"title":"Submit a user message","deprecated":null,"version":null,"sidebarTitle":"Submit a user message","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/messages","href":"/pt/reference/platform/narya/submit-a-user-message"},{"title":"Interrupt the session's main lane","deprecated":null,"version":null,"sidebarTitle":"Interrupt the session s main lane","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/interrupt","href":"/pt/reference/platform/narya/interrupt-the-session-s-main-lane"},{"title":"Send a message to a session's inbox","deprecated":null,"version":null,"sidebarTitle":"Send a message to a session s inbox","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/inbox","href":"/pt/reference/platform/narya/send-a-message-to-a-session-s-inbox"},{"title":"Get an inter-session ask","deprecated":null,"version":null,"sidebarTitle":"Get an inter session ask","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/asks/{askId}","href":"/pt/reference/platform/narya/get-an-inter-session-ask"}]},{"group":"Eventos","pages":[{"title":"Stream events (SSE)","deprecated":null,"version":null,"sidebarTitle":"Stream events sse","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/events","href":"/pt/reference/platform/narya/stream-events-sse"}]},{"group":"Lanes","pages":[{"title":"List a session's lanes","deprecated":null,"version":null,"sidebarTitle":"List a session s lanes","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/lanes","href":"/pt/reference/platform/narya/list-a-session-s-lanes"},{"title":"Open a lane","deprecated":null,"version":null,"sidebarTitle":"Open a lane","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes","href":"/pt/reference/platform/narya/open-a-lane"},{"title":"Close a lane","deprecated":null,"version":null,"sidebarTitle":"Close a lane","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/lanes/{laneId}","href":"/pt/reference/platform/narya/close-a-lane"},{"title":"Submit a message to a lane","deprecated":null,"version":null,"sidebarTitle":"Submit a message to a lane","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/messages","href":"/pt/reference/platform/narya/submit-a-message-to-a-lane"},{"title":"Interrupt a lane","deprecated":null,"version":null,"sidebarTitle":"Interrupt a lane","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/interrupt","href":"/pt/reference/platform/narya/interrupt-a-lane"},{"title":"Stop waiting on a delegated lane","deprecated":null,"version":null,"sidebarTitle":"Stop waiting on a delegated lane","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/promote","href":"/pt/reference/platform/narya/stop-waiting-on-a-delegated-lane"},{"title":"Summarise this lane's conversation now","deprecated":null,"version":null,"sidebarTitle":"Summarise this lane s conversation now","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/compact","href":"/pt/reference/platform/narya/summarise-this-lane-s-conversation-now"},{"title":"Set aside this lane's old tool output","deprecated":null,"version":null,"sidebarTitle":"Set aside this lane s old tool output","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/lanes/{laneId}/prune","href":"/pt/reference/platform/narya/set-aside-this-lane-s-old-tool-output"}]},{"group":"Monitores","pages":[{"title":"List the session's running monitors","deprecated":null,"version":null,"sidebarTitle":"List the session s running monitors","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/monitors","href":"/pt/reference/platform/narya/list-the-session-s-running-monitors"},{"title":"Start a monitor","deprecated":null,"version":null,"sidebarTitle":"Start a monitor","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/monitors","href":"/pt/reference/platform/narya/start-a-monitor"},{"title":"Stop a monitor","deprecated":null,"version":null,"sidebarTitle":"Stop a monitor","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/monitors/{name}","href":"/pt/reference/platform/narya/stop-a-monitor"}]},{"group":"Agentes","pages":[{"title":"List agent recipes","deprecated":null,"version":null,"sidebarTitle":"List agent recipes","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/agents","href":"/pt/reference/platform/narya/list-agent-recipes"},{"title":"Get an agent recipe","deprecated":null,"version":null,"sidebarTitle":"Get an agent recipe","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/agents/{name}","href":"/pt/reference/platform/narya/get-an-agent-recipe"}]},{"group":"Skills e comandos","pages":[{"title":"List installed skills","deprecated":null,"version":null,"sidebarTitle":"List installed skills","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/skills","href":"/pt/reference/platform/narya/list-installed-skills"},{"title":"Expand one skill into text","deprecated":null,"version":null,"sidebarTitle":"Expand one skill into text","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/skills/{name}/expansion","href":"/pt/reference/platform/narya/expand-one-skill-into-text"},{"title":"List slash commands","deprecated":null,"version":null,"sidebarTitle":"List slash commands","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/commands","href":"/pt/reference/platform/narya/list-slash-commands"},{"title":"Expand one command file into text","deprecated":null,"version":null,"sidebarTitle":"Expand one command file into text","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/commands/{name}/expansion","href":"/pt/reference/platform/narya/expand-one-command-file-into-text"}]},{"group":"Permissões","pages":[{"title":"List permission asks","deprecated":null,"version":null,"sidebarTitle":"List permission asks","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/permissions","href":"/pt/reference/platform/narya/list-permission-asks"},{"title":"Decide a permission ask","deprecated":null,"version":null,"sidebarTitle":"Decide a permission ask","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/permissions/{permissionId}/decision","href":"/pt/reference/platform/narya/decide-a-permission-ask"},{"title":"List the decision audit","deprecated":null,"version":null,"sidebarTitle":"List the decision audit","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/permissions/decisions","href":"/pt/reference/platform/narya/list-the-decision-audit"},{"title":"List the questions waiting on a person","deprecated":null,"version":null,"sidebarTitle":"List the questions waiting on a person","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/questions","href":"/pt/reference/platform/narya/list-the-questions-waiting-on-a-person"},{"title":"Answer a question the agent asked","deprecated":null,"version":null,"sidebarTitle":"Answer a question the agent asked","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/questions/{questionId}/answer","href":"/pt/reference/platform/narya/answer-a-question-the-agent-asked"}]},{"group":"Peers","pages":[{"title":"List addressable peer sessions","deprecated":null,"version":null,"sidebarTitle":"List addressable peer sessions","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/peers","href":"/pt/reference/platform/narya/list-addressable-peer-sessions"}]},{"group":"Pacotes","pages":[{"title":"List installed packages","deprecated":null,"version":null,"sidebarTitle":"List installed packages","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/packages","href":"/pt/reference/platform/narya/list-installed-packages"},{"title":"Install a package","deprecated":null,"version":null,"sidebarTitle":"Install a package","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/packages","href":"/pt/reference/platform/narya/install-a-package"},{"title":"Say what a source is, and whether installing it needs trust","deprecated":null,"version":null,"sidebarTitle":"Say what a source is and whether installing it needs trust","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/packages/classification","href":"/pt/reference/platform/narya/say-what-a-source-is-and-whether-installing-it-needs-trust"},{"title":"Get a package job","deprecated":null,"version":null,"sidebarTitle":"Get a package job","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/packages/jobs/{jobId}","href":"/pt/reference/platform/narya/get-a-package-job"},{"title":"Remove a package","deprecated":null,"version":null,"sidebarTitle":"Remove a package","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/packages/{name}","href":"/pt/reference/platform/narya/remove-a-package"},{"title":"Disable a package","deprecated":null,"version":null,"sidebarTitle":"Disable a package","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/packages/{name}/disable","href":"/pt/reference/platform/narya/disable-a-package"},{"title":"Enable a package","deprecated":null,"version":null,"sidebarTitle":"Enable a package","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/packages/{name}/enable","href":"/pt/reference/platform/narya/enable-a-package"}]},{"group":"Extensões","pages":[{"title":"List this home's registered extensions","deprecated":null,"version":null,"sidebarTitle":"List this home s registered extensions","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/extensions","href":"/pt/reference/platform/narya/list-this-home-s-registered-extensions"},{"title":"Register an extension","deprecated":null,"version":null,"sidebarTitle":"Register an extension","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/extensions","href":"/pt/reference/platform/narya/register-an-extension"},{"title":"Read one registered extension","deprecated":null,"version":null,"sidebarTitle":"Read one registered extension","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/extensions/{publisher}/{name}","href":"/pt/reference/platform/narya/read-one-registered-extension"},{"title":"Re-point, re-order, re-grant or disable a registered extension","deprecated":null,"version":null,"sidebarTitle":"Re point re order re grant or disable a registered extension","openapi":"/pt/openapi/v3-current/narya.yaml patch /v1/extensions/{publisher}/{name}","href":"/pt/reference/platform/narya/re-point-re-order-re-grant-or-disable-a-registered-extension"},{"title":"Revoke a registered extension","deprecated":null,"version":null,"sidebarTitle":"Revoke a registered extension","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/extensions/{publisher}/{name}","href":"/pt/reference/platform/narya/revoke-a-registered-extension"},{"title":"Rotate a registered extension's secret","deprecated":null,"version":null,"sidebarTitle":"Rotate a registered extension s secret","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/extensions/{publisher}/{name}/secret","href":"/pt/reference/platform/narya/rotate-a-registered-extension-s-secret"},{"title":"Invoke an operation a registered extension exposes","deprecated":null,"version":null,"sidebarTitle":"Invoke an operation a registered extension exposes","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/extensions/{name}/invoke","href":"/pt/reference/platform/narya/invoke-an-operation-a-registered-extension-exposes"}]},{"group":"Workflows","pages":[{"title":"List workflow runs","deprecated":null,"version":null,"sidebarTitle":"List workflow runs","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/workflows/runs","href":"/pt/reference/platform/narya/list-workflow-runs"},{"title":"Start a workflow run","deprecated":null,"version":null,"sidebarTitle":"Start a workflow run","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/workflows/runs","href":"/pt/reference/platform/narya/start-a-workflow-run"},{"title":"Get a workflow run","deprecated":null,"version":null,"sidebarTitle":"Get a workflow run","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/workflows/runs/{runId}","href":"/pt/reference/platform/narya/get-a-workflow-run"},{"title":"Stop a workflow run","deprecated":null,"version":null,"sidebarTitle":"Stop a workflow run","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/workflows/runs/{runId}/stop","href":"/pt/reference/platform/narya/stop-a-workflow-run"},{"title":"Resume a workflow run","deprecated":null,"version":null,"sidebarTitle":"Resume a workflow run","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/workflows/runs/{runId}/resume","href":"/pt/reference/platform/narya/resume-a-workflow-run"}]},{"group":"Agendamentos","pages":[{"title":"List the schedules this host's clock owes","deprecated":null,"version":null,"sidebarTitle":"List the schedules this host s clock owes","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/schedules","href":"/pt/reference/platform/narya/list-the-schedules-this-host-s-clock-owes"},{"title":"Ask the host's clock to start work nobody will be present for","deprecated":null,"version":null,"sidebarTitle":"Ask the host s clock to start work nobody will be present for","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/schedules","href":"/pt/reference/platform/narya/ask-the-host-s-clock-to-start-work-nobody-will-be-present-for"},{"title":"Get a schedule","deprecated":null,"version":null,"sidebarTitle":"Get a schedule","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/schedules/{scheduleId}","href":"/pt/reference/platform/narya/get-a-schedule"},{"title":"Cancel a schedule","deprecated":null,"version":null,"sidebarTitle":"Cancel a schedule","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/schedules/{scheduleId}","href":"/pt/reference/platform/narya/cancel-a-schedule"},{"title":"Say what one fire of this schedule may spend","deprecated":null,"version":null,"sidebarTitle":"Say what one fire of this schedule may spend","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/schedules/{scheduleId}/budget","href":"/pt/reference/platform/narya/say-what-one-fire-of-this-schedule-may-spend"}]},{"group":"Provedores","pages":[{"title":"List model providers","deprecated":null,"version":null,"sidebarTitle":"List model providers","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/providers","href":"/pt/reference/platform/narya/list-model-providers"},{"title":"Start provider sign-in","deprecated":null,"version":null,"sidebarTitle":"Start provider sign in","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/providers/{name}/auth","href":"/pt/reference/platform/narya/start-provider-sign-in"},{"title":"Read the provider's sign-in in flight","deprecated":null,"version":null,"sidebarTitle":"Read the provider s sign in in flight","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/providers/{name}/auth","href":"/pt/reference/platform/narya/read-the-provider-s-sign-in-in-flight"},{"title":"Sign out of a provider","deprecated":null,"version":null,"sidebarTitle":"Sign out of a provider","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/providers/{name}/auth","href":"/pt/reference/platform/narya/sign-out-of-a-provider"},{"title":"List models across providers","deprecated":null,"version":null,"sidebarTitle":"List models across providers","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/models","href":"/pt/reference/platform/narya/list-models-across-providers"},{"title":"List recently chosen models","deprecated":null,"version":null,"sidebarTitle":"List recently chosen models","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/models/recent","href":"/pt/reference/platform/narya/list-recently-chosen-models"}]},{"group":"Registros","pages":[{"title":"Search the sessions you can read","deprecated":null,"version":null,"sidebarTitle":"Search all past sessions","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/records/search","href":"/pt/reference/platform/narya/search-all-past-sessions"},{"title":"List sessions that touched a file","deprecated":null,"version":null,"sidebarTitle":"List sessions that touched a file","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/records/files","href":"/pt/reference/platform/narya/list-sessions-that-touched-a-file"},{"title":"Report consumption over a period","deprecated":null,"version":null,"sidebarTitle":"Report consumption over a period","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/records/usage","href":"/pt/reference/platform/narya/report-consumption-over-a-period"},{"title":"Import a transcript from another harness","deprecated":null,"version":null,"sidebarTitle":"Import a transcript from another harness","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/import","href":"/pt/reference/platform/narya/import-a-transcript-from-another-harness"},{"title":"Export a session transcript","deprecated":null,"version":null,"sidebarTitle":"Export a session transcript","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/export","href":"/pt/reference/platform/narya/export-a-session-transcript"}]},{"group":"Ambientes","pages":[{"title":"List the environments this host holds","deprecated":null,"version":null,"sidebarTitle":"List the environments this host holds","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/environments","href":"/pt/reference/platform/narya/list-the-environments-this-host-holds"},{"title":"Create an environment","deprecated":null,"version":null,"sidebarTitle":"Create an environment","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/environments","href":"/pt/reference/platform/narya/create-an-environment"},{"title":"Get an environment","deprecated":null,"version":null,"sidebarTitle":"Get an environment","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/environments/{environmentId}","href":"/pt/reference/platform/narya/get-an-environment"},{"title":"Destroy an environment","deprecated":null,"version":null,"sidebarTitle":"Destroy an environment","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/environments/{environmentId}","href":"/pt/reference/platform/narya/destroy-an-environment"},{"title":"List the repositories this organisation selected on GitHub","deprecated":null,"version":null,"sidebarTitle":"List the repositories this organisation selected on github","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/github/repositories","href":"/pt/reference/platform/narya/list-the-repositories-this-organisation-selected-on-github"}]},{"group":"Compartilhamento","pages":[{"title":"Publish this session to the organisation's home","deprecated":null,"version":null,"sidebarTitle":"Publish this session to the organisation s home","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/sessions/{sessionId}/share","href":"/pt/reference/platform/narya/publish-this-session-to-the-organisation-s-home"},{"title":"The live shares of this session, and who each one is for","deprecated":null,"version":null,"sidebarTitle":"The live shares of this session and who each one is for","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share","href":"/pt/reference/platform/narya/the-live-shares-of-this-session-and-who-each-one-is-for"},{"title":"Revoke every share of this session, deleting what was copied","deprecated":null,"version":null,"sidebarTitle":"Revoke every share of this session deleting what was copied","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/sessions/{sessionId}/share","href":"/pt/reference/platform/narya/revoke-every-share-of-this-session-deleting-what-was-copied"},{"title":"What publishing this session would send, and what it would hold back","deprecated":null,"version":null,"sidebarTitle":"What publishing this session would send and what it would hold back","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share/preview","href":"/pt/reference/platform/narya/what-publishing-this-session-would-send-and-what-it-would-hold-back"},{"title":"Who has opened this shared session, and when","deprecated":null,"version":null,"sidebarTitle":"Who has opened this shared session and when","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/share/disclosures","href":"/pt/reference/platform/narya/who-has-opened-this-shared-session-and-when"},{"title":"List the shared sessions this home holds","deprecated":null,"version":null,"sidebarTitle":"List the shared sessions this home holds","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/shares","href":"/pt/reference/platform/narya/list-the-shared-sessions-this-home-holds"},{"title":"Read one shared session's record","deprecated":null,"version":null,"sidebarTitle":"Read one shared session s record","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/shares/{shareId}","href":"/pt/reference/platform/narya/read-one-shared-session-s-record"},{"title":"Delete everything this home holds for one share","deprecated":null,"version":null,"sidebarTitle":"Delete everything this home holds for one share","openapi":"/pt/openapi/v3-current/narya.yaml delete /v1/shares/{shareId}","href":"/pt/reference/platform/narya/delete-everything-this-home-holds-for-one-share"},{"title":"Read a shared session's copied entries","deprecated":null,"version":null,"sidebarTitle":"Read a shared session s copied entries","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/shares/{shareId}/entries","href":"/pt/reference/platform/narya/read-a-shared-session-s-copied-entries"},{"title":"Take a batch of a shared session's entries","deprecated":null,"version":null,"sidebarTitle":"Take a batch of a shared session s entries","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/shares/{shareId}/entries","href":"/pt/reference/platform/narya/take-a-batch-of-a-shared-session-s-entries"},{"title":"Settle who a published share is for","deprecated":null,"version":null,"sidebarTitle":"Settle who a published share is for","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/shares/{shareId}/recipients","href":"/pt/reference/platform/narya/settle-who-a-published-share-is-for"},{"title":"Take who the copy of a share is for","deprecated":null,"version":null,"sidebarTitle":"Take who the copy of a share is for","openapi":"/pt/openapi/v3-current/narya.yaml put /v1/shares/{shareId}/audience","href":"/pt/reference/platform/narya/take-who-the-copy-of-a-share-is-for"},{"title":"Who has opened this shared copy, and when","deprecated":null,"version":null,"sidebarTitle":"Who has opened this shared copy and when","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/shares/{shareId}/disclosures","href":"/pt/reference/platform/narya/who-has-opened-this-shared-copy-and-when"}]},{"group":"Refinamentos","pages":[{"title":"Read the exact system prompt this session's next turn will send","deprecated":null,"version":null,"sidebarTitle":"Read the exact system prompt this session s next turn will send","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/sessions/{sessionId}/prompt","href":"/pt/reference/platform/narya/read-the-exact-system-prompt-this-session-s-next-turn-will-send"},{"title":"List what narya has been taught","deprecated":null,"version":null,"sidebarTitle":"List what narya has been taught","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/refinements","href":"/pt/reference/platform/narya/list-what-narya-has-been-taught"},{"title":"Teach narya something, and ask a person to allow it","deprecated":null,"version":null,"sidebarTitle":"Teach narya something and ask a person to allow it","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/refinements","href":"/pt/reference/platform/narya/teach-narya-something-and-ask-a-person-to-allow-it"},{"title":"Read one refinement whole","deprecated":null,"version":null,"sidebarTitle":"Read one refinement whole","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/refinements/{refinementId}","href":"/pt/reference/platform/narya/read-one-refinement-whole"},{"title":"Undo what narya learned","deprecated":null,"version":null,"sidebarTitle":"Undo what narya learned","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/rollback","href":"/pt/reference/platform/narya/undo-what-narya-learned"},{"title":"Ask to widen what a fact applies to","deprecated":null,"version":null,"sidebarTitle":"Ask to widen what a fact applies to","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/promote","href":"/pt/reference/platform/narya/ask-to-widen-what-a-fact-applies-to"},{"title":"Narrow a fact to one checkout","deprecated":null,"version":null,"sidebarTitle":"Narrow a fact to one checkout","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/refinements/{refinementId}/demote","href":"/pt/reference/platform/narya/narrow-a-fact-to-one-checkout"},{"title":"List the rounds waiting on a person","deprecated":null,"version":null,"sidebarTitle":"List the rounds waiting on a person","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/refinements/rounds","href":"/pt/reference/platform/narya/list-the-rounds-waiting-on-a-person"},{"title":"Read one round whole, to answer it","deprecated":null,"version":null,"sidebarTitle":"Read one round whole to answer it","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/refinements/rounds/{roundId}","href":"/pt/reference/platform/narya/read-one-round-whole-to-answer-it"},{"title":"Answer one round of proposed refinements","deprecated":null,"version":null,"sidebarTitle":"Answer one round of proposed refinements","openapi":"/pt/openapi/v3-current/narya.yaml post /v1/refinements/rounds/{roundId}/answer","href":"/pt/reference/platform/narya/answer-one-round-of-proposed-refinements"}]},{"group":"Plataforma","pages":[{"title":"List the calls Lerian's platform made to this home","deprecated":null,"version":null,"sidebarTitle":"Every time lerian s platform reached this home","openapi":"/pt/openapi/v3-current/narya.yaml get /v1/platform/accesses","href":"/pt/reference/platform/narya/every-time-lerian-s-platform-reached-this-home"}]},{"group":"Tratamento de erros","pages":[{"title":"Lista de erros da API do host do Narya","href":"/pt/reference/platform/narya/host-api-error-list"}]}]}]}]},{"tab":"Novidades","icon":"bullhorn","pages":[{"title":"Novidades","href":"/pt/news/news"}]}]},{"language":"es","footer":{"socials":{"github":"https://github.com/LerianStudio","linkedin":"https://www.linkedin.com/company/lerianstudio","instagram":"https://www.instagram.com/lerian.studio"},"links":[{"header":"Productos","items":[{"label":"Midaz","href":"/es/products/midaz/what-is-midaz"},{"label":"Tracer","href":"/es/products/tracer/what-is-tracer"},{"label":"Matcher","href":"/es/products/matcher/what-is-matcher"},{"label":"Flowker","href":"/es/products/flowker/what-is-flowker"},{"label":"Lender","href":"/es/products/lender/what-is-lender"},{"label":"Reporter","href":"/es/products/reporter/what-is-reporter"}]},{"header":"Pagos","items":[{"label":"Rieles Brasil","href":"/es/rails/what-are-brazil-rails"},{"label":"Interfaces","href":"/es/interfaces/introduction"},{"label":"Pix","href":"/es/interfaces/pix/pix-overview"},{"label":"TED","href":"/es/interfaces/ted/ted-overview"}]},{"header":"Desarrolladores","items":[{"label":"Referencia de API","href":"/es/reference/introduction"},{"label":"Streaming de eventos","href":"/es/reference/events/overview"},{"label":"Novedades","href":"/es/news/news"}]},{"header":"Empresa","items":[{"label":"Blog","href":"https://blog.lerian.studio/"},{"label":"Contacto","href":"https://lerian.studio/contact"},{"label":"GitHub","href":"https://github.com/LerianStudio"}]}]},"navbar":{"links":[{"icon":"newspaper","href":"https://blog.lerian.studio/","label":"Blog"}],"primary":{"type":"button","label":"Contáctanos","href":"https://lerian.studio/contact"}},"pages":[{"title":"es","href":"/es/reference/rails/consignado/read-the-b3-instrument-code-of-an-averbado-contract"}]}]},"title":"Read the B3 instrument code of an averbado contract - Lerian","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}