Taxas de cartão

Base: https://api.nivesistemas.com.br · 18 endpoints

GET /card-fees

Configuração de taxas

curl -X GET "https://api.nivesistemas.com.br/card-fees" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/card-fees",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /card-fees

Atualizar configuração de taxas

curl -X PUT "https://api.nivesistemas.com.br/card-fees" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/card-fees",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /card-fees/accounts

Criar conta/maquininha

curl -X POST "https://api.nivesistemas.com.br/card-fees/accounts" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/accounts",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /card-fees/accounts/:accountId

Atualizar conta

Parâmetros de rota: accountId

curl -X PATCH "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts/{accountId}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /card-fees/accounts/:accountId/activate

Ativar conta

Parâmetros de rota: accountId

curl -X POST "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/activate" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/activate", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/activate",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /card-fees/accounts/:accountId/use-for-payment-link

Usar conta no link de pagamento

Parâmetros de rota: accountId

curl -X POST "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/use-for-payment-link" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/use-for-payment-link", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/use-for-payment-link",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /card-fees/accounts/:accountId

Excluir conta

Parâmetros de rota: accountId

curl -X DELETE "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts/{accountId}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /card-fees/calc-jobs

Listar jobs de recálculo

curl -X GET "https://api.nivesistemas.com.br/card-fees/calc-jobs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/calc-jobs", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/card-fees/calc-jobs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /card-fees/calc-jobs

Enfileirar recálculo de taxas

curl -X POST "https://api.nivesistemas.com.br/card-fees/calc-jobs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/calc-jobs", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/calc-jobs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /card-fees/calc-jobs/:jobId

Cancelar job

Parâmetros de rota: jobId

curl -X DELETE "https://api.nivesistemas.com.br/card-fees/calc-jobs/{jobId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/calc-jobs/{jobId}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/card-fees/calc-jobs/{jobId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /card-fees/accounts/:accountId/brand-rates

Substituir as taxas próprias de uma bandeira numa maquininha

Parâmetros de rota: accountId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`cardBrandId`	string	sim	Bandeira
`rates`	array	sim	[{ cardType (debit ou credit), installments (1 a 12), feePercent (0 a 100, ou null para usar a taxa geral da maquininha) }]

Resposta: A configuração de taxas completa (mesmo retorno de GET /card-fees).

curl -X PUT "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/brand-rates" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"cardBrandId":"","rates":[]}'

const res = await fetch("https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/brand-rates", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "cardBrandId": "",
    "rates": []
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/card-fees/accounts/{accountId}/brand-rates",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "cardBrandId": "",
      "rates": []
    },
)
print(res.json())

POST /card-fees/brands

Cadastrar bandeira de cartão

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Nome (até 60)
`tBand`	string	não	Código tBand da NFC-e (1 a 2 dígitos); null para não informar

Resposta: 201 Created — a configuração de taxas completa.

curl -X POST "https://api.nivesistemas.com.br/card-fees/brands" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","tBand":""}'

const res = await fetch("https://api.nivesistemas.com.br/card-fees/brands", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "tBand": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/brands",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "tBand": ""
    },
)
print(res.json())

PATCH /card-fees/brands/:brandId

Atualizar bandeira de cartão

Parâmetros de rota: brandId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	não	Nome (até 60)
`tBand`	string	não	Código tBand da NFC-e (1 a 2 dígitos); null remove
`active`	boolean	não	Ativa

Resposta: A configuração de taxas completa.

curl -X PATCH "https://api.nivesistemas.com.br/card-fees/brands/{brandId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","tBand":"","active":true}'

const res = await fetch("https://api.nivesistemas.com.br/card-fees/brands/{brandId}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "tBand": "",
    "active": true
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/card-fees/brands/{brandId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "tBand": "",
      "active": True
    },
)
print(res.json())

DELETE /card-fees/brands/:brandId

Remover bandeira (se já foi usada em vendas, é apenas desativada)

Parâmetros de rota: brandId

Resposta: A configuração de taxas completa.

curl -X DELETE "https://api.nivesistemas.com.br/card-fees/brands/{brandId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/brands/{brandId}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/card-fees/brands/{brandId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /card-fees/auto-adjust

Configuração do reajuste automático de taxas por faixa de faturamento

Resposta: { enabled, lastMonth, lastAt, lastNote, tiers }. tiers lista as faixas (minGross e a maquininha/conta de cada uma).

curl -X GET "https://api.nivesistemas.com.br/card-fees/auto-adjust" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/auto-adjust", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/card-fees/auto-adjust",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PUT /card-fees/auto-adjust

Salvar o reajuste automático: a maquininha ativa passa a ser escolhida pelo volume de cartão do mês anterior

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`enabled`	boolean	sim	Reajuste ligado (exige ao menos uma faixa)
`tiers`	array	sim	Até 20 faixas: [{ minGross, accountId }] — minGross é o volume mínimo de cartão do mês anterior (R$); não pode haver duas faixas com o mesmo valor

Resposta: A configuração salva (mesmo formato de GET). 400 para faixas duplicadas ou ligado sem faixas; 404 se alguma maquininha não existe.

curl -X PUT "https://api.nivesistemas.com.br/card-fees/auto-adjust" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"tiers":[]}'

const res = await fetch("https://api.nivesistemas.com.br/card-fees/auto-adjust", {
  method: "PUT",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "enabled": true,
    "tiers": []
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "PUT",
    "https://api.nivesistemas.com.br/card-fees/auto-adjust",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "enabled": True,
      "tiers": []
    },
)
print(res.json())

POST /card-fees/auto-adjust/run

Aplicar agora a regra do mês corrente, trocando a maquininha ativa conforme o volume do mês anterior

Resposta: { result, payload } — result.status indica o que ocorreu (por exemplo applied, com accountName) e payload é a configuração de taxas completa. 409 se o reajuste está desligado ou sem faixas.

curl -X POST "https://api.nivesistemas.com.br/card-fees/auto-adjust/run" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/card-fees/auto-adjust/run", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/auto-adjust/run",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /card-fees/recalc-month/preview

Simular o recálculo das taxas de um mês com a maquininha vigente, sem gravar nada

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`month`	string	sim	Mês no formato AAAA-MM

Resposta: { month, dryRun, activeAccountName, totalMatched, updated, skipped, failed, grossTotal, feeBefore, feeAfter }. Para aplicar de verdade, enfileire com POST /card-fees/calc-jobs enviando { month }.

curl -X POST "https://api.nivesistemas.com.br/card-fees/recalc-month/preview" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"month":""}'

const res = await fetch("https://api.nivesistemas.com.br/card-fees/recalc-month/preview", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "month": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/card-fees/recalc-month/preview",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "month": ""
    },
)
print(res.json())