ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO-02.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=1cf0ec2d074438cb2e0a6ac1d66db4f9","dark":"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO_Prancheta1.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=9b412ec26f2e68ec5734e75b5363223a","href":"https://www.trio.com.br/"},"favicon":{"light":"https://mintcdn.com/trio-372e8dab/fUAB1jI_-7Nq6WNd/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=fUAB1jI_-7Nq6WNd\u0026q=85\u0026s=02e84f8cdce49974f6bd250833fbf98d","dark":"https://mintcdn.com/trio-372e8dab/fUAB1jI_-7Nq6WNd/images/favicon-32x32.png?fit=max\u0026auto=format\u0026n=fUAB1jI_-7Nq6WNd\u0026q=85\u0026s=02e84f8cdce49974f6bd250833fbf98d"},"api":{"mdx":{"auth":{"method":"basic"}}},"navbar":{"links":[{"href":"https://suporte.trio.com.br/","label":"Support"}],"primary":{"type":"button","label":"App Trio Sandbox","href":"https://app.sandbox.trio.com.br/"}},"footer":{"socials":{"linkedin":"https://br.linkedin.com/company/trio-fin"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trio-372e8dab","hasAudioNarration":false,"actualSubdomain":"trio-372e8dab","customDomains":["docs.trio.com.br"],"gitSource":{"type":"github","owner":"triohq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad66495f11a44816eec772d","collectionId":"7fcef832-c3e9-4b27-a3c2-2b52465406ea","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad66495f11a44816eec772d"},"feedback":{"thumbs":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adf69a197503f50adc66f00","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API reference","count":239},{"language":"default","tag":"Banking API","count":239},{"language":"default","tag":"Receivables","count":96},{"language":"default","tag":"Guides","count":51},{"language":"default","tag":"Payments","count":46},{"language":"default","tag":"Get Started","count":43},{"language":"default","tag":"Cards","count":35},{"language":"default","tag":"Webhooks","count":29},{"language":"default","tag":"Documents","count":29},{"language":"default","tag":"Pix","count":27}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"v2/api-reference/banking-api/institutions/list","slug":"/v2/api-reference/banking-api/institutions/list","pageMetadata":{"title":"List institutions","description":"List institutions - Banking","openapi":"v2/api-reference/openapi.json GET /v2/institutions","href":"/v2/api-reference/banking-api/institutions/list"},"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: \"List institutions - Banking\"\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":"List institutions","description":"List institutions - Banking","openapi":"v2/api-reference/openapi.json GET /v2/institutions","href":"/v2/api-reference/banking-api/institutions/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"callbacks":{},"description":"List institutions - Banking","operationId":"TrioFoundationWeb.V2.InstitutionController.index","parameters":["8e3c3382-f122-4187-b827-ac6ecd08abfc","3c0d7bc9-0d46-4cea-86ba-2e1777b751b5"],"responses":{"200":"6c03590b-4bdc-4e53-8fe4-40e45ac970b2","400":"58ffffae-8730-440d-9c24-e50bb75e5326","401":"7c880bf7-d2ea-46ad-8e4f-0c04332c7843","403":"a75f26fc-f838-4087-a7bf-ae98bf8e27d8","422":"07a032a3-1000-4d3f-97d1-1489bf04191f","503":"ffbd4eae-58dc-4ff9-82ab-af3fdba81552"},"security":["be2d9474-4641-45cc-b4ef-72e18bc8d965"],"summary":"List institutions","tags":["Institutions"],"method":"get","type":"path","servers":["6b606548-108f-4b34-8876-eafdf28edb31","2aa90cdd-ea34-4abe-ab07-114eac0f94f9","a19927d0-920a-4e65-aad9-8799051214df"],"path":"/v2/institutions","baseUrlOptions":["https://api.sandbox.trio.com.br","https://api.qa.trio.com.br","https://api.trio.com.br"],"title":"List institutions","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8e3c3382-f122-4187-b827-ac6ecd08abfc":{"description":"Bank ISPB","in":"query","name":"ispb","required":false,"schema":{"type":"string","x-struct":null,"x-validate":null,"isRequired":false,"description":"Bank ISPB","uniqueKey":"","typeLabel":"string"}},"3c0d7bc9-0d46-4cea-86ba-2e1777b751b5":{"description":"Bank Number","in":"query","name":"number","required":false,"schema":{"type":"string","x-struct":null,"x-validate":null,"isRequired":false,"description":"Bank Number","uniqueKey":"","typeLabel":"string"}},"a541bea7-1d57-4fb9-8e5a-dd6b6450ce13":{"description":"Version of the v2 contract the client is written against. Each breaking change publishes a new version.","example":"2026-10-19.v2","in":"header","name":"Trio-Version","required":true,"schema":{"enum":["2026-10-19.v2"],"type":"string","x-struct":null,"x-validate":null,"isRequired":true,"description":"Version of the v2 contract the client is written against. Each breaking change publishes a new version.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"f2be501b-370a-4b43-9928-2d91f0e4e987":{"description":"ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.","in":"header","name":"Trio-Target-Org-Id","required":false,"schema":{"format":"uuid","type":"string","x-struct":null,"x-validate":null,"isRequired":false,"description":"ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"6c03590b-4bdc-4e53-8fe4-40e45ac970b2":{"content":{"application/json":{"schema":{"description":"List of financial institutions","example":{"data":[{"authorized":true,"display_name":"001 - 000000001 - Nome do Banco Ltda","full_name":"Nome do Banco Ltda","id":"41234d60-f6a9-4c9c-8cc3-5769ce9bbea2","inserted_at":"2024-10-17T13:32:59.374149Z","ispb":"00000001","name":"Nome do Banco","number":"001","updated_at":"2024-10-17T13:32:59.374149Z"}]},"properties":{"data":{"items":{"description":"A financial institution","example":{"authorized":true,"display_name":"001 - 000000001 - Nome do Banco Ltda","full_name":"Nome do Banco Ltda","id":"41234d60-f6a9-4c9c-8cc3-5769ce9bbea2","inserted_at":"2024-10-17T13:32:59.374149Z","ispb":"00000001","name":"Nome do Banco","number":"001","updated_at":"2024-10-17T13:32:59.374149Z"},"properties":{"authorized":{"description":"Authorized institution?","type":"boolean","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].authorized","typeLabel":"boolean"},"display_name":{"description":"Institution display name","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].display_name","typeLabel":"string"},"full_name":{"description":"Institution full name","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].full_name","typeLabel":"string"},"id":{"description":"Institution ID","format":"uuid","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"inserted_at":{"description":"Creation date and time","format":"date-time","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].inserted_at","typeLabel":"string\u003cdate-time>"},"ispb":{"description":"Institution ISPB","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].ispb","typeLabel":"string"},"name":{"description":"Institution name","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].name","typeLabel":"string"},"number":{"description":"Institution bank number","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].number","typeLabel":"string"},"updated_at":{"description":"Last update date and time","format":"date-time","type":"string","x-struct":null,"x-validate":null,"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"title":"V2 institution","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.InstitutionData","x-validate":null,"uniqueKey":"data.items.[INDEX]","typeLabel":"V2 institution · object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"data","typeLabel":"V2 institution · object[]"}},"title":"V2 list institutions response","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.Banking.V2.Institution.ListResponse","x-validate":null,"uniqueKey":"","typeLabel":"V2 list institutions response · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"authorized":true,"display_name":"001 - 000000001 - Nome do Banco Ltda","full_name":"Nome do Banco Ltda","id":"41234d60-f6a9-4c9c-8cc3-5769ce9bbea2","inserted_at":"2024-10-17T13:32:59.374149Z","ispb":"00000001","name":"Nome do Banco","number":"001","updated_at":"2024-10-17T13:32:59.374149Z"}]}}},"exampleType":"generated"}},"description":"Institutions","exampleType":"generated"},"58ffffae-8730-440d-9c24-e50bb75e5326":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Malformed request: a body that is not valid JSON (MALFORMED_REQUEST), or a Trio-Version header that is missing or not the current one (INVALID_TRIO_VERSION).","exampleType":"generated"},"7c880bf7-d2ea-46ad-8e4f-0c04332c7843":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Missing or invalid API key credentials (INVALID_CREDENTIALS).","exampleType":"generated"},"a75f26fc-f838-4087-a7bf-ae98bf8e27d8":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"The API key may not do this (FORBIDDEN): for instance Trio-Target-Org-Id names an org it has no access to, or writes through a read-only access.","exampleType":"generated"},"07a032a3-1000-4d3f-97d1-1489bf04191f":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"Invalid input (INVALID_PARAMETER, REQUIRED_PARAMETER, or the code of the rule the request breaks). A request outside the operation's schema lists the offending fields in `errors`.","exampleType":"generated"},"ffbd4eae-58dc-4ff9-82ab-af3fdba81552":{"content":{"application/json":{"schema":{"example":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}},"properties":{"error":{"properties":{"error_code":{"description":"Stable UPPER_SNAKE identifier of the error, for programs and logs. Branch on this, not on the message.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"error_message":{"description":"Human readable explanation of the error.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.error_message","typeLabel":"string"},"errors":{"description":"Only on INVALID_PARAMETER for a request outside the operation's schema: one entry per offending field.","items":{"properties":{"field":{"description":"JSON pointer to the field, e.g. /amount.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].field","typeLabel":"string"},"message":{"description":"What is wrong with it.","type":"string","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"type":"object","x-struct":null,"x-validate":null,"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"type":"array","x-struct":null,"x-validate":null,"uniqueKey":"error.errors","typeLabel":"object[]"}},"required":["error_code","error_message"],"type":"object","x-struct":null,"x-validate":null,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"title":"V2 error","type":"object","x-struct":"Elixir.TrioFoundationWeb.Schemas.HTTP.V2Error","x-validate":null,"uniqueKey":"","typeLabel":"V2 error · object"},"examples":{"Example":{"title":"Example","value":{"error":{"error_code":"INVALID_PARAMETER","error_message":"Invalid parameters: /amount: Invalid integer. Got: string","errors":[{"field":"/amount","message":"Invalid integer. Got: string"}]}}}},"exampleType":"generated"}},"description":"A service needed to answer is unavailable (TRIO_SERVICE_UNAVAILABLE).","exampleType":"generated"}},"security":{"be2d9474-4641-45cc-b4ef-72e18bc8d965":{"authorization":{"scheme":"basic","type":"http","scopes":[],"schemeName":"authorization"}}},"servers":{"6b606548-108f-4b34-8876-eafdf28edb31":{"url":"https://api.sandbox.trio.com.br","variables":{}},"2aa90cdd-ea34-4abe-ab07-114eac0f94f9":{"url":"https://api.qa.trio.com.br","variables":{}},"a19927d0-920a-4e65-aad9-8799051214df":{"url":"https://api.trio.com.br","variables":{}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"basic","type":"http","scopes":[],"schemeName":"authorization"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"v2/api-reference/openapi.json"},"subdomain":"trio-372e8dab","siteName":"Documentation","title":"List institutions - Documentation","navMaps":{"firstHrefInVersion":{"V2":{"href":"/v2/api-reference/banking-api/institutions/list","matchLevel":0},"V1":{"href":"/api-reference/banking-api/institutions/list","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T14:55:23.404Z","originalFileLocation":"v2/api-reference/banking-api/institutions/list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List institutions - Banking\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_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/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List institutions - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"List institutions - Banking\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trio-372e8dab.mintlify.app/_mintlify/api/og/v2?division=Institutions\u0026amp;title=List+institutions\u0026amp;description=List+institutions+-+Banking\u0026amp;theme=a7af139e37e3767434f3134c\u0026amp;signature=21d8c9e1c98047917ade155f5b6ab7ca8a867e23d8fde65aae659c8de49bf797\">\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=\"List institutions - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List institutions - Banking\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trio-372e8dab.mintlify.app/_mintlify/api/og/v2?division=Institutions\u0026amp;title=List+institutions\u0026amp;description=List+institutions+-+Banking\u0026amp;theme=a7af139e37e3767434f3134c\u0026amp;signature=21d8c9e1c98047917ade155f5b6ab7ca8a867e23d8fde65aae659c8de49bf797\">\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/trio-372e8dab/rOBbojnXBM3FDhcZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/banking-api/institutions/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.trio.com.br/#organization\",\"name\":\"Documentation\",\"url\":\"https://docs.trio.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trio-372e8dab/93Kz5zeq9leNAs-j/images/LOGO_TRIO-02.png?fit=max\u0026auto=format\u0026n=93Kz5zeq9leNAs-j\u0026q=85\u0026s=1cf0ec2d074438cb2e0a6ac1d66db4f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.trio.com.br#website\",\"name\":\"Documentation\",\"url\":\"https://docs.trio.com.br\",\"publisher\":{\"@id\":\"https://docs.trio.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list#webpage\",\"url\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list\",\"name\":\"List institutions\",\"description\":\"List institutions - Banking\",\"dateModified\":\"2026-10-26T14:55:23.404Z\",\"isPartOf\":{\"@id\":\"https://docs.trio.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Banking API\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/onboarding/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List institutions\",\"item\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list#apireference\",\"headline\":\"List institutions\",\"name\":\"List institutions\",\"description\":\"List institutions - Banking\",\"url\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.trio.com.br/v2/api-reference/banking-api/institutions/list#webpage\"},\"dateModified\":\"2026-10-26T14:55:23.404Z\",\"publisher\":{\"@id\":\"https://docs.trio.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.trio.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":null,"versions":[{"version":"V2","default":true,"tag":"Current","tabs":[{"tab":"Get Started","pages":[{"title":"Get Started","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/v2/guides/onboarding-guide"}]},{"tab":"API reference","groups":[{"group":"Banking API","pages":[{"group":"Onboarding","pages":[{"title":"Onboard entity","sidebarTitle":"Onboard entity","openapi":"v2/api-reference/openapi.json POST /v2/onboarding","href":"/v2/api-reference/banking-api/onboarding/create"},{"title":"Upload onboarding document","sidebarTitle":"Upload document","openapi":"v2/api-reference/openapi.json POST /v2/onboarding/documents","href":"/v2/api-reference/banking-api/onboarding/create-document"}]},{"group":"Entities","pages":[{"title":"List entities","openapi":"v2/api-reference/openapi.json GET /v2/entities","href":"/v2/api-reference/banking-api/entities/list"},{"title":"Get entity by ID","openapi":"v2/api-reference/openapi.json GET /v2/entities/{id}","href":"/v2/api-reference/banking-api/entities/get"}]},{"group":"Counterparties","pages":[{"title":"List Counterparties","openapi":"v2/api-reference/openapi.json GET /v2/counterparties","href":"/v2/api-reference/banking-api/counterparties/list-counterparties"},{"title":"Get Counterparty","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{id}","href":"/v2/api-reference/banking-api/counterparties/get-counterparty"},{"title":"Find or Create Counterparty","openapi":"v2/api-reference/openapi.json POST /v2/counterparties","href":"/v2/api-reference/banking-api/counterparties/create-counterparty"},{"group":"Bank Accounts","pages":[{"title":"List Counterparty Bank Accounts","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/bank_accounts","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/list-counterparty-bank-accounts"},{"title":"Get Counterparty Bank Account","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/bank_accounts/{counterparty_bank_account_id}","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/get-counterparty-bank-account"},{"title":"Create Counterparty Bank Account","openapi":"v2/api-reference/openapi.json POST /v2/counterparties/{counterparty_id}/bank_accounts","href":"/v2/api-reference/banking-api/counterparties/bank-accounts/create-counterparty-bank-account"}]},{"group":"Recipients","pages":[{"title":"Create Counterparty Recipient","openapi":"v2/api-reference/openapi.json POST /v2/counterparty_recipients","href":"/v2/api-reference/banking-api/counterparties/recipients/create-counterparty-recipient"},{"title":"Show Counterparty Recipient","openapi":"v2/api-reference/openapi.json GET /v2/counterparty_recipients/{id}","href":"/v2/api-reference/banking-api/counterparties/recipients/get-counterparty-recipient"},{"title":"List Counterparty Recipients","openapi":"v2/api-reference/openapi.json GET /v2/counterparties/{counterparty_id}/recipients","href":"/v2/api-reference/banking-api/counterparties/recipients/list-counterparty-recipients"}]}]},{"group":"Bank Accounts","pages":[{"title":"List Bank Accounts","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts","href":"/v2/api-reference/banking-api/bank-accounts/list-bank-accounts"},{"title":"Get Bank Account","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}","href":"/v2/api-reference/banking-api/bank-accounts/get-bank-account"},{"title":"Create Bank Account","openapi":"v2/api-reference/openapi.json POST /v2/bank_accounts","href":"/v2/api-reference/banking-api/bank-accounts/create-bank-account"},{"title":"Update Bank Account Parameters","openapi":"v2/api-reference/openapi.json PUT /v2/bank_accounts/{id}","href":"/v2/api-reference/banking-api/bank-accounts/update-bank-account"},{"group":"Transactions","pages":[{"title":"List Bank Account Transactions","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/transactions","href":"/v2/api-reference/banking-api/bank-accounts/transactions/list-bank-account-transactions"}]},{"group":"Balances","pages":[{"title":"Get Bank Account Balances","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/balances","href":"/v2/api-reference/banking-api/bank-accounts/balances/get-bank-account-balances"}]},{"group":"Metrics","pages":[{"title":"Get Bank Account Metrics","openapi":"v2/api-reference/openapi.json GET /v2/bank_accounts/{id}/metrics","href":"/v2/api-reference/banking-api/bank-accounts/metrics/get-bank-account-metrics"}]}]},{"group":"Pix Keys","pages":[{"title":"List Pix keys","openapi":"v2/api-reference/openapi.json GET /v2/pix/keys","href":"/v2/api-reference/banking-api/receivables/pix-keys/list-pix-keys"},{"title":"Create Pix key","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys","href":"/v2/api-reference/banking-api/receivables/pix-keys/create-pix-key"},{"title":"Get Pix key","openapi":"v2/api-reference/openapi.json GET /v2/pix/keys/{id}","href":"/v2/api-reference/banking-api/receivables/pix-keys/get-pix-key"},{"title":"Confirm Pix key","openapi":"v2/api-reference/openapi.json PUT /v2/pix/keys/{id}/confirm","href":"/v2/api-reference/banking-api/receivables/pix-keys/confirm-pix-key"},{"title":"Resend Pix key confirmation token","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys/{id}/resend_token","href":"/v2/api-reference/banking-api/receivables/pix-keys/resend-pix-key-token"},{"title":"Cancel Pix key","openapi":"v2/api-reference/openapi.json POST /v2/pix/keys/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/pix-keys/cancel-pix-key"}]},{"group":"Receivables","pages":[{"group":"Boleto","pages":[{"title":"Create boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos","href":"/v2/api-reference/banking-api/receivables/boletos/post"},{"title":"List boletos","openapi":"v2/api-reference/openapi.json GET /v2/in/boletos","href":"/v2/api-reference/banking-api/receivables/boletos/list"},{"title":"Get boleto","openapi":"v2/api-reference/openapi.json GET /v2/in/boletos/{id}","href":"/v2/api-reference/banking-api/receivables/boletos/get"},{"title":"Update boleto due date","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}","href":"/v2/api-reference/banking-api/receivables/boletos/update"},{"title":"Cancel boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/boletos/cancel"},{"title":"Recreate boleto","openapi":"v2/api-reference/openapi.json POST /v2/in/boletos/{id}/recreate","href":"/v2/api-reference/banking-api/receivables/boletos/recreate"},{"title":"Add protest","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}/protest/add","href":"/v2/api-reference/banking-api/receivables/boletos/add-protest"},{"title":"Remove protest","openapi":"v2/api-reference/openapi.json PUT /v2/in/boletos/{id}/protest/remove","href":"/v2/api-reference/banking-api/receivables/boletos/remove-protest"}]},{"group":"Pix","pages":[{"group":"Static QR Code","pages":[{"title":"Create static QR code","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes/static","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/post"},{"title":"Get static QR code","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get"},{"title":"Get static QR code image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get-image"},{"title":"Get static QR code hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/static/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-static/get-hash"}]},{"group":"Dynamic QR Code","pages":[{"title":"Create dynamic QR code","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/post"},{"title":"Get dynamic QR code","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get"},{"title":"Update dynamic QR code","openapi":"v2/api-reference/openapi.json PUT /v2/in/pix/qrcodes/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/update"},{"title":"Get dynamic QR code image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get-image"},{"title":"Get dynamic QR code hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-dynamic/get-hash"}]},{"group":"Dynamic QR Code with Due Date","pages":[{"title":"Create dynamic QR code with due date","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/qrcodes/with_due","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/post"},{"title":"Get dynamic QR code with due date","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get"},{"title":"Get dynamic QR code with due date image","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}/image","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get-image"},{"title":"Get dynamic QR code with due date hash","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/qrcodes/with_due/{id}/hash","href":"/v2/api-reference/banking-api/receivables/pix/qrcode-with-due/get-hash"}]},{"group":"Refund","pages":[{"title":"Refund Pix","openapi":"v2/api-reference/openapi.json POST /v2/documents/in/{id}/refund","href":"/v2/api-reference/banking-api/receivables/pix/refunds/post"}]}]},{"group":"Recurrences","pages":[{"title":"List Recurrences","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/list-recurrences"},{"title":"Generate a Recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences","href":"/v2/api-reference/banking-api/receivables/recurrences/generate-recurrence"},{"title":"Get Recurrence","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-recurrence"},{"title":"Cancel Recurrence","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/recurrences/cancel-recurrence"},{"title":"List Recurrence Collections","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections","href":"/v2/api-reference/banking-api/receivables/recurrences/list-recurrence-collections"},{"title":"Get Collection","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-collection"},{"title":"Update Collection","openapi":"v2/api-reference/openapi.json PUT /v2/in/pix/recurrences/collections/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/update-collection"},{"title":"Cancel Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/{id}/cancel","href":"/v2/api-reference/banking-api/receivables/recurrences/cancel-collection"},{"title":"Schedule Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/{id}/schedule","href":"/v2/api-reference/banking-api/receivables/recurrences/schedule-collection"},{"title":"Create Next Collection","openapi":"v2/api-reference/openapi.json POST /v2/in/pix/recurrences/collections/next","href":"/v2/api-reference/banking-api/receivables/recurrences/create-next-collection"},{"title":"List Collection Attempts","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/attempts","href":"/v2/api-reference/banking-api/receivables/recurrences/list-collection-attempts"},{"title":"Get Collection Attempt","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/collections/attempts/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-collection-attempt"},{"title":"Get Recurrence Request","openapi":"v2/api-reference/openapi.json GET /v2/in/pix/recurrences/requests/{id}","href":"/v2/api-reference/banking-api/receivables/recurrences/get-recurrence-request"}]}]},{"group":"Payments","pages":[{"group":"Pix","pages":[{"group":"Transfer","pages":[{"title":"Check Pix Key","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/keys/check","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/check-key"},{"title":"Get Pix Key Check","openapi":"v2/api-reference/openapi.json GET /v2/out/pix/keys/{id}","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/get-key-check"},{"title":"Generate a Pix Payment","openapi":"v2/api-reference/openapi.json POST /v2/out/pix","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/generate-pix-payment"},{"title":"Generate a Pix Payment (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/async","href":"/v2/api-reference/banking-api/payments/pix/transfer-pix/generate-pix-payment-async"}]},{"group":"QR Code","pages":[{"title":"Check Pix BR Code","openapi":"v2/api-reference/openapi.json POST /v2/out/pix/brcodes/check","href":"/v2/api-reference/banking-api/payments/pix/brcode/check-brcode"},{"title":"Get Pix BR Code Check","openapi":"v2/api-reference/openapi.json GET /v2/out/pix/brcodes/{id}","href":"/v2/api-reference/banking-api/payments/pix/brcode/get-brcode-check"},{"title":"Generate a Pix Payment (BR Code)","openapi":"v2/api-reference/openapi.json POST /v2/out/pix","href":"/v2/api-reference/banking-api/payments/pix/brcode/generate-pix-payment-brcode"}]}]},{"group":"Boleto","pages":[{"title":"Check boleto","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto/check","href":"/v2/api-reference/banking-api/payments/boleto/check-boleto"},{"title":"Pay boleto","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto","href":"/v2/api-reference/banking-api/payments/boleto/pay-boleto"},{"title":"Pay boleto (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/boleto/async","href":"/v2/api-reference/banking-api/payments/boleto/pay-boleto-async"}]},{"group":"Utility","pages":[{"title":"Check Utility","openapi":"v2/api-reference/openapi.json POST /v2/out/utility/check","href":"/v2/api-reference/banking-api/payments/utility/check-utility"},{"title":"Pay Utility","openapi":"v2/api-reference/openapi.json POST /v2/out/utility","href":"/v2/api-reference/banking-api/payments/utility/pay-utility"},{"title":"Pay Utility (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/utility/async","href":"/v2/api-reference/banking-api/payments/utility/pay-utility-async"}]},{"group":"Tax (ISS, DAS)","pages":[{"title":"Check Tax","openapi":"v2/api-reference/openapi.json POST /v2/out/tax/check","href":"/v2/api-reference/banking-api/payments/tax/check-tax"},{"title":"Pay Tax","openapi":"v2/api-reference/openapi.json POST /v2/out/tax","href":"/v2/api-reference/banking-api/payments/tax/pay-tax"},{"title":"Pay Tax (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/tax/async","href":"/v2/api-reference/banking-api/payments/tax/pay-tax-async"}]},{"group":"Darf (manual)","pages":[{"title":"Check DARF","openapi":"v2/api-reference/openapi.json POST /v2/out/darf/check","href":"/v2/api-reference/banking-api/payments/darf/check-darf"},{"title":"Pay DARF","openapi":"v2/api-reference/openapi.json POST /v2/out/darf","href":"/v2/api-reference/banking-api/payments/darf/pay-darf"},{"title":"Pay DARF (async)","openapi":"v2/api-reference/openapi.json POST /v2/out/darf/async","href":"/v2/api-reference/banking-api/payments/darf/pay-darf-async"}]}]},{"group":"Transfers","pages":[{"title":"Transfer","openapi":"v2/api-reference/openapi.json POST /v2/transfer","href":"/v2/api-reference/banking-api/transfers/transfer"}]},{"group":"Documents","pages":[{"group":"Receivables","pages":[{"title":"List Receivables","openapi":"v2/api-reference/openapi.json GET /v2/documents/in","href":"/v2/api-reference/banking-api/documents/receivables/list-receivables"},{"title":"Get Receivable","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/{id}","href":"/v2/api-reference/banking-api/documents/receivables/get-receivable"},{"title":"Search Receivables","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/search","href":"/v2/api-reference/banking-api/documents/receivables/search-receivables"}]},{"group":"Receivables - Refunds","pages":[{"title":"List Receivable Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds","href":"/v2/api-reference/banking-api/documents/receivables-refunds/list-receivable-refunds"},{"title":"Get Receivable Refund","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds/{id}","href":"/v2/api-reference/banking-api/documents/receivables-refunds/get-receivable-refund"},{"title":"Search Receivable Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/in/refunds/search","href":"/v2/api-reference/banking-api/documents/receivables-refunds/search-receivable-refunds"}]},{"group":"Payments","pages":[{"title":"List Payments","openapi":"v2/api-reference/openapi.json GET /v2/documents/out","href":"/v2/api-reference/banking-api/documents/payments/list-payments"},{"title":"Get Payment","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/{id}","href":"/v2/api-reference/banking-api/documents/payments/get-payment"},{"title":"Search Payments","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/search","href":"/v2/api-reference/banking-api/documents/payments/search-payments"}]},{"group":"Payments - Refunds","pages":[{"title":"List Payment Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds","href":"/v2/api-reference/banking-api/documents/payments-refunds/list-payment-refunds"},{"title":"Get Payment Refund","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds/{id}","href":"/v2/api-reference/banking-api/documents/payments-refunds/get-payment-refund"},{"title":"Search Payment Refunds","openapi":"v2/api-reference/openapi.json GET /v2/documents/out/refunds/search","href":"/v2/api-reference/banking-api/documents/payments-refunds/search-payment-refunds"}]},{"group":"Transfers","pages":[{"title":"List Transfers","openapi":"v2/api-reference/openapi.json GET /v2/documents/transfer","href":"/v2/api-reference/banking-api/documents/transfers/list-transfers"},{"title":"Get Transfer","openapi":"v2/api-reference/openapi.json GET /v2/documents/transfer/{id}","href":"/v2/api-reference/banking-api/documents/transfers/get-transfer"}]}]},{"group":"Cards","pages":[{"title":"Create Card","openapi":"v2/api-reference/openapi.json POST /v2/cards","href":"/v2/api-reference/banking-api/cards/create-card"},{"title":"List Cards","openapi":"v2/api-reference/openapi.json GET /v2/cards","href":"/v2/api-reference/banking-api/cards/list-cards"},{"title":"Get Card","openapi":"v2/api-reference/openapi.json GET /v2/cards/{id}","href":"/v2/api-reference/banking-api/cards/get-card"},{"title":"Update Card","openapi":"v2/api-reference/openapi.json PUT /v2/cards/{id}","href":"/v2/api-reference/banking-api/cards/update-card"},{"title":"Block Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/block","href":"/v2/api-reference/banking-api/cards/block-card"},{"title":"Unblock Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/unblock","href":"/v2/api-reference/banking-api/cards/unblock-card"},{"title":"Cancel Card","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/cancel","href":"/v2/api-reference/banking-api/cards/cancel-card"},{"title":"Get Card Details","openapi":"v2/api-reference/openapi.json GET /v2/cards/{id}/info","href":"/v2/api-reference/banking-api/cards/get-card-details"},{"title":"Top Up Card Balance","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/topup","href":"/v2/api-reference/banking-api/cards/top-up-card-balance"},{"title":"Generate Card Top Up QR Code","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/topup/qrcode","href":"/v2/api-reference/banking-api/cards/generate-card-top-up-qrcode"},{"title":"Transfer Card Balance","openapi":"v2/api-reference/openapi.json POST /v2/cards/{id}/transfer_balance","href":"/v2/api-reference/banking-api/cards/transfer-card-balance"},{"title":"List Card Invoices","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices","href":"/v2/api-reference/banking-api/cards/list-card-invoices"},{"title":"Get Card Current Invoice","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/current","href":"/v2/api-reference/banking-api/cards/get-card-current-invoice"},{"title":"List Card Invoice Lines","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/{id}/lines","href":"/v2/api-reference/banking-api/cards/list-card-invoice-lines"},{"title":"Generate Card Invoice Statement CSV URL","openapi":"v2/api-reference/openapi.json GET /v2/cards/invoices/{id}/export","href":"/v2/api-reference/banking-api/cards/generate-card-invoice-statement-csv-url"},{"title":"List Card Purchase Documents","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases","href":"/v2/api-reference/banking-api/cards/list-card-purchase-documents"},{"title":"Show Card Purchase Document by ID","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases/{id}","href":"/v2/api-reference/banking-api/cards/show-card-purchase-document-by-id"},{"title":"Show Card Purchase Document by End to End ID","openapi":"v2/api-reference/openapi.json GET /v2/cards/purchases/e2e/{id}","href":"/v2/api-reference/banking-api/cards/show-card-purchase-document-by-end-to-end-id"}]},{"group":"Pledged","pages":[{"title":"List Advance Requests","openapi":"v2/api-reference/openapi.json GET /v2/pledged/advance_requests","href":"/v2/api-reference/banking-api/pledged/list-advance-requests"},{"title":"Create Advance Request","openapi":"v2/api-reference/openapi.json POST /v2/pledged/advance_requests","href":"/v2/api-reference/banking-api/pledged/create-advance-request"},{"title":"Get Advance Request","openapi":"v2/api-reference/openapi.json GET /v2/pledged/advance_requests/{id}","href":"/v2/api-reference/banking-api/pledged/get-advance-request"},{"title":"Cancel Advance Request","description":"Cancel a pledged advance request","openapi":"v2/api-reference/openapi.json POST /v2/pledged/advance_requests/{id}/cancel","href":"/v2/api-reference/banking-api/pledged/cancel-advance-request"}]},{"group":"Institutions","pages":[{"title":"List institutions","openapi":"v2/api-reference/openapi.json GET /v2/institutions","href":"/v2/api-reference/banking-api/institutions/list"}]},{"group":"Developers","pages":[{"group":"Webhooks","pages":[{"title":"List Webhooks","description":"Lists every webhook of the org, in a single page: the list is not paginated","openapi":"v2/api-reference/openapi.json GET /v2/webhooks","href":"/v2/api-reference/banking-api/developers/webhooks/list-webhooks"},{"title":"Get Webhook","openapi":"v2/api-reference/openapi.json GET /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/get-webhook"},{"title":"Create Webhook","openapi":"v2/api-reference/openapi.json POST /v2/webhooks","href":"/v2/api-reference/banking-api/developers/webhooks/create-webhook"},{"title":"Delete Webhook","openapi":"v2/api-reference/openapi.json DELETE /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/delete-webhook"},{"title":"Replace Webhook","openapi":"v2/api-reference/openapi.json PUT /v2/webhooks/{webhook_id}","href":"/v2/api-reference/banking-api/developers/webhooks/replace-webhook"}]}]}]}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/v2/faq/frequently-asked-questions"}]}]},{"version":"V1","tag":"Legacy","pages":[{"title":"V1","href":"/api-reference/banking-api/institutions/list"}]}]},"title":"List institutions - Documentation","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}