{"info":{"_postman_id":"e0213ba2-5eab-4883-9d04-1c8c75ca8fe7","name":"StubPay - Documentação Oficial de Integração","description":"<html><head></head><body><h2 id=\"bem-vindoa-à-integração-com-a-stubpay\"><strong>Bem-vindo(a) à Integração com a StubPay!</strong></h2>\n<p>Aqui você encontrará todas as informações necessárias para realizar sua integração com a nossa API de forma simples, eficiente e segura.</p>\n<hr>\n<h1 id=\"comecar\"><strong>Começar</strong></h1>\n<p>Para acessar os endpoints da nossa API, é necessário gerar credenciais de acesso associadas à sua conta de usuário. Este processo é realizado diretamente no portal StubPay, seguindo os passos abaixo:</p>\n<ol>\n<li><p><strong>Acesse sua conta</strong> com seu nome de usuário e senha.</p>\n</li>\n<li><p>No menu lateral, clique em <strong>Integrações</strong>.</p>\n</li>\n<li><p>Siga as instruções exibidas na tela para gerar suas credenciais.</p>\n</li>\n</ol>\n<p>Ao final do processo, serão exibidos dois hashs:</p>\n<ul>\n<li><p><strong>Client ID (client_id)</strong></p>\n</li>\n<li><p><strong>Client Secret (client_secret)</strong></p>\n</li>\n</ul>\n<p>⚠️ <strong>Importante:</strong></p>\n<p>Certifique-se de armazenar esses dados em um local seguro, pois eles não poderão ser visualizados novamente. Caso seja necessário, você poderá gerar novas credenciais a qualquer momento, o que automaticamente revogará as chaves anteriores.</p>\n<h4 id=\"como-usar-as-credenciais\"><strong>Como usar as credenciais?</strong></h4>\n<p>Inclua o <strong>Client ID</strong> e o <strong>Client Secret</strong> no cabeçalho (<strong>headers</strong>) de todas as requisições HTTP enviadas para nossa API. Desta forma você terá acesso liberado para consumir nossa API.</p>\n<ul>\n<li><p><strong>Headers necessários:</strong></p>\n<ul>\n<li><p><code>client_id: SEU_CLIENT_ID</code></p>\n</li>\n<li><p><code>client_secret: SEU_CLIENT_SECRET</code></p>\n</li>\n</ul>\n</li>\n</ul>\n<h1 id=\"ambientes\"><strong>Ambientes</strong></h1>\n<p>No momento disponibilizamos para integração somente o ambiente de produção.</p>\n<h4 id=\"produção\">Produção:</h4>\n<p>Base URL: <code>https://api.stubpay.com.br/integrations</code></p>\n<hr>\n<h1 id=\"endpoints\"><strong>Endpoints</strong></h1>\n<p>Nossa API oferece uma variedade de endpoints para atender suas necessidades. Consulte a documentação detalhada de cada endpoint para obter informações completas sobre parâmetros, exemplos de uso e respostas esperadas.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>PATH</strong></th>\n<th><strong>DESCRIÇÃO</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>/deposits</td>\n<td>Solicita um deposito via PIX</td>\n</tr>\n<tr>\n<td>/transfers</td>\n<td>Realiza uma transferência via PIX</td>\n</tr>\n<tr>\n<td>/receipt/:id</td>\n<td>Obtém o comprovante de uma transferência</td>\n</tr>\n<tr>\n<td>/search</td>\n<td>Retorna transações com base nos filtros fornecidos</td>\n</tr>\n<tr>\n<td>/:id</td>\n<td>Obtém detalhes de uma transação com base no ID</td>\n</tr>\n</tbody>\n</table>\n</div><hr>\n<p>Se precisar de ajuda, nossa equipe de suporte está à disposição! 🚀</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Começar","slug":"comecar"},{"content":"Ambientes","slug":"ambientes"},{"content":"Endpoints","slug":"endpoints"}],"owner":"30376262","collectionId":"e0213ba2-5eab-4883-9d04-1c8c75ca8fe7","publishedId":"2sA3XV8ytk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-30T21:33:05.000Z"},"item":[{"name":"Pix Gateway","item":[{"name":"Solicitar depósito","id":"f7d939a5-3168-46df-a691-bf66e9aa9fbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"value\": 1000.00,\n    \"name\": \"João da Silva\",\n    \"document\": \"123.456.789-00\",\n    \"callback_url\": \"https://meu-site.com/callback\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transactions/deposits","description":"<h3 id=\"descrição\"><strong>Descrição</strong></h3>\n<p>Esse endpoint permite solicitar um depósito via PIX, gerando um QRCode e uma opção de Copia &amp; Cola para pagamento.</p>\n<hr />\n<h3 id=\"request-body\"><strong>Request (Body)</strong></h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Variável</strong></th>\n<th><strong>Tipo</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>value</code></td>\n<td>Number</td>\n<td>Valor do pedido (obrigatório, deve ser maior que 0)</td>\n</tr>\n<tr>\n<td><code>document</code></td>\n<td>String</td>\n<td>CPF ou CNPJ do remetente (obrigatório, válido como CPF ou CNPJ)</td>\n</tr>\n<tr>\n<td><code>name</code></td>\n<td>String</td>\n<td>Nome completo caso seja CPF ou razão social da empresa para CNPJ (obrigatório se CPF ou CNPJ)</td>\n</tr>\n<tr>\n<td><code>callback_url</code></td>\n<td>String</td>\n<td>URL de webhook para receber as atualizações sobre o pagamento. (Opcional, recomendado)</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"exemplo-de-request\">Exemplo de Request:</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"value\": 1000.00,\n  \"document\": \"123.456.789-00\",\n  \"name\": \"João da Silva\",\n  \"callback_url\": \"https://meu-site.com/callback\"\n}\n\n</code></pre>\n<hr />\n<h3 id=\"response\"><strong>Response</strong></h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Variável</strong></th>\n<th><strong>Tipo</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>String</td>\n<td>ID - Identificador da transação</td>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>String</td>\n<td>Tipo da transação (sempre <code>PIX_CASHIN</code>)</td>\n</tr>\n<tr>\n<td><code>fee</code></td>\n<td>Number</td>\n<td>Valor da taxa (fee) que será cobrada caso o status seja alterado para <code>APPROVED</code></td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Status da transação, por padrão é <code>PENDING</code>. Outros valores possíveis: <code>APPROVED</code>, <code>CANCELED</code>, <code>REFUNDED</code></td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Number</td>\n<td>Valor do pedido</td>\n</tr>\n<tr>\n<td><code>payment_options</code></td>\n<td>Object</td>\n<td>Dentro de <code>payment_options</code> há duas propriedades: <code>copy_paste</code> (para copiar o código) e <code>qr_code</code> (QRCode para pagamento)</td>\n</tr>\n<tr>\n<td><code>customer_name</code></td>\n<td>String</td>\n<td>Nome completo do cliente (se CPF) ou razão social da empresa (se CNPJ)</td>\n</tr>\n<tr>\n<td><code>customer_document</code></td>\n<td>String</td>\n<td>CPF ou CNPJ do remetente</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"exemplo-de-response\">Exemplo de Response:</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"id\": \"64dfe4e9f9b05c001d743abc\",\n  \"type\": \"PIX_CASHIN\",\n  \"fee\": 50.00,\n  \"status\": \"PENDING\",\n  \"value\": 1000.00,\n  \"payment_options\": {\n    \"copy_paste\": \"00020101021226910014BR.GOV.BCB.PIX01145123456789012345678901234567890123456789030398653099800040220340010001995000080000408B6D4F35C5B6FBCDF31A3F6AB3D9C18D92947FE3545F5BB460\",\n    \"qr_code\": \"00020101021226910014BR.GOV.BCB.PIX01145123456789012345678901234567890123456789030398653099800040220340010001995000080000408B6D4F35C5B6FBCDF31A3F6AB3D9C18D92947FE3545F5BB460\"\n  },\n  \"customer_name\": \"João da Silva\",\n  \"customer_document\": \"12345678900\"\n}\n\n</code></pre>\n<hr />\n<h3 id=\"notas\"><strong>Notas</strong></h3>\n<ul>\n<li><p><strong>value</strong>: O valor do pedido deve ser maior que 0.</p>\n</li>\n<li><p><strong>document</strong>: O CPF ou CNPJ deve ser válido. O nome completo ou razão social será necessário dependendo se o documento é um CPF ou CNPJ.</p>\n</li>\n<li><p><strong>callback_url</strong>: Recomenda-se adicionar uma URL de webhook para receber notificações sobre o status do pagamento. Essa URL é opcional, mas é útil para integração com o sistema do cliente.</p>\n</li>\n</ul>\n","urlObject":{"path":["transactions","deposits"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f7d939a5-3168-46df-a691-bf66e9aa9fbd"},{"name":"Realizar transferência","id":"64b1cc04-eb63-431c-8d11-0c32d09afee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transactions/transfers","description":"<h3 id=\"descrição\"><strong>Descrição</strong></h3>\n<p>Esse endpoint permite tranferências via PIX, usando uma chave pix ou um codigo copia e cola.</p>\n<hr />\n<h3 id=\"request-body\"><strong>Request (Body)</strong></h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Variável</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>value</code></td>\n<td>Number</td>\n<td><strong>Obrigatório</strong>. Valor do pedido, em reais (R$).</td>\n</tr>\n<tr>\n<td><code>pix_key</code></td>\n<td>String</td>\n<td><strong>Opcional</strong>. Chave PIX de destino (ex: CPF, CNPJ, e-mail, celular, ou chave aleatória). Utilize <strong><code>pix_key</code></strong> ou <strong><code>emv</code></strong> (não ambos).</td>\n</tr>\n<tr>\n<td><code>pix_key_type</code></td>\n<td>String</td>\n<td><strong>Opcional</strong>. Tipo de chave PIX (válidos: <code>pixCPF</code>, <code>pixCNPJ</code>, <code>pixCelular</code>, <code>pixEmail</code>, <code>pixAleatorio</code>). Deve ser preenchido apenas se <code>pix_key</code> for fornecido.</td>\n</tr>\n<tr>\n<td><code>emv</code></td>\n<td>String</td>\n<td><strong>Opcional</strong>. Código EMV (Copia e Cola) que contém o valor da transação, exclusivo para esse formato de pagamento. Se fornecido, <code>pix_key</code> e <code>pix_key_type</code> devem ser deixados em branco.</td>\n</tr>\n<tr>\n<td><code>callback_url</code></td>\n<td>String</td>\n<td><strong>Opcional</strong>. URL para receber atualizações sobre o status da transferência via webhook.</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h3 id=\"exemplo-de-request-usando-chave-pix\"><strong>Exemplo de Request (usando chave PIX)</strong></h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"value\": 150.00,\n  \"pix_key\": \"12345678901\",\n  \"pix_key_type\": \"pixCPF\",\n  \"callback_url\": \"https://meusite.com/webhook\"\n}\n\n</code></pre>\n<h3 id=\"exemplo-de-request-usando-código-emv\"><strong>Exemplo de Request (usando código EMV)</strong></h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"value\": 150.00,\n  \"emv\": \"0002010102123456789012345678901234567890123456\",\n  \"callback_url\": \"https://meusite.com/webhook\"\n}\n\n</code></pre>\n<hr />\n<h3 id=\"response\"><strong>Response</strong></h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Variável</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>String</td>\n<td><strong>Obrigatório</strong>. Identificador único da transação.</td>\n</tr>\n<tr>\n<td><code>type</code></td>\n<td>String</td>\n<td>Tipo da transação. O valor será <code>PIX_CASHIN</code> para transferências via PIX.</td>\n</tr>\n<tr>\n<td><code>fee</code></td>\n<td>Number</td>\n<td>Valor da taxa (<code>fee</code>) que será cobrado quando o status da transação for alterado para <code>APPROVED</code>.</td>\n</tr>\n<tr>\n<td><code>status</code></td>\n<td>String</td>\n<td>Status da transação. Pode ser <code>APPROVED</code>, <code>PENDING</code>, <code>CANCELED</code>, <code>REFUNDED</code>. Por padrão, será <code>PENDING</code>.</td>\n</tr>\n<tr>\n<td><code>value</code></td>\n<td>Number</td>\n<td>Valor do pedido (transferência realizada).</td>\n</tr>\n<tr>\n<td><code>pix_key</code></td>\n<td>String</td>\n<td>Chave PIX de destino (caso tenha sido usada no request).</td>\n</tr>\n<tr>\n<td><code>pix_key_type</code></td>\n<td>String</td>\n<td>Tipo de chave PIX (caso tenha sido usada no request).</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h3 id=\"exemplo-de-response-chave-pix\"><strong>Exemplo de Response (chave PIX)</strong></h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"id\": \"123456\",\n  \"type\": \"PIX_CASHIN\",\n  \"fee\": 2.50,\n  \"status\": \"PENDING\",\n  \"value\": 150.00,\n  \"pix_key\": \"12345678901\",\n  \"pix_key_type\": \"pixCPF\"\n}\n\n</code></pre>\n<h3 id=\"exemplo-de-response-código-emv\"><strong>Exemplo de Response (código EMV)</strong></h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"id\": \"123456\",\n  \"type\": \"PIX_CASHIN\",\n  \"fee\": 2.50,\n  \"status\": \"PENDING\",\n  \"value\": 150.00,\n  \"emv\": \"0002010102123456789012345678901234567890123456\"\n}\n\n</code></pre>\n<hr />\n<h3 id=\"validações-e-restrições\"><strong>Validações e Restrições</strong></h3>\n<ol>\n<li><p><strong>Chave PIX vs EMV</strong>: Apenas uma das duas opções pode ser fornecida por vez:</p>\n<ul>\n<li><p><strong>Chave PIX</strong>: Pode ser utilizada qualquer tipo de chave válida (<code>pixCPF</code>, <code>pixCNPJ</code>, <code>pixCelular</code>, <code>pixEmail</code>, <code>pixAleatorio</code>).</p>\n</li>\n<li><p><strong>Código EMV (Copia e Cola)</strong>: Deve ser fornecido em formato específico e só pode ser usado quando não se utiliza a chave PIX.</p>\n</li>\n</ul>\n</li>\n<li><p><strong>Valor</strong>: O valor da transação é obrigatório e deve ser informado em reais (R$).</p>\n</li>\n<li><p><strong><code>callback_url</code></strong>: Embora não seja obrigatório, o uso de um <code>callback_url</code> é altamente recomendado para acompanhar a atualização do status da transação.</p>\n</li>\n</ol>\n<hr />\n<h3 id=\"possíveis-erros\"><strong>Possíveis Erros</strong></h3>\n<ul>\n<li><p><strong>400 Bad Request</strong>: Quando o corpo da requisição contém dados inválidos, como não fornecer um <code>pix_key</code> nem um <code>emv</code>.</p>\n</li>\n<li><p><strong>400 Bad Request</strong>: Quando ambos <code>pix_key</code> e <code>emv</code> são fornecidos simultaneamente.</p>\n</li>\n<li><p><strong>404 Not Found</strong>: Quando a chave PIX fornecida não está associada a uma conta válida.</p>\n</li>\n<li><p><strong>402 Payment Required</strong>: Quando o saldo da empresa é insuficiente para realizar a transferência.</p>\n</li>\n</ul>\n","urlObject":{"path":["transactions","transfers"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"577637cb-f3c1-4372-b45c-ec579fee3826","name":"Use uma chave PIX","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"value\": 100.50,                // Valor da transferência\n  \"pix_key\": \"123456789012\",      // Chave Pix do destinatário\n  \"pix_key_type\": \"pixCPF\",       // Tipo de chave Pix, ex: \"pixCPF\", \"pixCNPJ\"\n  \"callback_url\": \"http://yourcallbackurl.com/callback\"  // URL de callback opcional\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transactions/transfers"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"8abeaf3b-af28-4859-a42f-72075f792008","name":"Use um codigo copia e cola","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n  \"value\": 100.50,                // Valor da transferência\n  \"emv\":\"00020101021234567...\", // EMV (Código copia e cola)\n  \"callback_url\": \"http://yourcallbackurl.com/callback\"  // URL de callback opcional\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transactions/transfers"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"64b1cc04-eb63-431c-8d11-0c32d09afee4"}],"id":"1ebda495-71fa-47b5-b8a9-cc5b725cfa77","description":"<p>Utilize a API Gateway da <strong>StubPay</strong> e embarque nessa jornada agora mesmo!</p>\n","_postman_id":"1ebda495-71fa-47b5-b8a9-cc5b725cfa77"},{"name":"Transações","item":[{"name":"Listar transações","id":"0880bb9f-8b44-480a-b779-ca8263ed396e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n    \"filters\": {\r\n        \"id\": \"64fbc8cd9ec5b12345abc123\", // Filtro pelo ID da transação. Opcional.\r\n        \"term\": \"João Silva\", // Texto para busca em nome, documento ou chave PIX. Opcional.\r\n        \"env\": \"API_DASH\", // Ambiente da transação (ex.: \"API_DASH\", \"API_INTERNAL\"). Opcional.\r\n        \"min_value\": 100.0, // Valor mínimo para o filtro. Opcional.\r\n        \"max_value\": 500.0, // Valor máximo para o filtro. Opcional.\r\n        \"companies\": [\r\n            \"Empresa X\",\r\n            \"Empresa Y\"\r\n        ], // Lista de nomes das empresas para filtrar. Opcional.\r\n        \"users\": [\r\n            \"usuario1\",\r\n            \"usuario2\"\r\n        ], // Lista de logins de usuários para filtrar. Opcional.\r\n        \"types\": [\r\n            \"type1\",\r\n            \"type2\"\r\n        ], // Lista de tipos de transação para filtrar. Opcional.\r\n        \"statuses\": [\r\n            \"status1\",\r\n            \"status2\"\r\n        ], // Lista de status das transações para filtrar. Opcional.\r\n        // Período de datas para filtrar as transações. Formato: dd/MM/yyyy. Opcional.\r\n        \"date\": {\r\n            \"from\": \"01/01/2024\", // Data inicial do período. Opcional.\r\n            \"to\": \"31/01/2024\" // Data final do período. Opcional.\r\n        },\r\n        \"company_id\": \"64fbc8cd9ec5b12345abc678\" // ID da empresa associada à transação. Opcional.\r\n    },\r\n    \"sorting\": {\r\n        \"created_at\": \"desc\" // Define o campo e a ordem para ordenação. Exemplo: \"desc\" para descendente. Opcional.\r\n    },\r\n    \"pagination\": {\r\n        \"page\": 1, // Número da página para paginação. Começa em 1. Opcional.\r\n        \"limit\": 10 // Número de itens por página. Opcional.\r\n    }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transactions/search","description":"<h3 id=\"descrição\">Descrição</h3>\n<p>Busca transações com base nos filtros fornecidos. Suporta ordenação, paginação e diversas opções de filtros.</p>\n<h4 id=\"request-body\">Request (Body)</h4>\n<p>Segue a tabela com os campos devidamente organizados:</p>\n<hr />\n<h3 id=\"campos-do-body\">Campos do Body</h3>\n<h4 id=\"filters-objeto-contendo-os-critérios-de-busca\">Filters (Objeto contendo os critérios de busca):</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Variável</th>\n<th>Obrigatório</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>id</code></td>\n<td>Não</td>\n<td>String</td>\n<td>ID da transação.</td>\n</tr>\n<tr>\n<td><code>term</code></td>\n<td>Não</td>\n<td>String</td>\n<td>Texto para busca em nome, documento ou chave PIX.</td>\n</tr>\n<tr>\n<td><code>env</code></td>\n<td>Não</td>\n<td>String</td>\n<td>Ambiente (ex.: <code>API_DASH</code>, <code>API_INTERNAL</code>).</td>\n</tr>\n<tr>\n<td><code>min_value</code></td>\n<td>Não</td>\n<td>Number</td>\n<td>Valor mínimo para o filtro.</td>\n</tr>\n<tr>\n<td><code>max_value</code></td>\n<td>Não</td>\n<td>Number</td>\n<td>Valor máximo para o filtro.</td>\n</tr>\n<tr>\n<td><code>companies</code></td>\n<td>Não</td>\n<td>Array[String]</td>\n<td>Lista de nomes das empresas.</td>\n</tr>\n<tr>\n<td><code>users</code></td>\n<td>Não</td>\n<td>Array[String]</td>\n<td>Lista de logins de usuários.</td>\n</tr>\n<tr>\n<td><code>types</code></td>\n<td>Não</td>\n<td>Array[String]</td>\n<td>Lista de tipos de transação.</td>\n</tr>\n<tr>\n<td><code>statuses</code></td>\n<td>Não</td>\n<td>Array[String]</td>\n<td>Lista de status.</td>\n</tr>\n<tr>\n<td><code>date.from</code></td>\n<td>Não</td>\n<td>String</td>\n<td>Data inicial no formato <code>dd/MM/yyyy</code>.</td>\n</tr>\n<tr>\n<td><code>date.to</code></td>\n<td>Não</td>\n<td>String</td>\n<td>Data final no formato <code>dd/MM/yyyy</code>.</td>\n</tr>\n<tr>\n<td><code>company_id</code></td>\n<td>Não</td>\n<td>String</td>\n<td>ID da empresa.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"sorting-objeto-para-ordenação\">Sorting (Objeto para ordenação):</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Variável</th>\n<th>Obrigatório</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>[campos]</code></td>\n<td>Não</td>\n<td>String</td>\n<td>Chaves correspondem aos campos, e valores podem ser <code>asc</code> ou <code>desc</code>.</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"pagination-objeto-para-paginação\">Pagination (Objeto para paginação):</h4>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Campo</th>\n<th>Obrigatório</th>\n<th>Tipo</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>page</code></td>\n<td>Não</td>\n<td>Number</td>\n<td>Número da página (começa em 1).</td>\n</tr>\n<tr>\n<td><code>limit</code></td>\n<td>Não</td>\n<td>Number</td>\n<td>Número de itens por página.</td>\n</tr>\n</tbody>\n</table>\n</div><hr />\n<h4 id=\"resposta-exemplo\">Resposta (Exemplo):</h4>\n<p><strong>Status 200:</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"statusCode\": 200,\n  \"data\": {\n    \"transactions\": [\n      {\n        \"_id\": \"64fbc8cd9ec5b12345abc123\",\n        \"value\": 300.0,\n        \"created_at\": \"2024-01-15T10:00:00Z\",\n        \"type\": \"type1\",\n        \"status\": \"status1\",\n        \"sender\": {\n          \"login\": \"usuario1\"\n        },\n        \"company\": {\n          \"name\": \"Empresa X\"\n        }\n      }\n    ],\n    \"pagination\": {\n      \"page\": 1,\n      \"total\": 1,\n      \"limit\": 10\n    }\n  }\n}\n\n</code></pre>\n<p><strong>Status 400 (Erro de Validação):</strong></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"statusCode\": 400,\n  \"message\": \"Payload inválido\",\n  \"details\": [\"O campo 'filters.date.from' deve estar no formato 'dd/MM/yyyy'.\"]\n}\n\n</code></pre>\n","urlObject":{"path":["transactions","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0880bb9f-8b44-480a-b779-ca8263ed396e"},{"name":"Buscar por id","id":"a4ce5f44-b67a-4b48-a24f-a078c551ab2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/transactions/:id","description":"<h3 id=\"descrição\">Descrição</h3>\n<p>Endpoint para obter os detalhes de uma transação específica com base no ID.</p>\n<h3 id=\"request-path-variables\">Request (Path variables)</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Variável</strong></th>\n<th><strong>Obrigatório</strong></th>\n<th><strong>Descrição</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>Sim</td>\n<td>ID único da transação desejada</td>\n</tr>\n</tbody>\n</table>\n</div><h4 id=\"resposta-de-sucesso\"><strong>Resposta de Sucesso</strong></h4>\n<p><strong>Status Code:</strong> <code>200 OK</code></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"success\",\n  \"data\": {\n    \"id\": \"64fbc8cd9ec5b12345abc123\",\n    \"amount\": 150.00,\n    \"status\": \"completed\",\n    \"date\": \"2024-01-15\",\n    \"company_name\": \"Empresa X\",\n    \"user_name\": \"João Silva\",\n    \"details\": {\n      \"payment_method\": \"PIX\",\n      \"transaction_type\": \"debit\"\n    }\n  }\n}\n\n</code></pre>\n<h4 id=\"resposta-de-erro\"><strong>Resposta de Erro</strong></h4>\n<p><strong>Status Code:</strong> <code>404 Not Found</code></p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"error\",\n  \"message\": \"Transação não encontrada.\"\n}\n\n</code></pre>\n","urlObject":{"path":["transactions",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"e81e4997-f72a-4759-a0dc-ba79551a7016","name":"busca por id","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"filters\": {\r\n    \"id\": \"66a052737815c989eacbcf35\" // filtrar pelo id da transação\r\n  },\r\n  \"pagination\": {\r\n    \"page\": 1,\r\n    \"limit\": 20\r\n  }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/integrations/transactions/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2e79c427-472f-414d-9276-2277d6891f00","name":"busca por cliente","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"filters\": {\r\n\t \"term\": \"00011122253\" // filtrar por nome de cliente, documento cpf/cnpj de cliente ou pix_key\r\n   },\r\n  \"pagination\": {\r\n    \"page\": 1,\r\n    \"limit\": 20\r\n  }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/integrations/transactions/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"a05ba8a6-ee74-4bab-9fc6-b4f6adee8d21","name":"busca por status","originalRequest":{"method":"POST","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n  \"filters\": {\r\n    \"statuses\": [\"PENDING\", \"APPROVED\", \"CANCELED\", \"REFUNDED\"] // deve ser um array com um ou mais valores\r\n  },\r\n  \"pagination\": {\r\n    \"page\": 1,\r\n    \"limit\": 20\r\n  }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/integrations/transactions/search"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a4ce5f44-b67a-4b48-a24f-a078c551ab2c"}],"id":"54dd211d-2651-45e2-aab4-d981f3b6d89e","_postman_id":"54dd211d-2651-45e2-aab4-d981f3b6d89e","description":""},{"name":"Comprovantes","item":[{"name":"Obter comprovante de transferência","id":"18ef7c34-8000-4e5d-9fea-60ba6fae8a0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"client_id","value":"<YOUR_CLIENT_ID>","type":"text"},{"key":"client_secret","value":"<YOUR_CLIENT_SECRET>","type":"text"},{"key":"content-type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/transactions/receipts/:id","description":"<h3 id=\"descrição\">Descrição</h3>\n<p>Obter o comprovante de uma transferência específica fornecendo seu ID.</p>\n<h3 id=\"request-params\">Request (Params)</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Parâmetro</th>\n<th>Tipo</th>\n<th>Obrigatório</th>\n<th>Descrição</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>string</td>\n<td>Sim</td>\n<td>O ID único da transação.</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"resposta-de-sucesso-200-ok\">Resposta de Sucesso (200 OK)</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"Success\",\n  \"statusCode\": 200,\n  \"message\": \"Comprovante recebido\",\n  \"data\": {\n    \"receipt\": \"conteudo-comprovante-base64\"\n  }\n}\n\n</code></pre>\n<h3 id=\"respostas-de-erro\">Respostas de Erro</h3>\n<h4 id=\"404-not-found\">404 Not Found</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"Failed\",\n  \"statusCode\": 404,\n  \"message\": \"Transação não encontrada\"\n}\n\n</code></pre>\n<h4 id=\"500-internal-server-error\">500 Internal Server Error</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"Failed\",\n  \"statusCode\": 500,\n  \"message\": \"Ocorreu um erro inesperado.\"\n}\n\n</code></pre>\n<hr />\n<h3 id=\"notas\">Notas</h3>\n<ul>\n<li>Caso o comprovante já exista, ele será retornado de imediato. Se não, precisará gerado. Este processo demora alguns milisegundos.</li>\n</ul>\n","urlObject":{"path":["transactions","receipts",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"<transaction_id>","key":"id"}]}},"response":[],"_postman_id":"18ef7c34-8000-4e5d-9fea-60ba6fae8a0b"}],"id":"5202b69d-f175-4875-90de-bf1b9aad7418","_postman_id":"5202b69d-f175-4875-90de-bf1b9aad7418","description":""}]}