{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"bd310db4-63e4-4ed0-a8ef-495affe9c2c6","name":"Emissor CCB","description":"# 📃 Seja muito bem vindo à documentação de Emissão CCB!\n\nPara começarmos é muito importante que você tenha em mãos os tokens de acesso à nossa API, eles são obrigatorios para que você possa se comunicar com a nossa API então caso não tenha os tokens entre em contato com [tecnologia@peakinvest.com.br](https://mailto:tecnologia@peakinvest.com.br) requisitando o acesso.\n\n> Com a posse dos tokens de acesso você esta oficalmente livre para se integrar com a Peak Tech! 🚀 🚀 \n \n\n## Sobre a documentação\n\nPensando em uma forma de simplificar a documentação para que seja de fácil entendimento que por consequencia diminua o tempo gasto para realizar a integração, nos tomamos as seguintes decisões:\n\n1. Separar a request em blocos, sendo que os mesmos podem de certa maneira serem interpretados como classes.\n \n2. Os endpoints foram numerados e ordenados na barra de navegação para que esteja conforme a ordem do fluxo (podem existir variações apos alguns \"steps\", porem esse seria o fluxo ideal).\n \n3. As reponses não foram divididas em blocos iguais as requests, pois boa parte dos dados mostratos nas request estaram nas responses.\n \n\n# 🤓 Sobre o Fluxo\n\n\n\n> ⚠️ Durante o onboard da API, vamos requisitar um endereço que será utilizado como webhook! Enquanto estiver em STG, fique a vontate para enviar um endereço [https://webhook.site/](https://webhook.site/) até se a familiarizar com o fluxo e iniciar sua integração. \n \n\nTodo fluxo para a geração da CCB até o sua finalização é executado via mensageria, do qual a cada passo você é notificado via Webhook.\n\nA seguir segue a ordem do fluxo do qual sairá a sua querida e mais esperada CCB:\n\n1. Emissão\n \n2. Geração do contrato\n \n3. Envio para Assinatura\n \n4. Desembolso\n \n\n> Os eventos Geração do contrato e Envio para Assinatura internamente ficam dentro do mesmo evento, porem por motivos didáticos vamos mantê-los separados. \n \n\n# 📨 Respostas padrão\n\n### API\n\nTodas respostas da API, possui um corpo padrão, tanto para casos de sucesso quanto para erros, sendo:\n\n| **Atributo** | **Descrição** | **Exemplo** |\n| --- | --- | --- |\n| **`success`** | Tipo: Boolean

\\- Indica se a requisição foi atendida com sucesso | true |\n| **`data`** | Tipo: Object

\\- Dados retornados pelo endpoint chamado | dynamic |\n| **`error_message`** | Tipo: String

\\- Mensagem que especifica o erro em questão | \"Contrato existente\" |\n| **`errors`** | Tipo: Object

\\- Lista de errors chave e valor sendo que chave =**`field`** e valor = **`message`** | dynamic |\n\n### Webhook\n\nTodos eventos do webhook, possui um corpo padrão, tanto para casos de sucesso quanto para erros, sendo:\n\n| **Atributo** | **Descrição** | **Exemplo** |\n| --- | --- | --- |\n| **data** | Tipo: Object

\\- Dados dinámicos (especificados na documentação na sessão webhook) | dynamic |\n| **`status`** | Tipo: Enum

Opções:

\\- `emissor`
\\- **`contrato-assinatura`**
\\- **`contrato-pendente`**
\\- | Emissor |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"21957067","team":651549,"collectionId":"bd310db4-63e4-4ed0-a8ef-495affe9c2c6","publishedId":"2sAYkAQ2Wu","public":true,"publicUrl":"https://docs.peaktech.com.br","privateUrl":"https://go.postman.co/documentation/21957067-bd310db4-63e4-4ed0-a8ef-495affe9c2c6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-04-02T19:08:09.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"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/db08bc028cabf6f59e824869430837dc21294ba3236eade0821c7675e7b62c8d","favicon":"https://peaktech.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"}],"canonicalUrl":"https://docs.peaktech.com.br/view/metadata/2sAYkAQ2Wu"}