{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"61482d9b-fd4b-4042-b67f-b7aa44c3599f","name":"Carbon Business API","description":"## Welcome to our API Developer Documentation\n\nCarbon aims to unlock the full potential of your business with a feature-rich account designed for growth.\n\n## Integrations\n\nWe aim to provide our APIs for developers and businesses to offer financial services to their existing customer base through REST APIs without doing the heavy lifting. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.\n\n### Authentication\n\n`Authorization : API Key`\n\nHeader  \n`x-carbon-key : value`\n\n`x-carbon-key` can be generated via developer page on Carbon Business\n\n| Enviroment | URL |\n| --- | --- |\n| Live |  |\n| Sandbox | [https://carbonapistagingsecure.getcarbon.co/baas/api](https://carbonapistagingsecure.getcarbon.co/baas/api) |\n\n### **Handling Errors**\n\nWe use the conventional HTTP response codes to indicate the success or failure of an API request.  \nCodes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with our servers.\n\n| Error | Description |\n| --- | --- |\n| 400 - Bad Request | The request was unacceptable, often due to missing a required parameter. |\n| 401 - Unauthorized | Not a valid API key was provided. |\n| 402 - Request Failed | The parameters were valid but the request failed. |\n| 403 - Forbidden | The API key doesn't have permission to perform the request. |\n| 404 - Not Found | The requested resource doesn't exist. |\n| 429 - Too Many Requests | Too many requests hit the API |\n| 500, 502, 503, 504 - Server Errors | System Error |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33237778","collectionId":"61482d9b-fd4b-4042-b67f-b7aa44c3599f","publishedId":"2sA2rFRzKS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33237778/2sA2rFRzKS","privateUrl":"https://go.postman.co/documentation/33237778-61482d9b-fd4b-4042-b67f-b7aa44c3599f","customColor":{"top-bar":"13121a","right-sidebar":"303030","highlight":"BE3E6C"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/cbb97f8e-e05a-4c57-bfed-12e554ab0bb2/Q2FyYm9uIExvZ28uc3ZnLnBuZw==","colors":{"top-bar":"090b15","right-sidebar":"303030","highlight":"BE3E6C"}},{"name":"light","logo":"https://content.pstmn.io/357f97cd-0fd6-4aa8-a416-29cf099e95d4/Q2FyYm9uIEJ1c2luZXNzIERlc2lnbi5wbmc=","colors":{"top-bar":"13121a","right-sidebar":"303030","highlight":"BE3E6C"}}]}},"version":"8.10.1","publishDate":"2024-11-27T17:54:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/357f97cd-0fd6-4aa8-a416-29cf099e95d4/Q2FyYm9uIEJ1c2luZXNzIERlc2lnbi5wbmc=","logoDark":"https://content.pstmn.io/cbb97f8e-e05a-4c57-bfed-12e554ab0bb2/Q2FyYm9uIExvZ28uc3ZnLnBuZw=="}},"statusCode":200},"environments":[{"name":"Carbon Baas Sandbox","id":"935f9666-f2c0-4d57-9e4d-089ea842b965","owner":"33237778","values":[{"key":"BASE_URL","value":"https://carbonapistagingsecure.getcarbon.co/baas/api","enabled":true,"type":"default"},{"key":"access_token","value":"cb_eyJ1c2Vyc19pZCI6MiwiYWNjb3VudHNfaWQiOjIsInRpbWVzdGFtcCI6IjIwMjUtMDItMjBUMDg6NDc6MDQuMTQ3ODMxWiIsImFjdGlvbiI6InJlZ2VuZXJhdGUiLCJhcGlfa2V5IjoiZTRmNWUzZjA1YmUzYWM2NzdmMzEzNzljMzgwMmVkZmM1MmJjYjNiNDY1ZmNiMjQ1YTEyYmQ5MmU0NjY0Y2VmNCJ9","enabled":true,"type":"default"},{"key":"account_id","value":"","enabled":true,"type":"any"},{"key":"BAAS_PASSWORD","value":"baas-consumers","enabled":true},{"key":"MCP_SERVER_URL","value":"https://baas-mcp.getcarbon.co","enabled":true,"type":"default"},{"key":"MCP_SERVER_URL","value":"https://baas-mcp.getcarbon.co/","enabled":true,"type":"default"},{"key":"mcp-api-key","value":"baas-consumers","enabled":true,"type":"default"},{"key":"x-carbon-api-key","value":"cb_eyJ1c2Vyc19pZCI6MiwiYWNjb3VudHNfaWQiOjIsInRpbWVzdGFtcCI6IjIwMjUtMDItMjBUMDg6NDc6MDQuMTQ3ODMxWiIsImFjdGlvbiI6InJlZ2VuZXJhdGUiLCJhcGlfa2V5IjoiZTRmNWUzZjA1YmUzYWM2NzdmMzEzNzljMzgwMmVkZmM1MmJjYjNiNDY1ZmNiMjQ1YTEyYmQ5MmU0NjY0Y2VmNCJ9","enabled":true,"type":"default"},{"key":"x-carbon-api-key","value":"cb_eyJ1c2Vyc19pZCI6MiwiYWNjb3VudHNfaWQiOjIsInRpbWVzdGFtcCI6IjIwMjUtMDItMjBUMDg6NDc6MDQuMTQ3ODMxWiIsImFjdGlvbiI6InJlZ2VuZXJhdGUiLCJhcGlfa2V5IjoiZTRmNWUzZjA1YmUzYWM2NzdmMzEzNzljMzgwMmVkZmM1MmJjYjNiNDY1ZmNiMjQ1YTEyYmQ5MmU0NjY0Y2VmNCJ9","enabled":true,"type":"default"},{"key":"x-carbon-mode","value":"sandbox","enabled":true,"type":"default"},{"key":"mcp_access_token","value":"","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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"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":"Carbon Baas Sandbox","value":"33237778-935f9666-f2c0-4d57-9e4d-089ea842b965"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA2rFRzKS"}