{ "_type": "export", "__export_format": 4, "__export_date": "2026-08-14T00:00:00.000Z", "__export_source": "necta-payments-docs:generator", "resources": [ { "_id": "wrk_nectadocs", "_type": "workspace", "parentId": null, "name": "Necta.co API", "description": "Coleção gerada a partir da documentação pública (doc.nectaco.com.br). Preencha a variável token no Base Environment antes de usar.", "scope": "collection", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "env_base", "_type": "environment", "parentId": "wrk_nectadocs", "name": "Base Environment", "created": 1786650000000, "modified": 1786650000000, "isPrivate": false, "metaSortKey": 1786650000000, "color": null, "data": { "base_v1": "https://api.nectaco.com.br", "base_v2": "https://api-v2.nectaco.com.br", "token": "COLOQUE_SEU_TOKEN_AQUI" }, "dataPropertyOrder": { "&": [ "base_v1", "base_v2", "token" ] } }, { "_id": "jar_base", "_type": "cookie_jar", "parentId": "wrk_nectadocs", "name": "Default Jar", "cookies": [], "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_estabelecimentos", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Estabelecimentos", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 100, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-estabelecime-10", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar estabelecimento — pessoa física (typeEstablishmentDbId 1)", "description": "O estabelecimento é criado no gateway e na base da Necta na mesma requisição. O plano de venda é herdado do estabelecimento de origem. Quando a origem não possui plano configurado o cadastro é recusado com o código 400 e a mensagem Não é possível cadastrar o seller: o estabelecimento pai não possui plano de venda. O vínculo do plano no gateway acontece em uma etapa posterior à criação: se esse vínculo falhar o cadastro não é desfeito — a resposta traz o campo planLinkWarning e o estabelecimento passa para a situação Plano não vinculado quando já estava Aprovado; quando ainda está Aguardando Aprovação esse status é mantido.\n\nA rota também aceita os nomes de campos legados em português, mantidos por compatibilidade — por exemplo nome, razaoSocial, telefone, celular, cpf, cnpj, dataNascimento, categoria, endereco, proprietario e contaBancaria — equivalentes aos campos em inglês documentados.\n\nNo retorno com o código 202, quando o documento já existe, o objeto establishment também vem completo, no mesmo formato do retorno principal — o exemplo exibe apenas os campos principais.", "url": "{{ _.base_v2 }}/establishment", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"typeEstablishmentDbId\": 1,\n \"name\": \"Maria Exemplo\",\n \"invoiceIdentification\": \"MARIA EXEMPLO\",\n \"email\": \"exemplo@exemplo.com\",\n \"phone\": \"1133330000\",\n \"mobilePhone\": \"11999990000\",\n \"birthDate\": \"1990-05-20\",\n \"identificationDocument\": \"11144477735\",\n \"mcc\": 5411,\n \"categoryDescription\": \"Comércio varejista\",\n \"quantityPOS\": 1,\n \"estimatedRevenue\": 50000,\n \"observation\": \"Cadastro realizado pela API\",\n \"establishmentId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"termsAndConditionsAccepted\": true,\n \"desativarVendas\": false,\n \"sendEmail\": true,\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"complement\": \"Conjunto 101\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"postalCode\": \"01310100\"\n },\n \"bankAccount\": {\n \"holderName\": \"Maria Exemplo\",\n \"bankId\": 1,\n \"bankCode\": \"341\",\n \"routingNumber\": \"1234\",\n \"accountNumber\": \"987654\",\n \"type\": \"checking\",\n \"identificationDocument\": \"11144477735\"\n },\n \"pos\": {\n \"count\": 1,\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"complement\": \"Loja 2\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"postalCode\": \"01310100\"\n }\n }\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-estabelecime-20", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar estabelecimento — pessoa jurídica (typeEstablishmentDbId 2)", "description": "O estabelecimento é criado no gateway e na base da Necta na mesma requisição. O plano de venda é herdado do estabelecimento de origem. Quando a origem não possui plano configurado o cadastro é recusado com o código 400 e a mensagem Não é possível cadastrar o seller: o estabelecimento pai não possui plano de venda. O vínculo do plano no gateway acontece em uma etapa posterior à criação: se esse vínculo falhar o cadastro não é desfeito — a resposta traz o campo planLinkWarning e o estabelecimento passa para a situação Plano não vinculado quando já estava Aprovado; quando ainda está Aguardando Aprovação esse status é mantido.\n\nA rota também aceita os nomes de campos legados em português, mantidos por compatibilidade — por exemplo nome, razaoSocial, telefone, celular, cpf, cnpj, dataNascimento, categoria, endereco, proprietario e contaBancaria — equivalentes aos campos em inglês documentados.\n\nNo retorno com o código 202, quando o documento já existe, o objeto establishment também vem completo, no mesmo formato do retorno principal — o exemplo exibe apenas os campos principais.", "url": "{{ _.base_v2 }}/establishment", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"typeEstablishmentDbId\": 2,\n \"name\": \"Estabelecimento Exemplo\",\n \"businessName\": \"Estabelecimento Exemplo LTDA\",\n \"invoiceIdentification\": \"ESTAB EXEMPLO\",\n \"email\": \"financeiro@exemplo.com\",\n \"phone\": \"1133330000\",\n \"mobilePhone\": \"11999990000\",\n \"identificationDocument\": \"11444777000161\",\n \"mcc\": 5411,\n \"categoryDescription\": \"Comércio varejista\",\n \"quantityPOS\": 0,\n \"estimatedRevenue\": 250000,\n \"establishmentId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"termsAndConditionsAccepted\": true,\n \"desativarVendas\": false,\n \"sendEmail\": false,\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"complement\": \"Andar 12\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"postalCode\": \"01310100\"\n },\n \"bankAccount\": {\n \"holderName\": \"Estabelecimento Exemplo LTDA\",\n \"bankId\": 1,\n \"bankCode\": \"341\",\n \"routingNumber\": \"1234\",\n \"accountNumber\": \"987654\",\n \"type\": \"checking\",\n \"identificationDocument\": \"11444777000161\"\n },\n \"owner\": {\n \"name\": \"Jose\",\n \"lastName\": \"Exemplo\",\n \"email\": \"exemplo@exemplo.com\",\n \"identificationDocument\": \"11144477735\",\n \"birthDate\": \"1985-03-12\",\n \"mobilePhone\": \"11999990000\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"complement\": \"Apartamento 45\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"postalCode\": \"01310100\"\n }\n }\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-listar-estabelecimentos-30", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Listar Estabelecimentos", "description": "", "url": "{{ _.base_v2 }}/establishment/list", "method": "GET", "body": {}, "parameters": [ { "name": "page", "value": "0", "description": "Número de páginas", "disabled": true }, { "name": "limit", "value": "2", "description": "Define a quantidade de estabelecimentos a serem exibidos por página", "disabled": true }, { "name": "omni", "value": "", "description": "Campo utilizado como ferramenta de pesquisa", "disabled": true }, { "name": "documento", "value": "", "description": "Campo utilizado para buscar estabelecimentos por documento", "disabled": true }, { "name": "situacaoEstabelecimento", "value": "", "description": "Campo utilizado para filtrar estabelecimentos pelo status Id", "disabled": true }, { "name": "nomeComprovante", "value": "", "description": "Campo utilizado para filtrar estabelecimentos pela identificação fatura", "disabled": true }, { "name": "parentId", "value": "", "description": "Identifica a qual estabelecimento está vinculado", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-consultar-token-40", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Consultar Token", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{idEstabelecimento}/token", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-consultar-saldo-50", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Consultar Saldo", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{idEstabelecimento}/saldo", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-consultar-estabelecimen-60", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Consultar estabelecimento por documento", "description": "A busca é restrita ao marketplace do token utilizado. O retorno é um resumo do estabelecimento — para os dados completos use a consulta de detalhes.", "url": "{{ _.base_v2 }}/establishment/per_document/{documento}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 60, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-habilitar-estabelecime-70", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Habilitar estabelecimento", "description": "Requisição sem corpo — os dados vão na própria URL.", "url": "{{ _.base_v1 }}/estabelecimentos/{idEstabelecimento}/habilitar", "method": "POST", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 70, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-delete-desabilitar-estabele-80", "_type": "request", "parentId": "fld_estabelecimentos", "name": "DELETE · Desabilitar estabelecimento", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{idEstabelecimento}/desabilitar", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 80, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-habilitar-pos-90", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Habilitar POS", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{estabelecimentoId}/habilitar_pos/{token}", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"EstabelecimentoId\": \"\",\n \"Token\": \"\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 90, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-put-habilitar-desabilitar-s-100", "_type": "request", "parentId": "fld_estabelecimentos", "name": "PUT · Habilitar / Desabilitar Split", "description": "Requisição sem corpo — os dados vão na própria URL.", "url": "{{ _.base_v1 }}/estabelecimentos/{estabelecimentoId}/splits/{splitId}/status", "method": "PUT", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 100, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-split-sem-li-110", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar split sem limite de data e valor", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/:id/splits", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"dataFim\": null,\n \"dataInicio\": null,\n \"estabelecimentos\": [\n {\n \"chargeProcessingFee\": true,\n \"estabelecimentoId\": 10564,\n \"tipoSplit\": 2,\n \"valor\": 1\n }\n ],\n \"valorMaximo\": null\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 110, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-split-com-li-120", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar split com limite de data", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/:id/splits", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"dataInicio\": \"2023-03-03\",\n \"dataFim\": \"2023-04-03\",\n \"estabelecimentos\": [\n {\n \"chargeProcessingFee\": 0,\n \"estabelecimentoId\": 10564,\n \"tipoSplit\": 2,\n \"valor\": 1\n }\n ],\n \"valorMaximo\": null\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 120, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-split-com-li-130", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar split com limite de data e valor", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/:id/splits", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"dataFim\": \"2023-05-03\",\n \"dataInicio\": \"2023-04-04\",\n \"estabelecimentos\":[\n {\n \"chargeProcessingFee\":0,\n \"estabelecimentoId\":'7ef89929-6502-4dd8-a6e7-3a75f78feae2',\n \"tipoSplit\":2,\n \"valor\":1\n }\n ],\n \"valorMaximo\": 10\n }" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 130, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-proximos-lancamentos-di-140", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Próximos lançamentos diários", "description": "Retorna o total a receber e a distribuição dos recebíveis pendentes cuja data de recebimento cai no dia informado.", "url": "{{ _.base_v2 }}/establishment/upcoming-daily-releases?date=2026-08-01", "method": "GET", "body": {}, "parameters": [ { "name": "estabelecimentoId", "value": "240118", "description": "Opcional. Identificador numérico do estabelecimento a ser consultado. Quando ausente assume o estabelecimento do token", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 140, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-put-alterar-marketplace-pai-150", "_type": "request", "parentId": "fld_estabelecimentos", "name": "PUT · Alterar marketplace pai", "description": "A alteração exige usuário administrador do marketplace principal. Tokens de marketplace filho são recusados antes de qualquer outra validação, com a mensagem Marketplace filho não pode alterar o estabelecimento pai. O estabelecimento indicado em parentId precisa pertencer ao mesmo marketplace e ter o parâmetro de operar como marketplace ativo. Estruturas circulares são recusadas.", "url": "{{ _.base_v2 }}/establishment/{id}/change-parent", "method": "PUT", "body": { "mimeType": "application/json", "text": "{\n \"parentId\": \"8c53d4f7-2b91-4a68-9e05-7d1f3a6b2c84\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 150, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-enviar-documento-kyc-m-160", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Enviar documento KYC — multipart", "description": "Cada requisição envia um único arquivo. Para completar o KYC, repita a chamada uma vez por tipo de documento.\n\nO documento é enviado ao gateway na mesma requisição — uma recusa do gateway é devolvida como erro. A aprovação ou reprovação posterior chega por webhook.\n\nEnviar novamente um tipo que já existe substitui o documento anterior. Quando há documentos de CNH e de RG no mesmo estabelecimento apenas um dos conjuntos é enviado ao gateway, com precedência da CNH — remova os documentos do conjunto que não vai usar.", "url": "{{ _.base_v2 }}/establishment/{id}/kyc-documents", "method": "POST", "body": { "params": [ { "name": "type", "value": "SELFIE" }, { "name": "file", "type": "file", "fileName": "" } ], "mimeType": "multipart/form-data" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "multipart/form-data" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 160, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-get-listar-documentos-kyc-170", "_type": "request", "parentId": "fld_estabelecimentos", "name": "GET · Listar documentos KYC", "description": "O retorno separa os documentos já enviados dos tipos que ainda faltam. O campo ready indica se o conjunto mínimo foi atingido: a selfie mais uma das combinações aceitas de documento de identificação.\n\nAs URLs devolvidas em uploaded são temporárias e expiram em 10 minutos. Para exibir o arquivo depois desse prazo, consulte a lista novamente.", "url": "{{ _.base_v2 }}/establishment/{id}/kyc-documents", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 170, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-delete-remover-documento-ky-180", "_type": "request", "parentId": "fld_estabelecimentos", "name": "DELETE · Remover documento KYC", "description": "A remoção vale para os documentos guardados pela Necta e não desfaz a verificação já concluída no gateway. Use esta rota para descartar um documento enviado por engano ou para deixar apenas um conjunto de identificação no estabelecimento.\n\nEm caso de sucesso a resposta é HTTP 204, sem corpo.", "url": "{{ _.base_v2 }}/establishment/{id}/kyc-documents/{documentId}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 180, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-post-cadastrar-repasse-de-t-190", "_type": "request", "parentId": "fld_estabelecimentos", "name": "POST · Cadastrar repasse de taxas", "description": "A rota cria as regras de repasse fixo aplicadas a todas as vendas do estabelecimento indicado em establishmentId. Cada regra do array splits define um recebedor e o valor repassado, em percentual ou em valor.\n\nCada chamada substitui por completo as regras de repasse cadastradas anteriormente para o estabelecimento. Para manter uma regra existente, envie-a novamente junto das demais.\n\nTodos os estabelecimentos envolvidos precisam pertencer ao mesmo marketplace. O array splits não pode ser vazio.", "url": "{{ _.base_v2 }}/establishment/split-pass-fee", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"establishmentId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"passRate\": true,\n \"splits\": [\n {\n \"establishmentId\": 240125,\n \"percentage\": 5\n },\n {\n \"establishmentId\": 240126,\n \"amount\": 500\n }\n ]\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 190, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_estabelecimentos-delete-remover-repasse-de-t-200", "_type": "request", "parentId": "fld_estabelecimentos", "name": "DELETE · Remover repasse de taxas", "description": "Remove uma única regra de repasse de taxas. As vendas já realizadas não são alteradas — a regra deixa de valer para as vendas seguintes.", "url": "{{ _.base_v2 }}/establishment/split-pass-fee/{id}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 200, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_pre-cadastro-de-estabelecimento", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Pré-cadastro de estabelecimento", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 200, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_pre-cadastro-de-estabelecimento-post-cadastr-10", "_type": "request", "parentId": "fld_pre-cadastro-de-estabelecimento", "name": "POST · Cadastrar pré-estabelecimento", "description": "Rota pública — não requer autenticação.\n\nA rota aceita duas formas de envio, com o mesmo resultado: application/json , para enviar apenas os dados cadastrais, e multipart/form-data , para enviar os mesmos dados já acompanhados dos arquivos de documentos KYC em uma única chamada. Quem usa a forma JSON envia os documentos depois, pela rota de envio de documento KYC do pré-cadastro.\n\nO pré-cadastro é criado com status Aguardando Aprovação e só passa a existir como estabelecimento no marketplace após a revisão com a ação approve . O campo dbId devolvido no retorno é o identificador usado nas rotas de documentos KYC e de revisão. Nos marketplaces com aprovação automática habilitada, a aprovação acontece já na criação, sem chamada de revisão.", "url": "{{ _.base_v2 }}/pre-establishment", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"marketplaceId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"establishmentId\": \"7c1d4e58-2fb3-4a90-9e61-5d0b8a3f2c74\",\n \"typeEstablishmentDbId\": 1,\n \"name\": \"Maria Exemplo\",\n \"invoiceIdentification\": \"Maria Exemplo\",\n \"email\": \"exemplo@exemplo.com\",\n \"phone\": 11999990000,\n \"mobilePhone\": 11999990000,\n \"birthDate\": \"1990-05-10\",\n \"identificationDocument\": \"11144477735\",\n \"mcc\": 18,\n \"categoryDescription\": \"Serviços diversos\",\n \"estimatedRevenue\": 10000,\n \"observation\": \"\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"neighborhood\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postalCode\": \"01310100\"\n },\n \"bankAccount\": {\n \"holderName\": \"Maria Exemplo\",\n \"bankId\": 1,\n \"bankCode\": \"001\",\n \"routingNumber\": \"0001\",\n \"accountNumber\": \"123456\",\n \"type\": \"checking\",\n \"identificationDocument\": \"11144477735\"\n },\n \"termsAndConditionsAccepted\": true,\n \"termsAcceptedAt\": \"2026-08-01T12:00:00.000Z\",\n \"termsVersion\": \"1.0\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": {}, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_pre-cadastro-de-estabelecimento-post-cadastr-20", "_type": "request", "parentId": "fld_pre-cadastro-de-estabelecimento", "name": "POST · Cadastrar pré-estabelecimento — multipart", "description": "Rota pública — não requer autenticação.\n\nA rota aceita duas formas de envio, com o mesmo resultado: application/json , para enviar apenas os dados cadastrais, e multipart/form-data , para enviar os mesmos dados já acompanhados dos arquivos de documentos KYC em uma única chamada. Quem usa a forma JSON envia os documentos depois, pela rota de envio de documento KYC do pré-cadastro.\n\nO pré-cadastro é criado com status Aguardando Aprovação e só passa a existir como estabelecimento no marketplace após a revisão com a ação approve . O campo dbId devolvido no retorno é o identificador usado nas rotas de documentos KYC e de revisão. Nos marketplaces com aprovação automática habilitada, a aprovação acontece já na criação, sem chamada de revisão.", "url": "{{ _.base_v2 }}/pre-establishment", "method": "POST", "body": { "params": [ { "name": "payload", "value": "{\"marketplaceId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\", \"typeEstablishmentDbId\": 1, \"name\": \"Maria Exemplo\", \"email\": \"exemplo@exemplo.com\", \"identificationDocument\": \"11144477735\"}" }, { "name": "kyc_selfie", "type": "file", "fileName": "" }, { "name": "kyc_cnh_full", "type": "file", "fileName": "" }, { "name": "kyc_cnh_front", "type": "file", "fileName": "" }, { "name": "kyc_cnh_back", "type": "file", "fileName": "" }, { "name": "kyc_rg_front", "type": "file", "fileName": "" }, { "name": "kyc_rg_back", "type": "file", "fileName": "" } ], "mimeType": "multipart/form-data" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "multipart/form-data" } ], "authentication": {}, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_pre-cadastro-de-estabelecimento-get-listar-d-30", "_type": "request", "parentId": "fld_pre-cadastro-de-estabelecimento", "name": "GET · Listar documentos KYC do pré-cadastro", "description": "O retorno separa o que já foi recebido em uploaded e o que ainda falta em pendingUpload . O campo ready indica se o conjunto mínimo exigido para a aprovação já está completo, que é a selfie somada a um documento de identificação: CNH aberta, CNH frente e verso, RG frente e verso ou CREF.\n\nCada documento recebido traz em file.signedUrl um endereço temporário de leitura do arquivo. O endereço vale 120 segundos e é gerado a cada consulta.", "url": "{{ _.base_v2 }}/pre-establishment/{id}/kyc-documents", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_pre-cadastro-de-estabelecimento-post-enviar--40", "_type": "request", "parentId": "fld_pre-cadastro-de-estabelecimento", "name": "POST · Enviar documento KYC do pré-cadastro", "description": "Cada requisição envia um único arquivo. Para completar o KYC, repita a chamada uma vez por tipo de documento.\n\nEnviar novamente um tipo que já existe substitui o documento anterior. Os tipos de CNH e de RG não podem ser combinados no mesmo pré-cadastro: para trocar de um para o outro, remova primeiro os documentos já enviados.\n\nFormatos aceitos: PNG, JPEG, BMP, WEBP, HEIC, HEIF e PDF. Envie o arquivo com o MIME type declarado; em PDF sem MIME type a requisição é recusada.", "url": "{{ _.base_v2 }}/pre-establishment/{id}/kyc-documents", "method": "POST", "body": { "params": [ { "name": "type", "value": "SELFIE" }, { "name": "file", "type": "file", "fileName": "" } ], "mimeType": "multipart/form-data" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "multipart/form-data" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_pre-cadastro-de-estabelecimento-post-revisar-50", "_type": "request", "parentId": "fld_pre-cadastro-de-estabelecimento", "name": "POST · Revisar pré-cadastro", "description": "Com a ação approve , o estabelecimento é criado no marketplace, os documentos KYC são encaminhados ao adquirente e o pré-cadastro é encerrado como aprovado. A aprovação exige o KYC completo, ou seja, a selfie somada a um documento de identificação. Com a ação reject , o pré-cadastro é encerrado como reprovado e nenhum estabelecimento é criado. Em marketplaces sem aprovação automática, o pré-cadastro aprovado continua listado como Aguardando Aprovação na fila, embora já esteja aprovado.\n\nA revisão só pode ser feita uma vez: um pré-cadastro já aprovado ou já reprovado não é processado novamente.\n\nQuando a criação do estabelecimento é recusada pelo adquirente, a resposta repassa o status e a mensagem devolvidos por ele no campo error . Se o estabelecimento for criado mas algum documento falhar no envio ao adquirente, a resposta traz kycUploadErrors com os tipos que precisam ser reenviados.", "url": "{{ _.base_v2 }}/pre-establishment/{id}/review", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"action\": \"approve\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_contas-bancarias", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Contas bancárias", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 300, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_contas-bancarias-post-cadastrar-conta-bancar-10", "_type": "request", "parentId": "fld_contas-bancarias", "name": "POST · Cadastrar conta bancária", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/contas_bancarias", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoContaBancaria\": 1,\n \"nomeTitular\": \"Integração Nectaco\",\n \"bancoId\": 2,\n \"agencia\": \"0000\",\n \"conta\": \"000000\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_contas-bancarias-get-listar-conta-bancaria-20", "_type": "request", "parentId": "fld_contas-bancarias", "name": "GET · Listar conta bancária", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/contas_bancarias", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_contas-bancarias-put-selecionar-conta-bancar-30", "_type": "request", "parentId": "fld_contas-bancarias", "name": "PUT · Selecionar conta bancária", "description": "Requisição sem corpo — os dados vão na própria URL.", "url": "{{ _.base_v1 }}/estabelecimentos/estabelecimentoid/contas_bancarias/{id}/ativar", "method": "PUT", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_contas-bancarias-delete-remover-uma-conta-ba-40", "_type": "request", "parentId": "fld_contas-bancarias", "name": "DELETE · Remover uma conta bancária", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{EstabelecimentoId}/contas_bancarias/{ContaBancariaId}/excluir", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_contas-bancarias-post-payout-automatico-paga-50", "_type": "request", "parentId": "fld_contas-bancarias", "name": "POST · Payout automático - pagamento em conta", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/{estabelecimentoId}/politicaRecebimento/{parametro}", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"parametro=0\": \"\",\n \"parametro=1\": \"\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_transferencias", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Transferências", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 400, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_transferencias-post-transferir-ou-agendar-tr-10", "_type": "request", "parentId": "fld_transferencias", "name": "POST · Transferir ou Agendar Transferência", "description": "", "url": "{{ _.base_v1 }}/transferencias", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoTransferencia\": 2,\n \"valor\": 0.1,\n \"toEstabelecimentoId\": null,\n \"contaBancariaId\": 27,\n \"senha\": \"SUA_SENHA\",\n \"descricao\": \"pagamento\",\n \"agendadoPara\": \"2019-12-05T20:18:22.851Z\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_transferencias-get-visualizar-transferencias-20", "_type": "request", "parentId": "fld_transferencias", "name": "GET · Visualizar transferências", "description": "", "url": "{{ _.base_v1 }}/transferencias", "method": "GET", "body": {}, "parameters": [ { "name": "limit", "value": "200", "description": "Limite de transferências por página", "disabled": true }, { "name": "current", "value": "0", "description": "numero atual da pagina", "disabled": true }, { "name": "totalRows", "value": "0", "description": "total de itens por página", "disabled": true }, { "name": "startDate", "value": "2020-03-21", "description": "Data inicial a ser pesquisada", "disabled": true }, { "name": "endDate", "value": "2022-08-22", "description": "Data final a ser pesquisada", "disabled": true }, { "name": "omni", "value": "", "description": "numero de documento", "disabled": true }, { "name": "omni2", "value": "", "description": "nome do estabeleciemento", "disabled": true }, { "name": "status[ ]", "value": "", "description": "1 = Pendente 2 = Aprovado 3 = Cancelada", "disabled": true }, { "name": "tipo[ ]", "value": "", "description": "1 = Conta Digital 2 = Conta Bancária 3 = Automática", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_transferencias-get-visualizar-transferencias-30", "_type": "request", "parentId": "fld_transferencias", "name": "GET · Visualizar transferências agendadas", "description": "", "url": "{{ _.base_v1 }}/transferencias/agendadas/{tipoTransferenciaId}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_transferencias-post-tipo-de-recebimento-40", "_type": "request", "parentId": "fld_transferencias", "name": "POST · Tipo de recebimento", "description": "Requisição sem corpo — os dados vão na própria URL.", "url": "{{ _.base_v1 }}/estabelecimentos/{estabelecimentoId}/politicaRecebimento/{tipoDeRecebimentoId}", "method": "POST", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_transferencias-delete-remover-transferencias-50", "_type": "request", "parentId": "fld_transferencias", "name": "DELETE · Remover transferências agendadas", "description": "", "url": "{{ _.base_v1 }}/transferencias/{idTransfencia}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_extrato", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Extrato", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 500, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_extrato-get-listar-extrato-10", "_type": "request", "parentId": "fld_extrato", "name": "GET · Listar extrato", "description": "O estabelecimento e o marketplace da consulta são obtidos do token informado. Para consultar um estabelecimento subordinado, utilize o parâmetro estabelecimentoId .", "url": "{{ _.base_v2 }}/bank-statement/list?page=1&limit=50&startDate=2026-08-01&endDate=2026-08-31&detalhado=true", "method": "GET", "body": {}, "parameters": [ { "name": "tipoTransacao", "value": "Venda", "description": "Opcional. Filtra pelo tipo do lançamento. Valores utilizados pelo painel: Venda, Split, Split Regra, Split Taxa, Estornado, in (transferência de entrada) e out ", "disabled": true }, { "name": "method", "value": "credit", "description": "Opcional. Filtra pela forma de pagamento do lançamento: credit, debit, pix, split, bankSlip, comission, p2pTransfer, bankTransfer ou automatic", "disabled": true }, { "name": "estabelecimentoId", "value": "41234", "description": "Opcional. Identificador numérico de um estabelecimento subordinado ao token, para consultar o extrato dele. O estabelecimento informado precisa ser filho ou net", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_extrato-get-saldo-diario-20", "_type": "request", "parentId": "fld_extrato", "name": "GET · Saldo diário", "description": "O objeto rangeDate é enviado na query string com as chaves entre colchetes, no formato rangeDate[gte] e rangeDate[lte] . O estabelecimento consultado é o do token, salvo quando estabelecimentoId é informado.", "url": "{{ _.base_v2 }}/bank-statement/daily-balance?rangeDate[gte]=2026-08-01 00:00:00&rangeDate[lte]=2026-08-31 23:59:59", "method": "GET", "body": {}, "parameters": [ { "name": "estabelecimentoId", "value": "41234", "description": "Opcional. Identificador numérico do estabelecimento cujo saldo será consultado, em vez do estabelecimento do token. A rota não valida a hierarquia: apenas verif", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_clientes", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Clientes", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 600, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_clientes-post-cadastrar-cliente-10", "_type": "request", "parentId": "fld_clientes", "name": "POST · Cadastrar cliente", "description": "O cliente é criado vinculado ao estabelecimento do token utilizado na requisição e registrado no gateway de pagamento. O retorno de sucesso usa o status 201.\n\nNão é permitido cadastrar dois clientes com o mesmo documento no mesmo estabelecimento.\n\nErros possíveis: 401 quando o token está ausente ou inválido no header authorization; 500 para as recusas de cadastro, devolvidas no envelope error , entre elas documento já cadastrado para outro cliente no mesmo estabelecimento, campos obrigatórios ausentes, recusa do gateway de pagamento e usuário sem permissão — a criação é restrita aos grupos de id 1, 2, 7 e 10 (You do not have permission to create a customer).", "url": "{{ _.base_v2 }}/customer", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"name\": \"Maria Exemplo\",\n \"email\": \"exemplo@exemplo.com\",\n \"phone\": \"11999990000\",\n \"identificationDocument\": \"11144477735\",\n \"typeDocument\": 2,\n \"typeContact\": 2,\n \"birthDate\": \"1990-05-20\",\n \"gender\": \"F\",\n \"active\": 1,\n \"visible\": 1,\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"postalCode\": \"01310100\",\n \"neighborhood\": \"Bela Vista\",\n \"complement\": \"Sala 10\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"countryCode\": \"BR\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_clientes-post-vincular-cartao-a-um-cliente-20", "_type": "request", "parentId": "fld_clientes", "name": "POST · Vincular cartão a um cliente", "description": "", "url": "{{ _.base_v1 }}/clientes/{cliente_id}/cartoes", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"numero\": \"4111111111111111\",\n \"titular\": \"Joao Paulo \",\n \"codigoSeguranca\": \"069\",\n \"validade\": \"02/2025\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_clientes-delete-excluir-cliente-30", "_type": "request", "parentId": "fld_clientes", "name": "DELETE · Excluir Cliente", "description": "", "url": "{{ _.base_v1 }}/clientes/{ClienteId}/excluir", "method": "DELETE", "body": {}, "parameters": [ { "name": "clienteId", "value": "", "description": "Código de identificação do cliente", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_clientes-get-listar-cartoes-de-credito-40", "_type": "request", "parentId": "fld_clientes", "name": "GET · Listar Cartões de crédito", "description": "", "url": "{{ _.base_v1 }}/clientes/{clienteId}/cartoes", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_clientes-get-listar-clientes-50", "_type": "request", "parentId": "fld_clientes", "name": "GET · Listar clientes", "description": "Os campos de filters devem ser enviados um a um, na notação de colchetes: https://api-v2.nectaco.com.br/customer?page=1&limit=30&filters[document]=11144477735\n\nA listagem devolve os clientes do estabelecimento vinculado ao token. Usuários do grupo Administrador recebem os clientes de todo o marketplace e usuários de marketplace filho recebem os clientes do respectivo marketplace filho.\n\nErros possíveis: 401 quando o token está ausente ou inválido no header authorization.", "url": "{{ _.base_v2 }}/customer?page=1&limit=30&filters[document]=11144477735", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_usuarios", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Usuários", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 700, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_usuarios-post-cadastrar-usuario-10", "_type": "request", "parentId": "fld_usuarios", "name": "POST · Cadastrar usuário", "description": "", "url": "{{ _.base_v2 }}/user", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"establishment_id\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"selected_establishment_id\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"user\": {\n \"name\": \"Maria Exemplo\",\n \"email\": \"exemplo@exemplo.com\",\n \"password\": \"SUA_SENHA\",\n \"birth_date\": \"1990-05-20\",\n \"gender\": \"F\",\n \"group_id\": 3,\n \"parent_id\": null,\n \"can_split\": false,\n \"additional_fee\": null\n },\n \"establishments\": [\n \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\"\n ],\n \"documents\": [\n {\n \"id\": null,\n \"document_type\": 2,\n \"document\": \"11144477735\"\n }\n ],\n \"contacts\": [\n {\n \"id\": null,\n \"contact_type\": 2,\n \"value\": \"11999990000\"\n }\n ],\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": 1000,\n \"postal_code\": \"01310100\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\",\n \"complement\": \"Sala 10\",\n \"neighborhood\": \"Bela Vista\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_usuarios-get-consultar-usuario-20", "_type": "request", "parentId": "fld_usuarios", "name": "GET · Consultar usuário", "description": "", "url": "{{ _.base_v1 }}/usuarios/{idUsuario}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_usuarios-put-editar-usuario-30", "_type": "request", "parentId": "fld_usuarios", "name": "PUT · Editar usuário", "description": "", "url": "{{ _.base_v1 }}/usuarios/{usuarioId}", "method": "PUT", "body": { "mimeType": "application/json", "text": "{\n \"usuario\": {\n \"nome\": \"Renan\",\n \"email\": \"exemplo@exemplo.com\",\n \"dataNascimento\": \"1998-01-01\",\n \"sexo\": \"M\",\n \"grupoId\": 2,\n \"parentId\": null\n },\n \"contatos\": [\n {\n \"tipoContato\": 1,\n \"valorContato\": \"11888888888\"\n },\n {\n \"tipoContato\": 2,\n \"valorContato\": \"11888888888\"\n }\n ],\n \"endereco\": {\n \"logradouro\": \"Rua Salvador Simoes\",\n \"numero\": \"801\",\n \"cep\": \"02920000\",\n \"cidade\": \"São Paulo\",\n \"estado\": \"SP\",\n \"complemento\": \"\",\n \"bairro\": \"Alto do Ipiranga\"\n },\n \"usuarioId\": \"12991\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_usuarios-delete-excluir-usuario-40", "_type": "request", "parentId": "fld_usuarios", "name": "DELETE · Excluir usuário", "description": "", "url": "{{ _.base_v1 }}/usuarios/{idUsuario}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_usuarios-post-autenticar-token-50", "_type": "request", "parentId": "fld_usuarios", "name": "POST · Autenticar token", "description": "Rota pública — não requer autenticação.\n\nUtilize esta rota para validar um token JWT já emitido e recarregar os dados do usuário e do estabelecimento sem repetir o login.\n\nErros possíveis: 401 quando o token é inválido (Invalid token) ou está expirado (jwt expired); 500 quando o token não é enviado no corpo da requisição (Token is required) e nas demais falhas.", "url": "{{ _.base_v2 }}/user/authenticate", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": {}, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_vendas", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Vendas", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 800, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-via-cartao-de-credito-10", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda via cartão de crédito", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cartao\": {\n \"titular\": \"titular_do_cartao\",\n \"numero\": \"4111111111111111\",\n \"codigoSeguranca\": \"664\",\n \"validade\": \"02/2032\"\n },\n \"cliente\": {\n \"nome\": \"cliente teste\",\n \"cpf\": \"11144477735\",\n \"dataNascimento\": \"1990-06-23\",\n \"email\": \"exemplo@exemplo.com\"\n },\n \"endereco\": {\n \"logradouro\": \"Rua do Passeio\",\n \"numero\": \"33\",\n \"cep\": \"69906410\",\n \"cidade\": \"Rio Branco\",\n \"estado\": \"AC\",\n \"complemento\": \"até 1600/1601\",\n \"bairro\": \"Taquarí\",\n},\n \"clienteId\": 46432391,\n \"descontos\": [\n {\n \"mode\": \"\",\n \"value\": 0,\n \"limitDate\": \"\"\n }\n ],\n \"parcelas\": 1,\n \"splits\": [],\n \"tipoPagamentoId\": 3,\n \"valor\": 10\n \n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-venda-sem-enviar-e-mail-para-o-c-20", "_type": "request", "parentId": "fld_vendas", "name": "POST · Venda sem enviar e-mail para o cliente", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cartao\": {\n \"titular\": \"titular_do_cartao\",\n \"numero\": \"4111111111111111\",\n \"codigoSeguranca\": \"664\",\n \"validade\": \"02/2032\"\n },\n \"cliente\": {\n \"nome\": \"cliente teste\",\n \"cpf\": \"11144477735\",\n \"dataNascimento\": \"1990-06-23\",\n \"email\": \"exemplo@exemplo.com\"\n },\n \"endereco\": {\n \"logradouro\": \"Rua do Passeio\",\n \"numero\": \"33\",\n \"cep\": \"69906410\",\n \"cidade\": \"Rio Branco\",\n \"estado\": \"AC\",\n \"complemento\": \"até 1600/1601\",\n \"bairro\": \"Taquarí\",\n },\n \"email\": true,\n \"clienteId\": 46432391,\n \"descontos\": [\n {\n \"mode\": \"\",\n \"value\": 0,\n \"limitDate\": \"\"\n }\n ],\n\n \"parcelas\": 1,\n \"splits\": [],\n \"tipoPagamentoId\": 3,\n \"valor\": 10\n \n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-via-pix-30", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda via PIX", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cliente\": {\n \"celular\": \"11144477735\",\n \"cpf\": \"11144477735\",\n \"dataNascimento\": \"1983-05-02\",\n \"email\": \"exemplo@exemplo.com\",\n \"nome\": \"Guilherme Rodrigo Matheus Melo\",\n \"clienteId\": 13460961\n },\n \"descricao\": \"venda pix\",\n \"endereco\": {\n \"cep\": \"69915-846\",\n \"cidade\": \"Rio Branco\",\n \"complemento\": \"\",\n \"estado\": \"AC\",\n \"logradouro\": \"Rua Projetada 1029\",\n \"numero\": 892\n },\n \"estabelecimentoId\": 158,\n \"ip\": \"45.183.240.45\",\n \"splits\": [],\n \"tipoPagamentoId\": 5,\n \"valor\": 40\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-via-cartao-de-credito-40", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda via cartão de crédito com cliente já definido", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoPagamentoId\": 3,\n \"clienteId\": 5648913,\n \"splits\": [],\n \"valor\": 640,\n \"parcelas\": 8,\n \"cartao\": {\n \"titular\": \"moacir berere\",\n \"numero\": \"11444777000161\",\n \"codigoSeguranca\": \"654\",\n \"validade\": \"07/2021\"\n },\n \"ip\": \"201.27.139.162\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-via-cartao-de-credito-50", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda via cartao de credito com cliente e cartao ja definidos", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"clienteId\": 5724394,\n \"cartaoId\": 5687542,\n \"tipoPagamentoId\": 3,\n \"splits\": [],\n \"valor\": 930,\n \"parcelas\": 10,\n \"ip\": \"201.27.139.162\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-estornar-venda-via-cartao-de-cre-60", "_type": "request", "parentId": "fld_vendas", "name": "POST · Estornar venda via cartão de crédito", "description": "", "url": "{{ _.base_v1 }}/vendas/{pedidoId}/estornar", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"PedidoId\": \"\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 60, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-transacao-de-boleto-ou-bole-70", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova transação de boleto ou bolepix", "description": "Esta rota também responde no prefixo alternativo /transaction .", "url": "{{ _.base_v2 }}/transactions", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"bolepix\": false,\n \"establishmentSelect\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"gatewayProvider\": \"zoop\",\n \"amount\": 50000,\n \"description\": \"Mensalidade agosto\",\n \"installments\": 1,\n \"expirationDate\": \"2026-09-10\",\n \"paymentLimitDate\": \"2026-09-20\",\n \"paymentType\": \"bankslip\",\n \"discounts\": [\n {\n \"mode\": \"FIXED\",\n \"value\": 10,\n \"limitDate\": \"2026-09-05\"\n }\n ],\n \"client\": {\n \"dbId\": null,\n \"name\": \"Maria Exemplo\",\n \"email\": \"exemplo@exemplo.com\",\n \"phone\": \"11999990000\",\n \"identificationDocument\": \"11144477735\",\n \"typeDocument\": 2,\n \"contact\": \"11999990000\",\n \"typeContact\": 2,\n \"birthDate\": \"1990-01-01\",\n \"address\": {\n \"street\": \"Avenida Paulista\",\n \"number\": \"1000\",\n \"postalCode\": \"01310100\",\n \"neighborhood\": \"Bela Vista\",\n \"complement\": \"Conjunto 101\",\n \"city\": \"Sao Paulo\",\n \"state\": \"SP\"\n }\n },\n \"splits\": [],\n \"email\": true\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 70, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-via-boleto-com-client-80", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda via boleto com cliente já definido", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoPagamentoId\": 1,\n \"splits\": [],\n \"valor\": 980,\n \"dataVencimento\": \"2022-05-20\",\n \"descricao\": \"teste de venda \",\n \"clienteId\": 13363443\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 80, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-venda-com-split-90", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova venda com split", "description": "", "url": "{{ _.base_v1 }}/vendas", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoPagamentoId\": 3,\n \"splits\": [\n {\n \"estabelecimentoId\": 10564,\n \"tipoSplit\": 2,\n \"valor\": 10\n }\n ],\n \"valor\": 65,\n \"parcelas\": 12,\n \"cartao\": {\n \"titular\": \"altair antunes\",\n \"numero\": \"11444777000161\",\n \"codigoSeguranca\": \"139\",\n \"validade\": \"11/2022\"\n },\n \"cliente\": {\n \"nome\": \"Altair Antunes\",\n \"cpf\": \"11144477735\",\n \"dataNascimento\": \"1985-03-10\",\n \"email\": \"exemplo@exemplo.com\",\n \"celular\": \"11144477735\"\n },\n \"endereco\": {\n \"logradouro\": \"Rua Luís de Andrade\",\n \"numero\": \"594\",\n \"cep\": \"02920-000\",\n \"cidade\": \"São Paulo\",\n \"estado\": \"SP\",\n \"complemento\": \"ap 5a\"\n },\n \"ip\": \"201.27.139.162\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 90, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-nova-pre-captura-via-cartao-de-c-100", "_type": "request", "parentId": "fld_vendas", "name": "POST · Nova pré captura via cartão de credito", "description": "", "url": "{{ _.base_v1 }}/vendas/pre_captura", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"tipoPagamentoId\": 3,\n \"valor\": 1.0,\n \"cartaoId\": 1234,\n \"clienteId\": 17188\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 100, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-executar-venda-pre-capturada-via-110", "_type": "request", "parentId": "fld_vendas", "name": "POST · Executar venda pré capturada via cartão de credito", "description": "", "url": "{{ _.base_v1 }}/vendas/captura", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"pedidoId\": 20212\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 110, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-configurar-split-manualmente-por-120", "_type": "request", "parentId": "fld_vendas", "name": "POST · Configurar Split manualmente por porcentagem", "description": "", "url": "{{ _.base_v1 }}/vendas/split", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"pedidoId\": 20220,\n \"percentual\": 90,\n \"estabelecimentoId\": 132\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 120, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-configurar-split-manualmente-por-130", "_type": "request", "parentId": "fld_vendas", "name": "POST · Configurar Split manualmente por valor", "description": "", "url": "{{ _.base_v1 }}/vendas/split", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"pedidoId\": 2098114,\n \"amount\": 350,\n \"estabelecimentoId\": 9831\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 130, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-detalhes-da-transacao-140", "_type": "request", "parentId": "fld_vendas", "name": "GET · Detalhes da transação", "description": "Esta rota também responde no prefixo alternativo /transaction .", "url": "{{ _.base_v2 }}/transactions/{id}?isBankStatement=false", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 140, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-listar-transacoes-150", "_type": "request", "parentId": "fld_vendas", "name": "GET · Listar transações", "description": "Esta rota também responde no prefixo alternativo /transaction .", "url": "{{ _.base_v2 }}/transactions?page=1&limit=20", "method": "GET", "body": {}, "parameters": [ { "name": "estabelecimentoId", "value": "", "description": "Opcional. Identificador externo do estabelecimento. Quando ausente, usa o estabelecimento do token. O filtro só é considerado quando o estabelecimento do token ", "disabled": true }, { "name": "customer", "value": "Maria Exemplo", "description": "Opcional. Busca parcial pelo nome do cliente", "disabled": true }, { "name": "establishmentName", "value": "", "description": "Opcional. Busca parcial pelo nome do estabelecimento", "disabled": true }, { "name": "pos", "value": "", "description": "Opcional. Número de identificação do POS que originou a venda", "disabled": true }, { "name": "reference", "value": "", "description": "Opcional. Referência informada na criação da transação", "disabled": true }, { "name": "zoopTransactionId", "value": "", "description": "Opcional. Identificador da transação no gateway", "disabled": true }, { "name": "suspiciousTransaction", "value": "", "description": "Opcional. Quando presente, retorna somente transações marcadas como suspeitas", "disabled": true }, { "name": "antifraud_checked", "value": "", "description": "Opcional. Enviar o texto true para retornar somente transações conferidas no antifraude", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 150, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-cadastrar-split-em-uma-venda-ja--160", "_type": "request", "parentId": "fld_vendas", "name": "POST · Cadastrar split em uma venda ja realizada com porcentagem", "description": "", "url": "{{ _.base_v1 }}/vendas/split", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"pedidoId\": \"48818058\",\n \"percentual\": \"1\",\n \"estabelecimentoId\": \"12309\",\n }" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 160, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-cadastrar-split-pos-venda-170", "_type": "request", "parentId": "fld_vendas", "name": "POST · Cadastrar split pós-venda", "description": "Esta rota também responde no prefixo alternativo /transaction .\n\nA chamada é recusada quando já existe split registrado para o mesmo estabelecimento e quando o valor excede o permitido para a transação.", "url": "{{ _.base_v2 }}/transactions/split-after-sale", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"transactionId\": \"7c1d4e9a-2b83-4f56-9a10-5d2e8f3b6c47\",\n \"splitRules\": [\n {\n \"establishmentId\": \"3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23\",\n \"typeSplit\": 2,\n \"value\": 10,\n \"chargeProcessingFee\": true,\n \"chargeRecipientProcessingFee\": false\n }\n ]\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 170, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-cadastrar-split-em-uma-venda-ja--180", "_type": "request", "parentId": "fld_vendas", "name": "POST · Cadastrar split em uma venda ja realizada com valor real", "description": "", "url": "{{ _.base_v1 }}/vendas/split", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"pedidoId\": \"48818058\",\n \"amount\": \"10\",\n \"estabelecimentoId\": \"12309\",\n }" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 180, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-autorizacao-direta-190", "_type": "request", "parentId": "fld_vendas", "name": "POST · Autorização direta", "description": "", "url": "{{ _.base_v2 }}/transaction/direct-authorization", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"description\": \"description description\",\n \"capture\": true,\n \"gatewayProvider\": \"zoop\"\n \"amount\": 19,\n \"card\": {\n \"cardNumber\": \"4111111111111111\",\n \"holderName\": \"Dayglor Campos\",\n \"expirationMonth\": \"07\",\n \"expirationYear\": \"2031\",\n \"securityCode\": \"807\"\n },\n \"establishmentId\": 1\n \"installments\": 1\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 190, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-post-autorizacao-direta-com-split-200", "_type": "request", "parentId": "fld_vendas", "name": "POST · Autorização direta com split", "description": "", "url": "{{ _.base_v2 }}/transaction/direct-authorization", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"description\": \"description description\",\n \"capture\": true,\n \"gatewayProvider\": \"zoop\"\n \"amount\": 19,\n \"card\": {\n \"brand\": \"American Express\",\n \"cardNumber\": \"4111111111111111\",\n \"holderName\": \"Dayglor Campos\",\n \"expirationMonth\": \"07\",\n \"expirationYear\": \"2031\",\n \"securityCode\": \"807\"\n },\n \"splits\": [\n {\n \"estabelecimentoId\": 1,\n \"cpfcnpj\":\"\",\n \"nome\":\"\",\n \"email\":\"\",\n \"valor\": 0,\n \"tipoSplit\":2\n }\n ]\n \"establishmentId\": 1\n \"installments\": 1\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 200, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-detalhes-publicos-da-transacao-210", "_type": "request", "parentId": "fld_vendas", "name": "GET · Detalhes públicos da transação", "description": "Rota pública — não requer autenticação.\n\nEsta rota responde somente no prefixo /transactions . O prefixo alternativo /transaction exige autenticação e não atende o caminho público.", "url": "{{ _.base_v2 }}/transactions/public/{id}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": {}, "metaSortKey": 210, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-delete-cancelar-boleto-220", "_type": "request", "parentId": "fld_vendas", "name": "DELETE · Cancelar boleto", "description": "Esta rota também responde no prefixo alternativo /transaction .\n\nO cancelamento só é executado quando a transação está com status Pendente, identificador 1, e a forma de pagamento é bankSlip, boleto ou bolepix. Quando a transação não atende a essa regra, a API responde 200 devolvendo o status atual, sem alterações. Confira o campo transaction.status para saber se o cancelamento foi aceito.", "url": "{{ _.base_v2 }}/transactions/{id}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 220, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-consultar-repasse-de-taxas-por-va-230", "_type": "request", "parentId": "fld_vendas", "name": "GET · Consultar repasse de taxas por valor", "description": "Esta rota também responde no prefixo alternativo /transaction .\n\nO valor na URL é informado em CENTAVOS. Para simular R$ 500,00 use /transactions/check-split-pass-fees/50000 .\n\nEsta consulta usa como origem o estabelecimento do token e considera somente as regras cadastradas na categoria de repasse de taxas. Use o retorno para exibir ao cliente o valor final antes de criar a transação. Ao criar a venda, converta esse valor de reais para centavos antes de enviá-lo no campo amount.", "url": "{{ _.base_v2 }}/transactions/check-split-pass-fees/{amount}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 230, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-consultar-regras-de-repasse-de-ta-240", "_type": "request", "parentId": "fld_vendas", "name": "GET · Consultar regras de repasse de taxas", "description": "Esta rota também responde no prefixo alternativo /transaction .\n\nEsta rota lista todas as regras de split cadastradas para o estabelecimento informado, independente da categoria. Para simular o valor final de uma venda com base nas regras de repasse de taxas, use a rota de consulta de repasse por valor.", "url": "{{ _.base_v2 }}/transactions/get-split-pass-fees/{establishmentId}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 240, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-resumo-por-forma-de-pagamento-250", "_type": "request", "parentId": "fld_vendas", "name": "GET · Resumo por forma de pagamento", "description": "Esta rota também responde no prefixo alternativo /transactions .\n\nO período anterior usado na comparação é derivado do intervalo informado. Para um intervalo de um dia, compara com o dia anterior. Para intervalos maiores, compara com o intervalo imediatamente anterior de mesmo tamanho.", "url": "{{ _.base_v2 }}/transaction/payment-methods?startDate=2026-08-01&endDate=2026-08-31", "method": "GET", "body": {}, "parameters": [ { "name": "filters", "value": "{\"estabelecimentoId\":\"COLE_O_UUID_AQUI\"}", "description": "Opcional. Objeto JSON serializado como texto. Aceita a chave estabelecimentoId com o identificador externo do estabelecimento. Também aceito com o nome establis", "disabled": true }, { "name": "estabelecimentoId", "value": "", "description": "Opcional. Alternativa a filters, enviando o estabelecimento direto na query string. Também aceito com os nomes establishmentId e establishmentDbId. Quando nenhu", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 250, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_vendas-get-ultimas-transacoes-260", "_type": "request", "parentId": "fld_vendas", "name": "GET · Últimas transações", "description": "Esta rota também responde no prefixo alternativo /transactions .\n\nEsta rota devolve no máximo 20 transações, as de hoje quando existirem e, caso não haja nenhuma hoje, as 20 mais recentes. Não aceita paginação nem filtros de período. Para listagens com filtros e páginas, use a rota de listagem de transações.", "url": "{{ _.base_v2 }}/transaction/last-transactions?estabelecimentoId=3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23", "method": "GET", "body": {}, "parameters": [ { "name": "marketplaceId", "value": "", "description": "Opcional. Identificador interno do marketplace. Também aceito com os nomes marketplaceDbId e marketplace_id. Precisa ser um número maior que zero, caso contrári", "disabled": true }, { "name": "startDate", "value": "2026-08-01", "description": "Não aceito. Esta rota recusa filtros de data e responde 400 com o texto last-transactions does not accept startDate/endDate filters", "disabled": true }, { "name": "endDate", "value": "2026-08-31", "description": "Não aceito. Mesma regra de startDate", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 260, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_links-de-pagamento", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Links de pagamento", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 900, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-post-criar-um-link-de-pag-10", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "POST · Criar um link de pagamento sem juros e split", "description": "", "url": "{{ _.base_v1 }}/pre_venda", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"id\": null,\n \"titulo\": \"Link de pagamento sem juros e split\",\n \"descricao\": \"Sem juros e split\",\n \"amount\": 150000,\n \"parcelamento_ate\": 3,\n \"meio_pagamento\": 3,\n \"data_expiracao\": \"2021-03-11T19:51:37.668Z\",\n \"logo\": true,\n \"split\": false,\n \"token\": null,\n \"nome_fantasia\": \"\",\n \"pedidos\": [],\n \"juros\": false,\n \"percentual\": 0,\n \"juros_a_partir\": 2,\n \"chargeProcessingFee\": true,\n \"splits\": [],\n \"repassarTaxaCliente\": false,\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-post-criar-um-link-de-pag-20", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "POST · Criar um link de pagamento com juros", "description": "", "url": "{{ _.base_v1 }}/pre_venda", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"id\": null,\n \"titulo\": \"Link de pagamento com juros e split\",\n \"descricao\": \"Link com juros e split\",\n \"amount\": 275000,\n \"parcelamento_ate\": 12,\n \"meio_pagamento\": 3,\n \"data_expiracao\": \"2021-03-11T20:12:00.830Z\",\n \"logo\": true,\n \"split\": true,\n \"token\": null,\n \"nome_fantasia\": \"\",\n \"pedidos\": [],\n \"juros\": false,\n \"percentual\": 0,\n \"juros_a_partir\": 2,\n \"chargeProcessingFee\": true,\n \"splits\": [\n {\n \"estabelecimentoId\": 16778,\n \"cpfcnpj\": \"11144477735\",\n \"nome\": \"Arya Stark\",\n \"email\": \"exemplo@exemplo.com\",\n \"value\": 0,\n \"tipoSplit\": 2,\n \"chargeProcessingFee\": true,\n \"valor\": 2\n }\n ],\n \"repassarTaxaCliente\": false,\n \"ip\": \"201.27.139.162\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-get-listar-links-de-pagam-30", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "GET · Listar links de pagamentos", "description": "", "url": "{{ _.base_v1 }}/pre_venda", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-get-consultar-link-de-pag-40", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "GET · Consultar Link de pagamento", "description": "", "url": "{{ _.base_v1 }}/pre_venda/{id_pre_venda}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-delete-excluir-link-de-pa-50", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "DELETE · Excluir link de pagamento", "description": "", "url": "{{ _.base_v1 }}/pre_venda/{id_pre_venda}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_links-de-pagamento-post-link-de-pagamento-po-60", "_type": "request", "parentId": "fld_links-de-pagamento", "name": "POST · Link de pagamento por boleto ou cartão de crédito", "description": "", "url": "{{ _.base_v1 }}/pre_venda", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n amount:1000\n chargeProcessingFee: true\n data_expiracao: \"2023-09-30T18:41:26.802Z\" \n descricao:\"testelinkdesc\"\n email: \"exemplo@exemplo.com\"\n juros: false\n juros_a_partir: 2\n logo: true\n meio_pagamento: 8\n nome_fantasia: \"\"\n parcelamento_ate: 1\n percentual: 0\n repassarTaxaCliente: false\n split: false\n splits: [\n {\n estabelecimentoId: false,\n cpfcnpj: \"\",\n nome: \"\",\n email: \"\",\n value: 0,\n tipoSplit: 2\n },\n {\n estabelecimentoId: false,\n cpfcnpj: \"\",\n nome: \"\",\n email: \"\",\n value: 0,\n tipoSplit: 2\n }\n ]\n \n titulo: \"testelink\"\n \n }" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 60, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_planos", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Planos", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1000, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-post-criar-um-novo-plano-10", "_type": "request", "parentId": "fld_planos", "name": "POST · Criar um novo plano", "description": "", "url": "{{ _.base_v1 }}/planos", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"name\": \"Adicionar plano com boleto\",\n \"description\": \"Plano sendo adicionado com boleto \",\n \"email\": \"exemplo@exemplo.com\",\n \"setup_amount\": 50000,\n \"amount\": 180000,\n \"grace_period\": \"7\",\n \"tolerance_period\": 0,\n \"frequency\": \"monthly\",\n \"interval\": 1,\n \"logo\": true,\n \"currency\": \"BRL\",\n \"payment_methods\": \"boleto\",\n \"plan_expiration_date\": \"2021-08-09T03:00:00.000Z\",\n \"has_expiration\": true,\n \"expire_subscriptions\": true,\n \"subscription_duration\": \"6\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-get-listar-planos-20", "_type": "request", "parentId": "fld_planos", "name": "GET · Listar planos", "description": "A listagem retorna apenas os planos do estabelecimento do token e dos estabelecimentos filhos diretos dele.", "url": "{{ _.base_v2 }}/plan/list?page=1&limit=10", "method": "GET", "body": {}, "parameters": [ { "name": "name", "value": "Plano Exemplo Mensal", "description": "Opcional. Filtra pelo nome do plano. A busca é parcial, aceita parte do nome", "disabled": true }, { "name": "amount", "value": "10000", "description": "Opcional. Filtra pelo valor da recorrência em centavos, sem separadores (10000 equivale a R$ 100,00). A busca é exata", "disabled": true }, { "name": "establishmentSelect", "value": "", "description": "Opcional. Restringe a listagem aos planos de um único estabelecimento. Aceita o uuid ou o identificador numérico. O estabelecimento precisa ser o do token ou um", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-get-recuperar-plano-pelo-identificado-30", "_type": "request", "parentId": "fld_planos", "name": "GET · Recuperar plano pelo identificador", "description": "", "url": "{{ _.base_v1 }}/planos/{PlanoId}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-put-editar-um-plano-40", "_type": "request", "parentId": "fld_planos", "name": "PUT · Editar um plano", "description": "", "url": "{{ _.base_v1 }}/planos/{PlanoId}", "method": "PUT", "body": { "mimeType": "application/json", "text": "{\n \"name\": \"Plano 6 Avançado\",\n \"description\": \"Plano portal de noticias + Plus\",\n \"setup_amount\": 0,\n \"amount\": 100,\n \"grace_period\": \"0\",\n \"tolerance_period\": 3,\n \"frequency\": \"monthly\",\n \"interval\": 1\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-delete-remover-um-plano-50", "_type": "request", "parentId": "fld_planos", "name": "DELETE · Remover um plano", "description": "", "url": "{{ _.base_v1 }}/planos/{PlanoId}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_planos-get-filtrar-listagem-de-planos-60", "_type": "request", "parentId": "fld_planos", "name": "GET · Filtrar listagem de planos", "description": "", "url": "{{ _.base_v1 }}/planos", "method": "GET", "body": {}, "parameters": [ { "name": "page", "value": "1", "description": "Número da página de listagem de planos", "disabled": true }, { "name": "limit", "value": "15", "description": "Limite de planos por página", "disabled": true }, { "name": "nome", "value": "", "description": "Título do plano", "disabled": true }, { "name": "valor", "value": "0", "description": "Valor do plano", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 60, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_assinaturas", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Assinaturas", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1100, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-post-nova-assinatura-10", "_type": "request", "parentId": "fld_assinaturas", "name": "POST · Nova assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinar", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"planoId\": 42,\n \"expiration_date\": \"2019-12-12\",\n \"cliente\": {\n \"nome\": \"João Paulo\",\n \"email\": \"exemplo@exemplo.com\",\n \"dataNascimento\": \"1991-10-10\",\n \"cpf\": \"00000000000\",\n \"telefone\": \"0033332222\",\n \"celular\": \"00999998888\"\n },\n \"endereco\": {\n \"logradouro\": \"leoneta\",\n \"numero\": \"123\",\n \"cep\": \"03380235\",\n \"cidade\": \"sp\",\n \"estado\": \"sp\"\n },\n \"cartao\": {\n \"titular\": \"João Paulo\",\n \"validade\": \"02/25\",\n \"numero\": \"4111111111111111\",\n \"codigoSeguranca\": \"069\"\n }\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-get-listar-assinaturas-20", "_type": "request", "parentId": "fld_assinaturas", "name": "GET · Listar assinaturas", "description": "A listagem retorna apenas as assinaturas do estabelecimento do token e dos estabelecimentos filhos diretos dele. Os filtros de período exigem as duas pontas: informar apenas start ou apenas end faz com que o filtro seja desconsiderado. As datas precisam ser codificadas na query string, o espaço entre a data e a hora é enviado como %20.", "url": "{{ _.base_v2 }}/subscriptions/list?page=1&limit=10&status[]=1&plano_id=3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23", "method": "GET", "body": {}, "parameters": [ { "name": "status", "value": "", "description": "Opcional. Filtra pelos status da assinatura: 1 Aguardando, 2 Cancelado, 3 Pago, 4 Suspenso, 5 Atrasado. Precisa ser enviado como lista na query string, no forma", "disabled": true }, { "name": "omni", "value": "Maria Exemplo", "description": "Opcional. Campo de busca livre pelo nome ou pelo e-mail do cliente da assinatura", "disabled": true }, { "name": "assinatura_id", "value": "", "description": "Opcional. Filtra pelo identificador da assinatura. A busca é exata, o uuid precisa ser informado por completo", "disabled": true }, { "name": "estabelecimento_id", "value": "", "description": "Opcional. Restringe a listagem às assinaturas de um único estabelecimento. Aceita somente o identificador numérico interno, que precisa pertencer ao mesmo marke", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-get-detalhes-da-assinatura-30", "_type": "request", "parentId": "fld_assinaturas", "name": "GET · Detalhes da assinatura", "description": "O parâmetro {id} é o uuid da assinatura, o mesmo valor devolvido no campo id da rota de listagem de assinaturas. A consulta responde com o status 403 quando a assinatura não pertence ao estabelecimento do token nem a um estabelecimento filho direto dele. Tokens de marketplace consultam qualquer assinatura.", "url": "{{ _.base_v2 }}/subscriptions/{id}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-put-alterar-valor-da-assinatura-40", "_type": "request", "parentId": "fld_assinaturas", "name": "PUT · Alterar valor da assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/{AssinaturaId}", "method": "PUT", "body": { "mimeType": "application/json", "text": "{\n \"amount\":\"500\",\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 40, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-post-suspender-uma-assinatura-50", "_type": "request", "parentId": "fld_assinaturas", "name": "POST · Suspender uma assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/suspender", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"assinatura_id\": 90\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 50, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-post-reativar-uma-assinatura-60", "_type": "request", "parentId": "fld_assinaturas", "name": "POST · Reativar uma assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/reativar", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"assinatura_id\": 90\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 60, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-delete-remover-uma-assinatura-70", "_type": "request", "parentId": "fld_assinaturas", "name": "DELETE · Remover uma assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/${assinaturaId}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 70, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-get-recuperar-faturas-de-uma-ass-80", "_type": "request", "parentId": "fld_assinaturas", "name": "GET · Recuperar faturas de uma assinatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/{assinaturaId}/faturas", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 80, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_assinaturas-post-estornar-uma-fatura-90", "_type": "request", "parentId": "fld_assinaturas", "name": "POST · Estornar uma fatura", "description": "", "url": "{{ _.base_v1 }}/planos/assinatura/estornar", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"id\": 841\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 90, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_carnes", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Carnês", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1200, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_carnes-post-criacao-de-carne-10", "_type": "request", "parentId": "fld_carnes", "name": "POST · Criação de carnê", "description": "", "url": "{{ _.base_v1 }}/carnes", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"cliente\": {\n \"nome\": \"LUCAS COELHO\",\n \"cpf\": \"11144477735\",\n \"dataNascimento\": \"2000-02-08\",\n \"email\": \"RUA SAO JOSEMARIA ESCRIVA\",\n \"celular\": \"99562909\"\n },\n \"clienteId:2666\",\n \"descontos\": [\n {\n \"mode\": \"\",\n \"value\": 0,\n \"limitDate\": \"2023-09-13T19:24:05.619Z\"\n }\n ],\n \"descricao\":\"descricaoteste\",\n \"diaVencimento\":\"2023-09-18\",\n \"endereco\": {\n \"logradouro\": \"Rua São Josemaría Escrivá\",\n \"numero\": \" 669 \",\n \"cep\": \"91410-470\",\n \"cidade\": \"Porto Alegre\",\n \"estado\": \"RS\",\n \"complemento\": \"\"\n }\n \"estabelecimentoId\":155,\n \"parcelas\":1,\n \"splits\": [\n {\n \"estabelecimentoId\": false,\n \"cpfcnpj\": \"\",\n \"nome\": \"\",\n \"email\": \"\",\n \"value\": 0,\n \"tipoSplit\": 2,\n \"chargeProcessingFee\": true\n }\n ],\n \"tipoPagamentoId\": 4,\n \"titulo\": \"tete\",\n \"valor\": 10,\n\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_carnes-get-listagem-de-carne-20", "_type": "request", "parentId": "fld_carnes", "name": "GET · Listagem de carnê", "description": "", "url": "{{ _.base_v1 }}/carnes?page=1&cliente=&titulo=&id=&limit=15", "method": "GET", "body": {}, "parameters": [ { "name": "estabelecimentoId", "value": "158", "description": "Id do estabelecimento", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_carnes-get-detalhes-do-carne-30", "_type": "request", "parentId": "fld_carnes", "name": "GET · Detalhes do carnê", "description": "", "url": "{{ _.base_v1 }}/carnes/{id}", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_remessa-de-boletos", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Remessa de boletos", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1300, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_remessa-de-boletos-post-enviar-arquivo-de-re-10", "_type": "request", "parentId": "fld_remessa-de-boletos", "name": "POST · Enviar arquivo de remessa — multipart", "description": "Cada requisição envia um único arquivo de remessa, nos padrões CNAB 240 ou CNAB 400. O arquivo precisa ter uma das extensões .REM , .rem , .CRM ou .crm ; arquivos com outra extensão são recusados.\n\nO registro dos boletos é assíncrono. No envio a rota valida a extensão, o tipo e faz a leitura do arquivo CNAB. Se a leitura falhar, a resposta continua com o código 201 e a remessa fica com situação Pendente, mas nenhum título é enfileirado e o campo shippingFile traz o texto do erro. Quando a leitura funciona, cada título é processado depois pela fila e a situação final aparece na rota de listagem de arquivos de remessa.\n\nFalhas de permissão e de tipo inválido são devolvidas com o texto do erro no campo shippingFile , sem alterar o código de resposta.", "url": "{{ _.base_v2 }}/shipping-file", "method": "POST", "body": { "params": [ { "name": "file", "type": "file", "fileName": "" }, { "name": "type", "value": "240" }, { "name": "estabelecimento_id", "value": "3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23" } ], "mimeType": "multipart/form-data" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "multipart/form-data" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_remessa-de-boletos-get-listar-arquivos-de-re-20", "_type": "request", "parentId": "fld_remessa-de-boletos", "name": "GET · Listar arquivos de remessa", "description": "A listagem devolve os arquivos de remessa enviados para um estabelecimento, com a situação de processamento de cada um. O parâmetro estabelecimento_id precisa ser informado: sem ele a rota responde com o texto do erro no campo shippingFiles , em vez da lista.", "url": "{{ _.base_v2 }}/shipping-file?estabelecimento_id=3f8e2a1b-9c47-4d02-8b5a-1e6f7c9d0a23&usuarioId=2785", "method": "GET", "body": {}, "parameters": [ { "name": "statusId", "value": "2", "description": "Opcional. Filtra pela situação do processamento: 1 para Pendente, 2 para Sucesso e 3 para Falhado", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_terminais-pos", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Terminais POS", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1400, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_terminais-pos-get-listar-terminais-pos-10", "_type": "request", "parentId": "fld_terminais-pos", "name": "GET · Listar terminais POS", "description": "A listagem devolve apenas os terminais do marketplace do token. Quando o token pertence a um estabelecimento filho do marketplace, a listagem devolve apenas os terminais dos estabelecimentos filhos diretos dele, sem incluir os terminais do próprio estabelecimento do token. Estabelecimentos que não são o marketplace nem estão marcados como filhos de marketplace não têm acesso à rota.\n\nTerminais removidos não aparecem na listagem.", "url": "{{ _.base_v2 }}/points-of-sales?page=1&limit=10&establishment_name=Estabelecimento Exemplo", "method": "GET", "body": {}, "parameters": [ { "name": "startDate", "value": "2026-08-01", "description": "Opcional. Data inicial de cadastro do terminal, no formato YYYY-MM-DD. Só é aplicada quando endDate também é informada", "disabled": true }, { "name": "endDate", "value": "2026-08-31", "description": "Opcional. Data final de cadastro do terminal, no formato YYYY-MM-DD. O dia inteiro é considerado", "disabled": true }, { "name": "identification", "value": "POS-000123", "description": "Opcional. Filtra pelo número de identificação do terminal. A busca é exata", "disabled": true }, { "name": "serial", "value": "8012457796", "description": "Opcional. Filtra pelo número de série do terminal. A busca é exata", "disabled": true }, { "name": "chip", "value": "", "description": "Opcional. Filtra pelo número do chip do terminal. A busca é exata", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_terminais-pos-post-exportar-terminais-pos-20", "_type": "request", "parentId": "fld_terminais-pos", "name": "POST · Exportar terminais POS", "description": "A exportação é assíncrona. A rota responde com o código 202 assim que a solicitação entra na fila, e a planilha com os terminais é gerada em seguida, com os mesmos filtros aceitos pela listagem de terminais POS. O acompanhamento e o download são feitos pela relação de exportações do painel.\n\nOs filtros de período e de paginação são excludentes: quando startDate e endDate são informados, a exportação abrange todo o período e os parâmetros limit e page são desconsiderados.\n\nUma data inicial posterior à data final retorna o código 400. Token ausente, inválido ou expirado retorna o código 401, com o corpo em texto puro e a mensagem Authorization is required, Bearer token is required, Invalid token format ou a mensagem do token expirado.", "url": "{{ _.base_v2 }}/export/pos", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"startDate\": \"2026-08-01\",\n \"endDate\": \"2026-08-31\",\n \"identification\": \"POS-000123\",\n \"serial\": \"8012457796\",\n \"establishment_name\": \"Estabelecimento Exemplo\",\n \"limit\": 99999999\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_predefinicoes", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Predefinições", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1500, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_predefinicoes-get-consultar-bancos-10", "_type": "request", "parentId": "fld_predefinicoes", "name": "GET · Consultar bancos", "description": "", "url": "{{ _.base_v1 }}/bancos", "method": "GET", "body": {}, "parameters": [ { "name": "nome", "value": "", "description": "Campo contendo o código e o nome do banco", "disabled": true }, { "name": "codigo", "value": "", "description": "Código do banco", "disabled": true } ], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_webhooks", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Webhooks", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1600, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_webhooks-post-cadastrar-webhook-10", "_type": "request", "parentId": "fld_webhooks", "name": "POST · Cadastrar webhook", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/url-webhook", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"url\": \"https://teste2lwebhook\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_webhooks-get-listar-webhook-20", "_type": "request", "parentId": "fld_webhooks", "name": "GET · Listar webhook", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/url-webhook", "method": "GET", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 20, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_webhooks-delete-remover-webhook-30", "_type": "request", "parentId": "fld_webhooks", "name": "DELETE · Remover webhook", "description": "", "url": "{{ _.base_v1 }}/estabelecimentos/url-webhook/{webhookId}", "method": "DELETE", "body": {}, "parameters": [], "headers": [], "authentication": { "type": "bearer", "token": "{{ _.token }}" }, "metaSortKey": 30, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 }, { "_id": "fld_geracao-de-token", "_type": "request_group", "parentId": "wrk_nectadocs", "name": "Geração de token", "description": "", "environment": {}, "environmentPropertyOrder": null, "metaSortKey": 1700, "created": 1786650000000, "modified": 1786650000000 }, { "_id": "req_token-createtoken", "_type": "request", "parentId": "fld_geracao-de-token", "name": "POST · Criar token de acesso", "description": "Retorna um token com validade de 4 horas para uso nas rotas autenticadas.", "url": "{{ _.base_v1 }}/createToken", "method": "POST", "body": { "mimeType": "application/json", "text": "{\n \"email\": \"exemplo@exemplo.com\",\n \"password\": \"SuaSenha\"\n}" }, "parameters": [], "headers": [ { "name": "Content-Type", "value": "application/json" } ], "authentication": {}, "metaSortKey": 10, "isPrivate": false, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "created": 1786650000000, "modified": 1786650000000 } ] }