{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4f8adb1c-f3b9-4964-b1db-3de0a47ca32f","name":"BeMonest","description":"# Seja bem-vindo à MonestAPI!\n\nA Monest é uma plataforma de cobranças digital que além de utilizar estratégias inteligentes para cobrar seus devedores, também possuí uma forma de comunicação personalizada através de vários canais de comunicação.\n\n# Autenticação\n\nPara usar todas rotas disponíveis em nossa API, você vai precisar de duas chaves numéricas. São elas a `APP_KEY` e a `APP_SECRET`.\n\n**Obs.:** as duas chaves podem ser solicitadas diretamente com seu contato dentro da Monest.\n\n**APP_KEY e APP_SECRET**:\n\nEssas chaves são extremamente importantes para o nosso sistema, pois elas funcionam em conjunto como uma forma de autenticação intransferível para a sua empresa (company). Elas são obrigatórias para que a sua aplicação consiga enviar requisições para nossa API.\n\n_É extremamente importante que você mantenha essas chaves em segurança_.\n\nExemplo de API_KEY: `monest_62782394-f3ee-4a06-bb30-d2fc8733110d`  \nExemplo de API_SECRET: `monest_a7112f32-75ec-4ef4-b711-bf926db72e43`\n\n## Autorização - Basic Auth\n\nUtilizamos BasicAuth como meio de autenticação para nossa API. Dessa forma, todas as requisições para endpoints autenticados precisam enviar o header Authorization com o valor das suas chaves (API_KEY, API_SECRET) criptografadas:\n\n**Ex:** `Authorization: Basic bWFzdGVyOjEyMzQ1Ng==`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1233808","team":26508,"collectionId":"4f8adb1c-f3b9-4964-b1db-3de0a47ca32f","publishedId":"T17CEqcE","public":true,"publicUrl":"https://docs.api.monest.com.br","privateUrl":"https://go.postman.co/documentation/1233808-4f8adb1c-f3b9-4964-b1db-3de0a47ca32f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentação da API para integrações da Monest."},{"name":"title","value":"Docs - BeMonest "}],"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":"EF5B25"}}]}},"version":"8.10.0","publishDate":"2025-04-08T14:25:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Docs - BeMonest ","description":"Documentação da API para integrações da Monest."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"production","id":"0459ab98-b652-48aa-9e93-7ff983319ac3","owner":"1233808","values":[{"key":"host","value":"https://api.monest.com.br","enabled":true},{"key":"token","value":"","enabled":true},{"key":"app_key","value":"","enabled":true,"type":"default"},{"key":"app_secret","value":"","enabled":true},{"key":"apiToken","value":"","enabled":true,"type":"any"},{"key":"apiURL","value":"https://apiv2.monest.com.br/api","enabled":true,"type":"default"},{"key":"pagarmeURL","value":"https://api.pagar.me/1","enabled":true,"type":"default"},{"key":"pagarmeToken","value":"ak_live_TSknLuibFTw9uSNqqjbR4n2lnLJlpz","enabled":true,"type":"default"},{"key":"pontalTechUrl","value":"https://sms-api-pointer.pontaltech.com.br/v1","enabled":true,"type":"default"},{"key":"pontalTechToken","value":"bW9uZXN0cHJlbWl1bTpBQk9jQ3FESmVt","enabled":true,"type":"default"},{"key":"shortIOUrl","value":"https://api.short.io","enabled":true,"type":"default"},{"key":"shortIOToken","value":"sk_uUW7lS9apT9c9CfR","enabled":true,"type":"default"},{"key":"iuguURL","value":"https://api.iugu.com/v1","enabled":true,"type":"default"},{"key":"iuguToken","value":"6CADCEDF426C2CF7A2AF14C9A7DC1EEEA0156ABE8C81EAE576BC7D87C1FBB334","enabled":true,"type":"default"},{"key":"currentDate","value":"","enabled":true,"type":"any"},{"key":"hostV2","value":"https://apiv2.monest.com.br/api","enabled":true,"type":"default"},{"key":"BASEURL","value":"http://plugboleto.com.br/api/v1","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/b854021fd89dd613cf6d07f21d63bb45d535d0682788325be8fdb2e6cd264bfe","favicon":"https://monest.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":"1233808-0459ab98-b652-48aa-9e93-7ff983319ac3"}],"canonicalUrl":"https://docs.api.monest.com.br/view/metadata/T17CEqcE"}