A área de integração da Conciliadora concentra todas as diretrizes e informações essenciais para os desenvolvedores que interagem com nossos serviços.
\nAqui estão definidos os padrões técnicos de interfaces, especificações das diferentes APIs (incluindo versionamento) e detalhes fundamentais para garantir a correta e eficiente implementação das integrações com a plataforma Conciliadora.
\nA autorização é feita via token JWT no header da requisição.
\nAuthorization: Bearer 'seu_token_aqui'
\n\nRate Limit: 1 requisição por segundo por credencial de API
\n
Para otimizar o tráfego e simplificar o consumo das respostas, nossas APIs não retornam campos que possuem valor nulo.
\nIsso significa que:
\nSe um campo não estiver presente no corpo da resposta, ele não contém valor (ou seja, está nulo).
\nApenas campos com dados válidos são incluídos no JSON de retorno.
\nExemplo:
\n{ \n \"id\": 123, \n \"nome\": \"Posto Exemplo\", \n \"cnpj\": \"12345678000190\" \n}\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17137971","collectionId":"310b63d0-d085-4b4d-9e73-5aefc3907486","publishedId":"2sB2x3oth5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"103239","highlight":"E8E10E"},"publishDate":"2026-06-16T15:20:12.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Gerar Token","event":[{"listen":"test","script":{"id":"8fa6a402-886b-437c-bc6b-b63208183297","exec":["console.log(responseBody);\r","var json = JSON.parse(responseBody);\r","\r","if (json.access_token) {\r"," console.log('set token');\r"," pm.collectionVariables.set('Token', json.access_token);\r"," pm.collectionVariables.set('RefreshToken', json.refresh_token);\r","}"],"type":"text/javascript","packages":{}}}],"id":"c95676bf-dccd-4958-bd8f-6cd98b42aac9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"client_id","value":"seu_cliente_id","type":"text"},{"key":"client_secret","value":"seu_client_secret","type":"text"}]},"url":"https://api-integracao.conciliadora.com.br/token","description":"Neste exemplo, os campos
\ntelefonenão aparecem porque estão nulos na base de dados.
Este endpoint segue o padrão OAuth 2.0 com grant type client_credentials. Deve ser utilizado para obter um token JWT válido de acesso.
Este endpoint deve ser utilizado para realizara renovação do access_token usando o grant type refresh_token.
Todas as requisições exigem envio de token JWT via cabeçalho. Este endpoint deve ser usado para obter o token JWT de autenticação.
\n","_postman_id":"53f1cc41-109d-443b-938b-3154cd41f236"},{"name":"Empresas","item":[{"name":"Lista Empresas","id":"c8cd40fe-e486-4591-a81f-ab008228f0b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"••••••"}],"body":{"mode":"raw","raw":"{\r\n \"count\": true, \r\n \"top\": 500, \r\n \"skip\": 0 \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/Empresas","urlObject":{"path":["api","v1","Parceiro","Empresas"],"host":["https://api-integracao.conciliadora.com.br"],"query":[],"variable":[]}},"response":[{"id":"d18d5bf0-b27f-437f-8ddb-2b3ffd13f79e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"••••••"}],"body":{"mode":"raw","raw":"{\r\n \"count\": true, \r\n \"top\": 500, \r\n \"skip\": 0 \r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/Empresas"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Rate-Limit-Limit","value":"1h"},{"key":"X-Rate-Limit-Remaining","value":"2999"},{"key":"X-Rate-Limit-Reset","value":"2025-06-12T20:57:49.4830402Z"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 12 Jun 2025 19:57:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Registros\": 2,\n \"Skip\": 0,\n \"Top\": 500,\n \"Data\": [\n {\n \"IdEmpresa\": 123,\n \"RazaoSocial\": \"EMPRESA MODELO\",\n \"NomeFantasia\": \"EMPRESA MODELO\",\n \"Nome\": \"EMPRESA MODELO\",\n \"Cnpj\": \"1223456780123\",\n \"Grupo\": \"Posto Modelo\",\n \"DadosIntegracao\": {\n \"Empresa\": 123,\n \"Senha\": \"xyz\",\n \"Tipo\": \"WebService\"\n }\n },\n {\n \"IdEmpresa\": 123,\n \"RazaoSocial\": \"EMPRESA MODELO\",\n \"NomeFantasia\": \"EMPRESA MODELO\",\n \"Nome\": \"EMPRESA MODELO\",\n \"Cnpj\": \"1223456780123\",\n \"Grupo\": \"Posto Modelo\",\n \"DadosIntegracao\": {\n \"Empresa\": 123,\n \"Senha\": \"xyz\",\n \"Tipo\": \"WebService\"\n }\n }\n ]\n}"}],"_postman_id":"c8cd40fe-e486-4591-a81f-ab008228f0b7"}],"id":"60674266-3c6a-4fce-adf5-24aadf788d70","description":"Este endpoint retorna os dados básicos de todas as empresas às quais a credencial de acesso informada possui autorização.
\nIdEmpresa retornado deve ser utilizado como filtro nas demais chamadas da API, como por exemplo nos endpoints de vendas e pagamentos.Retorna uma lista de Adquirentes e seus respectivos identificadores.
\nCodigo retornado pode ser utilizado como filtro em algumas chamadas da API, como por exemplo nos endpoints de vendas e pagamentos.Retorna os dados de domicílio bancário das empresas informadas, incluindo banco, agência, conta, dígito verificador da conta e nome da empresa.
\nEssas informações podem ser utilizadas em integrações que dependem dos dados bancários da empresa, como a consulta de lançamentos bancários.
\nPara realizar a consulta, é necessário informar:
\nidEmpresa
Para consultas em APIs que exigem o campo conta, deve-se considerar também o dígito verificador quando ele existir.
\n","urlObject":{"path":["api","v1","Parceiro","CNAB240","DomicilioBancario"],"host":["https://api-integracao.conciliadora.com.br"],"query":[],"variable":[]}},"response":[{"id":"0a9ee269-1696-44bf-8f75-e876b15e43c5","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"idEmpresa\": [\r\n 123\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/CNAB240/DomicilioBancario"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Banco\": 341,\r\n \"Agencia\": \"1234\",\r\n \"Conta\": \"12345\",\r\n \"DigVerificadorConta\": \"0\",\r\n \"Empresa\": \"EMPRESA DE EXEMPLO LTDA.\"\r\n }\r\n]"}],"_postman_id":"cf4e72bc-c895-43c0-bc3a-9aa33fe8f141"},{"name":"Consulta Lançamentos","id":"747d10ef-30c5-4ad1-9c53-015df6eeab34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"dataInicial\": \"2025-04-29\", //obrigatório\r\n \"dataFinal\": \"2025-04-30\", //obrigatório\r\n \"banco\": \"123\", //obrigatório\r\n \"agencia\": \"1234\", //obrigatório\r\n \"conta\": \"12345\" //obrigatório\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/CNAB240/Lancamentos","description":"Retorna os lançamentos bancários no intervalo informado.
\nPara realizar a consulta, é necessário informar os dados bancários da conta. Quando a conta possuir dígito verificador, ele deve ser enviado junto ao número da conta, no mesmo campo, sem separadores.
\nOs dados necessários para essa consulta podem ser obtidos por meio da API de Domicílio Bancário.
\ndataInicial: data inicial para consulta no formato AAAA-MM-DDdataFinal: data final para consulta no formato AAAA-MM-DDbanco: código do bancoagencia: número da agênciaconta: número da conta bancária
Quando a conta possuir dígito verificador, o campo conta deve ser enviado com o número da conta concatenado ao dígito, sem separadores.
\nConta: 12345
Dígito verificador: 0
Valor a ser enviado no campo conta: 123450
Retorna lançamentos da data informada.
\nPara realizar a consulta, é necessário informar:
\nbanco - Código do banco
agencia - Número da Agencia
conta - Numero da conta
Consulta lançamentos bancários CNAB240.
\n","_postman_id":"f657b7a5-130a-4d1b-bcb0-ea5a09e809dd"},{"name":"Vendas","item":[{"name":"Consulta Vendas","id":"ae86cf6f-5d25-4114-9b87-58bfa3ab7bd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DataInicial\": \"2025-01-26\", //obrigatório\r\n \"DataFinal\": \"2025-01-29\", //obrigatório\r\n \"IdEmpresa\": 683, //Id da empresa na Conciliadora\r\n //\"IdAdquirente\": 1, //opcional Id da adquirente na Conciliadora\r\n \"count\": true, //mostrar contador\r\n \"top\": 500, //quantidade de registros que deseja retornar na consulta (máximo 500)\r\n \"skip\": 0 //quantidade de registros que deseja pular (paginação)\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/Vendas/ConsultaVenda","description":"Para realizar a consulta, é necessário informar:
\nDataInicial - Formato: AAAA-MM-DD
DataFinal - Formato: AAAA-MM-DD
IdEmpresa - Numero Intereiro (identificador da empresa à qual as transações pertencem)
\n\nO campo
\nIdEmpresapode ser obtido através do endpoint Listagem de Empresas, que retorna os dados básicos de todas as empresas acessíveis pela credencial em uso.
Além disso, é possível informar opcionalmente o campo:
\nIdAdquirente – para filtrar as transações por operadora específica.
Este endpoint retorna as informações detalhadas de todas as transações de vendas informadas pelas operadoras no período especificado.
\nO intervalo entre a data inicial e a data final não pode exceder 30 dias.
\n","_postman_id":"aafff81e-1945-4da4-a665-aba2fda055fb"},{"name":"Pagamentos","item":[{"name":"Consulta Pagamentos","id":"bd602493-bdf0-43ee-917c-74f7cc2584dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DataInicial\": \"2025-01-26\", //obrigatório\r\n \"DataFinal\": \"2025-01-29\", //obrigatório\r\n \"IdEmpresa\": 516, //Id da empresa na Conciliadora \r\n //\"IdAdquirente\": 1, //opcional Id da adquirente na Conciliadora\r\n \"count\": true, //mostrar contador\r\n \"top\": 500, //quantidade de registros que deseja retornar na consulta (máximo 500)\r\n \"skip\": 0 //quantidade de registros que deseja pular (paginação)\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/Pagamentos/ConsultaPagamentos","description":"Para realizar a consulta, é necessário informar:
\nDataInicial - Formato: AAAA-MM-DD
DataFinal - Formato: AAAA-MM-DD
IdEmpresa - Numero Intereiro (identificador da empresa à qual as transações pertencem)
\n\nO campo
\nIdEmpresapode ser obtido através do endpoint Listagem de Empresas, que retorna os dados básicos de todas as empresas acessíveis pela credencial em uso.
Além disso, é possível informar opcionalmente o campo:
\nIdAdquirente – para filtrar as transações por operadora específica.
Este endpoint retorna as informações detalhadas de todas as transações de pagamentos informadas pelas operadoras no período especificado. Inclui também informações de Saque realizados em Wallet (Carteira digital).
\nPara retornar apenas as informações de pagamentos, deve-se usar o filtro passando o campo ContaAdquirente igual a true.
\nO intervalo entre a data inicial e a data final não pode exceder 30 dias.
\nOs resultados podem incluir, para cada transação, um campo IdDeposito.
O campo IdDeposito pode ser utilizado para realizar uma consulta na API de Lançamentos Bancários, identificando com qual lançamento bancário o pagamento foi conciliado.
Observação: esta funcionalidade está disponível apenas para clientes que utilizam o layout CNAB240, e os dados passam a estar disponíveis a partir de 09 de junho de 2025, data em que a funcionalidade foi implantada.
\nEste endpoint permite registrar manualmente a baixa de um pagamento, informando os dados mínimos da operação.
\n\n\n","urlObject":{"path":["api","v1","Parceiro","BaixaPagamento","GravaBaixaPagamento"],"host":["https://api-integracao.conciliadora.com.br"],"query":[{"key":"RefoId","value":"516"},{"key":"IdVendaPagamento","value":"123"}],"variable":[]}},"response":[],"_postman_id":"bc21489e-5469-4734-9fec-883e71daab83"},{"name":"Desfazer a baixa de um Pagamento","id":"c75360ff-3ae5-4194-beb4-b1bb10442847","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"DELETE","header":[{"key":"accept","value":"*/*"}],"url":"https://api-integracao.conciliadora.com.br/api/v1/Parceiro/BaixaPagamento/RemoveBaixaPagamento?RefoId=516&IdVendaPagamento=123","description":"Ambos os parâmetros são enviados via query string.
\n
Este endpoint permite remover (desfazer) a baixa de um pagamento previamente registrada no sistema da Conciliadora.
\nÉ utilizado para reverter uma conciliação, informando os dados de referência da baixa.
\n\n\n","urlObject":{"path":["api","v1","Parceiro","BaixaPagamento","RemoveBaixaPagamento"],"host":["https://api-integracao.conciliadora.com.br"],"query":[{"key":"RefoId","value":"516"},{"key":"IdVendaPagamento","value":"123"}],"variable":[]}},"response":[],"_postman_id":"c75360ff-3ae5-4194-beb4-b1bb10442847"}],"id":"f3f0e650-4e35-4016-859e-09cfdbaed7b3","description":"Esses parâmetros são passados diretamente na query string da URL.
\n
Este endpoint permite realizar operações relacionadas à baixa de pagamentos, incluindo a inserção, remoção e consulta de pagamentos.
\nidPagamentoO campo idPagamento representa o identificador da venda enviada pelo cliente na conciliação de venda sistema.
Este campo idPagamento somente será retornado no pagamento quando todo o processo de conciliação for concluído com sucesso, ou seja:
A venda enviada pelo cliente foi conciliada com a venda enviada pela operadora
\nA venda da operadora foi conciliada com o pagamento da operadora
\n\n\nImportante:
\n
Caso qualquer uma dessas etapas não seja concluída, o campoidPagamentonão será incluído na resposta da API — e, consequentemente, o pagamento não poderá ser baixado.
baixadoO campo baixado indica se o pagamento já foi baixado pelo cliente por meio da API de Realização de Baixa de Pagamento.
Quando baixado = true: significa que o cliente já registrou a baixa para aquele pagamento através da integração.
Quando baixado = false: significa que o pagamento ainda não foi baixado pelo cliente.
\n\n","_postman_id":"f3f0e650-4e35-4016-859e-09cfdbaed7b3"},{"name":"Histórico de Processamento","item":[{"name":"Consulta Histórico de Vendas","id":"ea39c696-3848-4c02-8754-b27f95135acb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"seu_token"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DataInicial\": \"2025-06-18\", //Obrigatório\r\n \"DataFinal\": \"2025-06-18\", //Obrigatório\r\n \"IdEmpresa\": 123 //Obrigatório\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-integracao.conciliadora.com.br/api/v2/HistoricoProcessamento/Vendas","description":"Este campo é útil para validar se um pagamento já foi conciliado pelo cliente ou está pendente de baixa no sistema, caso não seja usado o filtro na pesquisa.
\n
Este endpoint retorna as datas de referência das Vendas que tiveram suas informações alteradas no período consultado.
\nDataInicial – Data de início do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
DataFinal – Data de fim do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
IdEmpresa – Identificador da empresa
A API permite consultas por faixas horárias específicas dentro de um mesmo dia. Exemplo:
\nDataInicial = 2024-05-01T08:00:00
DataFinal = 2024-05-01T18:00:00
Este endpoint retorna as datas de referência dos pagamentos que tiveram suas informações alteradas no período consultado.
\nDataInicial – Data de início do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
DataFinal – Data de fim do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
IdEmpresa – Identificador da empresa
A API permite consultas por faixas horárias específicas dentro de um mesmo dia. Exemplo:
\nDataInicial = 2024-05-01T08:00:00
DataFinal = 2024-05-01T18:00:00
Este endpoint retorna as datas de referência que tiveram suas informações alteradas no período consultado.
\n\n\nVersão da API: v2
\n
Esta API está disponível na versão 2 (/v2/HistoricoProcessamento).
DataInicial – Data de início do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
DataFinal – Data de fim do intervalo (formato yyyy-MM-dd ou yyyy-MM-ddTHH:mm:ss)
IdEmpresa – Identificador da empresa
O intervalo entre DataInicial e DataFinal não pode exceder 30 dias.
É possível utilizar apenas a data (yyyy-MM-dd) ou data e hora completas (yyyy-MM-ddTHH:mm:ss) nos filtros.
A API permite consultas por faixas horárias específicas dentro de um mesmo dia. Exemplo:
\nDataInicial = 2024-05-01T08:00:00
DataFinal = 2024-05-01T18:00:00
Para realizar a consulta, é necessário informar:
\nDataInclusao - Formato: AAAA-MM-DD
IdEmpresa - Numero Intereiro (identificador da empresa à qual as transações pertencem)
\n\nO campo
\nIdEmpresapode ser obtido através do endpoint Listagem de Empresas, que retorna os dados básicos de todas as empresas acessíveis pela credencial em uso.
Além disso, é possível informar opcionalmente o campo:
\nIdAdquirente – para filtrar por operadora específica.
Este endpoint permite consultar os arquivos recebidos pelo sistema, com suporte a filtros para facilitar a localização e análise dos dados processados.
\nÉ útil para acompanhar os arquivos enviados por adquirentes, verificar entradas recentes e rastrear eventos específicos no processo de conciliação.
\n","_postman_id":"8729a7ce-7fa7-4cee-bfc7-7825e0f52317"}],"event":[{"listen":"prerequest","script":{"id":"5a74aa66-7723-4d55-a42c-5b3120c0ba53","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ae9fdc7b-f67e-4f53-88e9-5f07b6c74ff8","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"client_id","value":"seu_cliente_id"},{"key":"client_secret","value":"seu_client_secret"},{"key":"UrlApi","value":"https://api-integracao.conciliadora.com.br"},{"key":"Token","value":"seu_token"},{"key":"RefreshToken","value":"seu_refresh_token"},{"key":"dataLancamento","value":"dataLancamento"}]}