{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"33715226-b5c9-4b51-ab8c-5d0a84b888ee","name":"Integradores BRZ","description":"Esta documentação tem como objetivo fornecer informações abrangentes sobre a implementação e utilização dos produtos bancários da BRX Bank, permitindo que desenvolvedores, instituições financeiras e empresas integrem esse sistema em suas aplicações e serviços.\n\n# Princípios básicos\n\n## Retorno padrão\n\nPensando na facilidade de integração com as APIs da BRX Bank, todos os retornos da requisição possuem um retorno padrão, exceto a API de geração de token de acesso.\n\n#### Exemplo de retorno bem-sucedido\n\n``` json\n{\n  \"StatusCode\": 200,\n  \"Title\": \"Success\",\n  \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.3.1\",\n  \"Extensions\": {\n    \"Message\": \"Consulta realizada com sucesso\",\n    \"Data\" : \"object\"\n  }\n}\n\n ```\n\n**`StatusCode`**: indica o código de status HTTP da resposta. No exemplo, é \"200\", o que indica que a solicitação foi bem-sucedida.\n\n**`Title`**: fornece uma descrição textual do status da resposta. No exemplo, é \"Success\", indicando que a operação foi realizada com êxito.\n\n**`Type`**: fornece um link para uma especificação ou documentação que descreve o tipo de resposta. No exemplo, é uma referência à seção 6.3.1 da RFC 7231, que é a especificação para códigos de status HTTP.\n\n**`Extensions`**: inclui informações adicionais na resposta. No exemplo, há um atributo `message` que exibe a mensagem indicando que a requisição foi bem sucedida e também o atributo `data` associada a um objeto, que seria a carga útil da resposta, contendo os dados relevantes para a operação realizada.\n\n#### Exemplo de retorno malsucedido\n\n``` json\n{\n  \"StatusCode\": 400,\n  \"Title\": \"Bad Request\",\n  \"Type\" : \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n  \"Extensions\": {\n    \"errors\" : [\n      \"O campo 'Name' não pode ser vazio\" ,\n      \"O campo 'Age' não pode ser menos que 18 anos\"\n    ]\n  }\n}\n\n ```\n\n**`Extensions`**: no exemplo, há uma chave chamada \"errors\" associada a uma lista de mensagens de erro. Essas mensagens de erro fornecem detalhes específicos sobre o motivo pelo qual a solicitação foi considerada como requisição inválida.\n\n## Ambientes\n\nO ambiente refere-se ao local em que o software será operado.\n\n| Ambiente | **URL** |\n| --- | --- |\n| Produção | [https://](https://dev.mtbank.com.br/)[apisbank.brxbank.com.br](https://apisbank.brxbank.com.br) |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"36274419","team":6277328,"collectionId":"33715226-b5c9-4b51-ab8c-5d0a84b888ee","publishedId":"2sB3QKrVWE","public":true,"publicUrl":"https://integrator-docs.brxbank.com.br","privateUrl":"https://go.postman.co/documentation/36274419-33715226-b5c9-4b51-ab8c-5d0a84b888ee","customColor":{"top-bar":"FFFFFF","right-sidebar":"F5F1EB","highlight":"0267FD"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ed9ee09f-800f-43b7-8a01-530210118f0d/Mi0gTG9nbyBWMSAtIG5lZy5wbmc=","colors":{"top-bar":"303030","right-sidebar":"303030","highlight":"0267FD"}},{"name":"light","logo":"https://content.pstmn.io/ed9ee09f-800f-43b7-8a01-530210118f0d/Mi0gTG9nbyBWMSAtIG5lZy5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"F5F1EB","highlight":"0267FD"}}]}},"version":"8.10.0","publishDate":"2025-10-13T13:41:14.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/ed9ee09f-800f-43b7-8a01-530210118f0d/Mi0gTG9nbyBWMSAtIG5lZy5wbmc=","logoDark":"https://content.pstmn.io/ed9ee09f-800f-43b7-8a01-530210118f0d/Mi0gTG9nbyBWMSAtIG5lZy5wbmc="}},"statusCode":200},"environments":[{"name":"Production","id":"6737a823-fadc-4f00-aff3-9f9e05b48f56","owner":"36274419","values":[{"key":"api-url","value":"https://apisbank.brxbank.com.br","enabled":true,"type":"default"},{"key":"auth-url","value":"https://token.brxbank.com.br/oauth2","enabled":true,"type":"default"},{"key":"webhook-url","value":"{url-integrador}","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7c163b8d36a4b84e568230b47768e4a58f449806394e5424e779bdde234df663","favicon":"https://brxbank.com.br/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"36274419-6737a823-fadc-4f00-aff3-9f9e05b48f56"}],"canonicalUrl":"https://integrator-docs.brxbank.com.br/view/metadata/2sB3QKrVWE"}