{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9779cbf7-7d20-4357-934f-f877bbe4d8d1","name":"Canvi","description":"# Introdução\n\nBem-vindo à documentação oficial da **API Gateway da Canvi**.\n\nAqui você encontrará todas as informações necessárias para integrar sua plataforma às nossas soluções de pagamento — de forma rápida, segura e eficiente.\n\nCom a Canvi, você pode automatizar cobranças, acompanhar transações em tempo real, configurar repasses financeiros e muito mais. Nossa infraestrutura foi pensada para oferecer controle total sobre seus recebimentos, simplificando a gestão financeira do seu negócio.\n\n# Visão Geral\n\nA API da **Canvi** foi desenvolvida para proporcionar uma integração simples, segura e eficiente com o seu sistema, permitindo total controle sobre a gestão de pagamentos e operações financeiras de sua empresa. Confira abaixo as principais características que tornam nossa API uma escolha confiável para o seu negócio:\n\n**Padrão RestFul**\n\nNossa API segue os princípios REST, com uma estrutura clara, intuitiva e compatível com as tecnologias mais utilizadas no mercado. Facilitando a implementação e reduzindo o tempo de desenvolvimento da sua equipe.\n\n**Meios de Pagamento**\n\nOferecemos suporte aos **principais meios de pagamento do mercado**, incluindo:\n\n- **PIX** — dinâmico e estático.\n    \n- **Boletos bancários.**\n    \n- **Cartões de débito, crédito e voucher** — com suporte a diversas bandeiras nacionais e internacionais.\n    \n\nEssa flexibilidade permite que seu negócio atenda diferentes perfis de clientes e amplie as opções de cobrança de forma eficiente.\n\n**Ambiente Sandbox**\n\nAntes de entrar em produção, você pode utilizar nosso **ambiente Sandbox** para realizar testes e simulações com segurança. Isso permite validar integrações e fluxos de pagamento sem impacto sobre dados reais ou operações financeiras.\n\n**Webhooks**\n\nMantenha seu sistema sempre atualizado com **notificações em tempo real**.\n\nNossos webhooks informam automaticamente eventos importantes, como confirmações de pagamento, envio de saldo e atualizações de status nas cobranças.\n\n**Simulação de Pagamentos**\n\nPara facilitar o processo de desenvolvimento e homologação, oferecemos a funcionalidade de **simulação de pagamentos**, permitindo testar diferentes cenários de cobrança com agilidade — evitando a necessidade de transações financeiras reais.\n\n# Estrutura da Resposta\n\nTodas as requisições aos nossos endpoints retornam uma estrutura padrão de resposta, facilitando o tratamento de erros e respostas dentro da sua aplicação:\n\n``` json\n{\n    \"code\": \"string\",\n    \"mensagem\": \"string\",\n    \"data\": \"any\"\n}\n\n ```\n\n# Data e Hora\n\nTodos os registros de data e hora utilizados na API da **Canvi** seguem o **fuso horário oficial de Manaus (UTC-4)** e são formatados de acordo com o **padrão ISO 8601**.\n\nEx: `2025-05-20T14:30:00`\n\n# URLs Base\n\nSandbox: [https://gateway-homol.service-canvi.com.br<br>](https://gateway-homol.service-canvi.com.br/)Produção: Sob demanda.\n\n# Primeiros Passos\n\nAo integrar sua plataforma com a API Canvi, você terá acesso a um conjunto completo de **endpoints** para geração de cobranças, controle de repasses, gestão de usuários e muito mais.\n\nPara iniciar o processo de integração:\n\n1. Ainda não é cliente Canvi? faça seu pré-cadastro [a](https://www.canvi.com.br/seja-canvi)[qui](https://www.canvi.com.br/seja-canvi).\n    \n2. Nossa equipe entrará em contato para informar as credenciais de homologação.\n    \n3. Acesse o ambiente Sandbox e realize sua autenticação.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34606726","collectionId":"9779cbf7-7d20-4357-934f-f877bbe4d8d1","publishedId":"2sB34hFfDH","public":true,"publicUrl":"https://docs.canvi.com.br","privateUrl":"https://go.postman.co/documentation/34606726-9779cbf7-7d20-4357-934f-f877bbe4d8d1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"Documentação Canvi"}],"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":"2025-07-14T13:18:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Documentação Canvi","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/7dfa42999822c38c33cf8e6690ec2f72daabc7c2d0b983a2e41a2647966c6c2d","favicon":"https://res.cloudinary.com/postman/image/upload/v1752235717/team/bcbf45d9fc85270c03763b82ba8111bd.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.canvi.com.br/view/metadata/2sB34hFfDH"}