{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4dd3517c-0a62-48b1-aa8f-df462679992d","name":"Gateway SimpBank | API Pública","description":"# Gateway SimpBank | API Pública\n\nAPI de produção para integradores criarem cobranças PIX (cash-in), solicitarem pagamentos PIX ou boleto (cash-out) e acompanharem o processamento financeiro.\n\n## Ambiente\n\n| Ambiente | Base URL |\n| --- | --- |\n| Produção | https://api.simpbank.com.br |\n\nEsta collection opera somente em produção. Não existe sandbox público. As credenciais e o estabelecimento autorizado são entregues separadamente pela SimpBank.\n\n> **Atenção:** as operações desta collection movimentam dados financeiros reais. O environment público não contém credenciais, identificadores, valores nem favorecidos. Preencha cada variável conscientemente antes de enviar uma requisição.\n\n## Início rápido\n\n1. Importe esta collection e o arquivo gateway_postman_environment_prod.json.\n2. Selecione o environment **Gateway SimpBank | Produção Pública**.\n3. Preencha cpfCnpj, password e estabelecimentoId com os dados recebidos da SimpBank.\n4. Execute **1. Autenticação / Login**. O script salva o JWT automaticamente em jwt.\n5. Para receber, use a pasta **2. Cash-in — Cobranças PIX**.\n6. Para pagar, consulte primeiro o favorecido na pasta **3. Cash-out — Consultas auxiliares** e crie a solicitação na pasta **4. Cash-out — Criar pagamento**.\n7. Acompanhe o resultado pelo endpoint de consulta correspondente.\n\n## Autenticação\n\nTodos os endpoints de gateway exigem:\n\n    Authorization: Bearer {{jwt}}\n\nQuando a API responder 401, faça login novamente. Nunca envie CPF/CNPJ, senha, JWT ou callbackSecret em chamados, logs públicos ou repositórios.\n\n## Cash-in e cash-out\n\n| Fluxo | Finalidade | Resultado inicial |\n| --- | --- | --- |\n| Cash-in | Emitir QR Code PIX para receber | Cobrança ATIVA |\n| Cash-out | Solicitar PIX ou boleto para pagar terceiros | Solicitação PENDENTE |\n\nCash-out é assíncrono: criar uma solicitação não significa que o pagamento foi concluído. Consulte o status até PAGA, REJEITADA ou CANCELADA.\n\n## Status de cobrança\n\n| Status | Significado |\n| --- | --- |\n| CRIADO | Registro local criado, ainda sem QR ativo |\n| ATIVO | QR disponível e aguardando pagamento |\n| PAGO | Pagamento identificado pelo processamento bancário |\n| EXPIRADO | Cobrança dinâmica venceu sem pagamento |\n| CANCELADO | Cobrança cancelada |\n| ERRO | Falha na emissão ou no processamento |\n\n## Status de pagamento\n\n| Status | Significado |\n| --- | --- |\n| PENDENTE | Solicitação criada e aguardando processamento |\n| PROCESSANDO | Enviada ao processamento bancário; aguarde o resultado |\n| PAGA | Pagamento concluído e vinculado à transação financeira |\n| REJEITADA | Solicitação rejeitada |\n| CANCELADA | Solicitação cancelada |\n\n## Requisições de criação e repetição\n\nOs endpoints POST de criação não recebem uma chave de idempotência pública. Não repita automaticamente uma criação após timeout sem antes consultar seus registros. Uma repetição pode gerar outra cobrança ou solicitação.\n\n## Erros\n\nErros de negócio e validação normalmente seguem este formato:\n\n    {\n      \"timestamp\": \"2026-07-09T12:00:00\",\n      \"status\": 400,\n      \"error\": \"Erro de validação\",\n      \"message\": \"Erro na validação dos campos\",\n      \"path\": \"/gateway/...\",\n      \"details\": [\"campo é obrigatório\"]\n    }\n\n| HTTP | Ação recomendada |\n| --- | --- |\n| 400 | Corrija os dados enviados ou a regra de negócio indicada |\n| 401 | Gere um novo JWT |\n| 403 | Confirme políticas e vínculo com o estabelecimento |\n| 404 | Confirme o identificador consultado |\n| 409 | Não repita a criação; revise possível duplicidade |\n| 500 | Não repita operações financeiras automaticamente; contate o suporte |\n\n## Suporte técnico\n\nE-mail: **dev@simpbank.com.br**\n\nAo solicitar suporte, informe o endpoint, horário aproximado, HTTP status e identificadores não sensíveis, como cobrancaId ou pagamentoId. Não envie senhas, JWTs, chaves PIX completas ou callbackSecret.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9122724","team":22717562,"collectionId":"4dd3517c-0a62-48b1-aa8f-df462679992d","publishedId":"2sBY4LQgrw","public":true,"publicUrl":"https://docs.simpbank.com.br","privateUrl":"https://go.postman.co/documentation/9122724-4dd3517c-0a62-48b1-aa8f-df462679992d","customColor":{"top-bar":"FFFFFF","right-sidebar":"111827","highlight":"16A34A"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Integre cobranças PIX e pagamentos PIX ou boleto com o Gateway SimpBank."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/b4796bcf-d97b-412a-b35f-3683c155268e/c2ltcGJhbmtfcGVxdWVuYV8yeC5wbmc=","colors":{"top-bar":"111827","right-sidebar":"0B1120","highlight":"22C55E"}},{"name":"light","logo":"https://content.pstmn.io/c196a332-55aa-44c6-b14b-e02e0cc8d43e/cGVxdWVuYV9zaW1wYmFua19zZW1fZnVuZG8ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"111827","highlight":"16A34A"}}]}},"version":"8.11.6","publishDate":"2026-07-10T02:14:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Integre cobranças PIX e pagamentos PIX ou boleto com o Gateway SimpBank."},"logos":{"logoLight":"https://content.pstmn.io/c196a332-55aa-44c6-b14b-e02e0cc8d43e/cGVxdWVuYV9zaW1wYmFua19zZW1fZnVuZG8ucG5n","logoDark":"https://content.pstmn.io/b4796bcf-d97b-412a-b35f-3683c155268e/c2ltcGJhbmtfcGVxdWVuYV8yeC5wbmc="}},"statusCode":200},"environments":[{"name":"Gateway SimpBank | Produção Pública","id":"6ca2d4e9-946f-4ee3-aefc-c4186e3f00df","owner":"9122724","values":[{"key":"cpfCnpj","value":"","type":"secret","enabled":true},{"key":"password","value":"","type":"secret","enabled":true},{"key":"applicationSource","value":"SIMPPAG","type":"default","enabled":true},{"key":"estabelecimentoId","value":"","type":"default","enabled":true},{"key":"jwt","value":"","type":"secret","enabled":true},{"key":"userId","value":"","type":"default","enabled":true},{"key":"cobrancaId","value":"","type":"default","enabled":true},{"key":"pagamentoId","value":"","type":"default","enabled":true},{"key":"shareLink","value":"","type":"default","enabled":true},{"key":"qrEstaticoId","value":"","type":"default","enabled":true},{"key":"qrEstaticoConciliacaoId","value":"","type":"default","enabled":true},{"key":"valorCobranca","value":"","type":"default","enabled":true},{"key":"descricaoCobranca","value":"","type":"default","enabled":true},{"key":"callbackUrl","value":"","type":"default","enabled":true},{"key":"callbackSecret","value":"","type":"secret","enabled":true},{"key":"pagadorNome","value":"","type":"default","enabled":true},{"key":"pagadorDocumento","value":"","type":"secret","enabled":true},{"key":"pagadorLogradouro","value":"","type":"default","enabled":true},{"key":"pagadorCidade","value":"","type":"default","enabled":true},{"key":"pagadorEstado","value":"","type":"default","enabled":true},{"key":"pagadorCep","value":"","type":"default","enabled":true},{"key":"chavePixCpf","value":"","type":"secret","enabled":true},{"key":"chavePixEmail","value":"","type":"secret","enabled":true},{"key":"chavePixTelefone","value":"","type":"secret","enabled":true},{"key":"chavePixAleatoria","value":"","type":"secret","enabled":true},{"key":"linhaDigitavel","value":"","type":"secret","enabled":true},{"key":"pixCopiaCola","value":"","type":"secret","enabled":true},{"key":"valorPagamento","value":"","type":"default","enabled":true},{"key":"descricaoPagamento","value":"","type":"default","enabled":true},{"key":"nomeTitular","value":"","type":"default","enabled":true},{"key":"bancoDestino","value":"","type":"default","enabled":true},{"key":"agenciaDestino","value":"","type":"secret","enabled":true},{"key":"contaDestino","value":"","type":"secret","enabled":true},{"key":"cpfCnpjTitular","value":"","type":"secret","enabled":true},{"key":"dataVencimento","value":"","type":"default","enabled":true}],"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/6391d671f66acc898bd922f71d4d82eccd246989c0139734e12f6d5b344e49b1","favicon":"https://simpbank.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":"Gateway SimpBank | Produção Pública","value":"9122724-6ca2d4e9-946f-4ee3-aefc-c4186e3f00df"}],"canonicalUrl":"https://docs.simpbank.com.br/view/metadata/2sBY4LQgrw"}