{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4f849c07-83aa-4529-9f9a-ab66337830dc","name":"Partners API - v1.0.11","description":"\"Contbank\"\n\n# Quem Somos\n\nSomos o primeiro banco digital especialista em crédito e serviços financeiros para empresas com atendimento feito por contadores de todo o país.\n\nCrie soluções inteligentes com nossas APIs de integração.\n\n# Fale Conosco\n\nPara saber mais, nos visite em: [https://www.contbank.com](https://www.contbank.com)\n\nPara maiores informações ou dúvidas: [api@contbank.com](https://mailto:api@contbank.com)\n\n# Como Utilizar\n\nEsta documentação ajudará você a integrar o seu sistema aos serviços do Contbank via API, mas para integrar ao nosso sistema bancário, é necessário que você possua uma credencial de acesso, a qual deve ser solicitada previamente ao Time do Contbank.\n\nA credencial identifica seu usuário e seu contrato com o Contbank. Mantenha essas informações protegidas, mesmo quando forem apenas credenciais de teste.\n\n## Passo a Passo : Análise e Obtenção da Credencial de Acesso\n\n#### 1) Solicitação\n\nPor gentileza, encaminhe os dados abaixo para [api@contbank.com](https://mailto:api@contbank.com)\n\nBasicamente, para darmos início ao processo de análise e criação das suas credenciais de acesso, precisaremos das seguintes informações:\n\n- CNPJ da sua Empresa.\n- Dados do responsável técnico : nome completo, e-mail e telefone.\n- Informações sobre as APIs que você deseja integrar: Extrato, Cobrança, entre outros.\n \n\n#### 2) Análise e permissionamento\n\nApós o envio acima, nosso Time analisará as informações e entrará em contato pelo telefone ou e-mail indicados.\n\nNesta etapa, entenderemos melhor sua necessidade e nosso time de engenharia dará prosseguimento nas permissões necessárias.\n\n#### 3) Disponibilização das credenciais de acesso\n\nNeste momento iremos encaminhar suas credencias de acesso para utilizar em nossos ambientes de teste (sandbox) e de produção \nVocê receberá as suas credenciais no e-mail informado na etapa de solicitação (Etapa 1).\n\n# Ambientes\n\nPossuímos 2 (dois) ambientes disponíveis.\n\n| **Ambiente/Environment** | **Descrição** | **URL** |\n| --- | --- | --- |\n| SANDBOX | Ambiente destinado a testes e validações | [http://api.contbank.com.br/](http://api.contbank.com.br/) |\n| PRODUCTION | Ambiente de produção | [https://api.contbank.com/](https://api.contbank.com/) |\n\n# Funcionalidades Disponíveis\n\nFique ligado! Estamos constantemente evoluindo nossa documentação no intuito de facilitar seu entendimento e possibilitar inovar em seu produto.\n\nAté o momento, temos as seguintes funcionalidades disponíveis via API:\n\n| **Funcionalidade** | **API** | **Ambientes Disponíveis** |\n| --- | --- | --- |\n| \\- Geração de token de acesso | Authentication | Produção e Sandbox |\n| \\- Consulta de contas permissionadas | Authorization | Produção e Sandbox |\n| \\- Consulta de dados bancários | Accounts | Produção e Sandbox |\n| \\- Consulta de extrato bancário | Bank Statements | Produção e Sandbox |\n| \\- Emissão de cobranças via BolePIX ou apenas via PIX | Billings | Produção e Sandbox |\n| \\- Cancelamento de cobranças | Billings | Produção e Sandbox |\n| \\- Consulta de cobranças emitidas | Billings | Produção e Sandbox |\n| \\- Simulação de pagamentos de cobranças | Billings | Apenas em Sandbox, para testes e homologação. |\n| \\- Webhook de cobranças | Webhooks | Produção e Sandbox |\n\n# Perfis de Credenciais de Acesso\n\nExistem dois perfis de credenciais disponíveis para autenticação na API: **Parceiro** e **Parceiro Agente de Negócio**.\n\n### Parceiro\n\nO perfil de Parceiro permite que os parceiros se autentiquem usando seu próprio `client_id` e `secret`. Ao fazer uma autenticação, é necessário incluir essas informações no payload da requisição da seguinte maneira:\n\n- `client_id:`\n- `client_secret:`\n \n\n### Parceiro Agente de Negócio\n\nO perfil de Parceiro Agente de Negócio permite que o parceiro faça autenticação usando as credenciais do Agente de Negócio. O Agente de Negócio fornecerá ao parceiro o `client_id` e `secret` do agente. Ao fazer uma autenticação, o parceiro deve incluir as seguintes informações no payload da requisição:\n\n- `client_id:`\n- `client_secret:`\n \n\nNo header da requisição deve informar a seguinte chave:\n\n- `X-Partner-Id:`\n \n\nCertifique-se de incluir esses cabeçalhos corretamente em suas solicitações para autenticar como Parceiro ou Parceiro Agente de Negócio.\n\n# Token SMS - Fluxo de Onboarding em Sandbox\n\nNosso fluxo de onboarding exige que o cliente valide o número de celular via SMS.\n\nPara o ambiente de **Sandbox** nós **não disparamos o SMS**, sendo o **token fixo em 123456**.\n\nPortanto, caso você deseje abrir uma conta de teste no nosso ambiente de Sandbox, ao ser solicitado o token SMS, informe o valor acima.\n\nNo ambiente de **Produção** você ou seus clientes irão receber o SMS normalmente no número informado.\n\nVale indicar que o número do celular é único por usuário e contas PF, não podendo ser reutilizado em vários cadastros. A mesma regra também se aplica ao CPF e e-mail pessoal do contato.\n\n# Últimas Atualizações\n\nCom o intuito de darmos visibilidade às implementações recentes, divulgamos abaixo um resumo das últimas atualizações na nossa documentação :\n\n| **Data da Atualização** | **Descrição da Alteração** |\n| --- | --- |\n| 15/04/2024 | Billings : Liberada a possibilidade de se efetuar cobranças apenas via PIX nos ambientes de Sandbox e de Produção. Foi incluída na documentação um exemplo de acionamento. |\n| 16/04/2024 | Billings : Atualizado o exemplo cURL de criação do billing_method BOLETO. |\n| 29/04/2024 | Billings : Atualizado o payload, incluindo o is_pix_qrcode_file_required que permite indicar quando o QRCode em formato PNG é necessário no response.

Incluído no response a indicação dos campos billing_method_related.pix_encoded_file e billing_method_related.pix_copy_paste. |\n| 11/05/2024 | Bank Statements : Indicado o endpoint da v1 como depreciada.

Incluída a chamada do extrato v2 e exemplo de sucesso da chamada.

Adicionada maiores explicações sobre alguns campos do response da API de extrato. |\n| 12/05/2024 | Balance : Disponibilizada API de consulta de saldos atuais. |\n| 22/05/2024 | Billings : Alterado o endpoint de Get do PDF.

Versão anterior do endpoint foi indicada como depreciada. |\n\n# APIs","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"24543234","team":4332138,"collectionId":"4f849c07-83aa-4529-9f9a-ab66337830dc","publishedId":"2s8YsnWw4N","public":true,"publicUrl":"https://developers.contbank.com","privateUrl":"https://go.postman.co/documentation/24543234-4f849c07-83aa-4529-9f9a-ab66337830dc","customColor":{"top-bar":"FFE03D","right-sidebar":"1E2124","highlight":"f0c100"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.1","publishDate":"2022-11-23T06:11:00.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"SANDBOX","id":"32103925-2613-4f95-ac2c-6c51506ae392","owner":"24543234","values":[{"key":"url_contbank","value":"api.contbank.com.br","enabled":true,"type":"default"},{"key":"partner_token","value":"","enabled":true,"type":"secret"},{"key":"account_id","value":"","enabled":true,"type":"default"},{"key":"billing_id","value":"","enabled":true,"type":"default"},{"key":"branch_number","value":"0001","enabled":true},{"key":"account_number","value":"99999999","enabled":true}],"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/bded39280c5daccb9bf831ff83e8839b567cb5bb1a0460568b4297f7f9204c1e","favicon":"https://res.cloudinary.com/postman/image/upload/v1669184957/team/jwx7ls259516cr3gq95n.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":"SANDBOX","value":"24543234-32103925-2613-4f95-ac2c-6c51506ae392"}],"canonicalUrl":"https://developers.contbank.com/view/metadata/2s8YsnWw4N"}