{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"87d859e6-ca43-4bb6-9291-424af6544a6a","name":"Caas - Private-Credit - Implantação","description":"Bem vindo a versão _beta_ da documentação da API Private-Credit da Polígono Capital.\n\nA API é organizada no padrão REST, utiliza os padrões de autenticação da HTTP e o formato de JSONs para o envio de payloads e respostas.#\n\nEsta API permite manipular os dados de: Clientes, Fluxos de Recebíveis, Limites disponibilizados, Propostas, Contratações e Liquidações.\n\nAs seguintes funções que serão descritas nas próximas secções desse documento:\n\n**Clientes:**\n\n\\* Cadastro e exclusão de clientes pessoa física e jurídica  \n\\* Consulta e alteração de informações cadastrais de clientes\n\n**Operações:**\n\n\\* Cadastrar e cancelar operações para clientes\n\n**Fluxos:**\n\n\\* Cadastrar dados financiais de clientes\n\n**Limites:**\n\n\\* Verificar limites de crédito para clientes cadastrados  \n\\* Cadastrar limites de crédito para clientes cadastrados\n\n**Propostas:**\n\n\\* Realizar simulações de crédito para operações cadastradas  \n\\* Confirmar simulações de crédito para operações cadastradas\n\n**Documentos:**\n\n\\* Enviar documentos dos sócios\n\n**Contratos:**\n\n\\* Gerar contratos para uma operação  \n\\* Enviar contratos para assinatura  \n\\* Confirmar desembolsos de operações de crédito\n\n**Liquidação:**\n\n\\* Enviar liquidações para parcelas e contratos  \n\\* Gerar boletos de antecipação para parcelas e contratos  \n\\* Gerar boletos para pagamentos em atraso de parcelas e contratos  \n\\* Alterar a forma de pagamento de uma operação\n\n**Pós-Vendas:**\n\n\\* Consultar detalhes de uma contratação efetuada\n\n**Healthcheck:**\n\n\\* Consultar a disponibilidade dos serviços da plataforma\n\n**Callbacks:**\n\n\\* Orientações gerais de como receber notificações dos eventos da esteira offline da plataforma.\n\n---\n\n# Autenticação\n\nA API Private credit utiliza tokens de autorização para permitir o acesso. Para obter uma é necessário entrar em contato com o nosso time.\n\nToda request enviada deve conter tal token nos headers de sua requisição, se não tiver, será barrada por nosso sistema e um erro HTTP 401 será retornado.\n\n##### Authorization: seu_token\n\n\\* _Você deve substituir_ _**api_token_parceiro**_ _com sua API key que será gerada pelo time de implantação da Poligono Capital._\n\n---\n\n# Ambientes\n\n| Ambiente | Base_url | Validade da operação |\n| --- | --- | --- |\n| Produção | [https://private-credit.poligonocapital.io](https://private-credit.poligonocapital.io) | Sim |\n| Sandbox | [https://private-credit.sandbox.poligonocapital.io](https://private-credit.sandbox.poligonocapital.io) | Não |\n\n---\n\n# Glossário\n\nTermos que serão vistos com frequência nesta documentação:\n\n\\* ecid: Identificador único que representa um usuário cadastrado na plataforma;  \n\\* operation_id: Identificador da operação de crédito de um usuário.\n\n_Cada usuário cadastrado pode ter mais de uma operação de crédito registrada na plataforma._","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"30976765","team":5765701,"collectionId":"87d859e6-ca43-4bb6-9291-424af6544a6a","publishedId":"2s9YXfcPWp","public":true,"publicUrl":"https://getpostman.poligonocapital.io","privateUrl":"https://go.postman.co/documentation/30976765-87d859e6-ca43-4bb6-9291-424af6544a6a","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":"https://content.pstmn.io/4bcf0304-8022-4136-90eb-edf41f609b8f/TUFSQ0EgRCdBR1VBIC0gUE9Mw41HT05PIENBUElUQUwucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/f5b43c35-80a3-41d2-bc7d-455723bb3d40/TUFSQ0EgRCdBR1VBIDIgLSBQT0zDjUdPTk8gQ0FQSVRBTC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.6","publishDate":"2023-11-08T12:09:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/f5b43c35-80a3-41d2-bc7d-455723bb3d40/TUFSQ0EgRCdBR1VBIDIgLSBQT0zDjUdPTk8gQ0FQSVRBTC5wbmc=","logoDark":"https://content.pstmn.io/4bcf0304-8022-4136-90eb-edf41f609b8f/TUFSQ0EgRCdBR1VBIC0gUE9Mw41HT05PIENBUElUQUwucG5n"}},"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/6f3dfa729ed48419195b3461099527cf7e01e2bc502a48f50baf90a276702f9e","favicon":"https://poligonocapital.io/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://getpostman.poligonocapital.io/view/metadata/2s9YXfcPWp"}