Cartões de crédito da empresa

Cartões corporativos usados para pagar despesas. Cada compra gera parcelas nas faturas conforme o dia de fechamento; a fatura é paga como uma conta a pagar.

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

GET /credit-cards

Listar cartões

Query params

Campo	Tipo	Obrigatório	Descrição
`q`	string	não	Busca por apelido, titular ou final
`active`	boolean	não	true / false

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

const res = await fetch("https://api.nivesistemas.com.br/credit-cards", {
  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/credit-cards",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /credit-cards

Cadastrar cartão

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`name`	string	sim	Apelido do cartão
`holderName`	string	sim	Titular
`institution`	string	não	Banco / emissor
`brand`	string	não	Bandeira
`last4`	string	não	Últimos dígitos
`closingDay`	integer	sim	Dia de fechamento (1–31)
`dueDay`	integer	sim	Dia de vencimento (1–31)
`bestPurchaseDay`	integer	não	Melhor dia de compra
`closingPolicy`	string	não	CURRENT_INVOICE ou NEXT_INVOICE (compra no dia do fechamento)
`notes`	string	não	Observações
`active`	boolean	não	Ativo
`locationId`	string	não	Filial

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/credit-cards" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo","holderName":"","institution":"","brand":"","last4":"","closingDay":1,"dueDay":1,"bestPurchaseDay":1,"closingPolicy":"","notes":"","active":true,"locationId":""}'

const res = await fetch("https://api.nivesistemas.com.br/credit-cards", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo",
    "holderName": "",
    "institution": "",
    "brand": "",
    "last4": "",
    "closingDay": 1,
    "dueDay": 1,
    "bestPurchaseDay": 1,
    "closingPolicy": "",
    "notes": "",
    "active": true,
    "locationId": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/credit-cards",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo",
      "holderName": "",
      "institution": "",
      "brand": "",
      "last4": "",
      "closingDay": 1,
      "dueDay": 1,
      "bestPurchaseDay": 1,
      "closingPolicy": "",
      "notes": "",
      "active": True,
      "locationId": ""
    },
)
print(res.json())

GET /credit-cards/:id

Detalhe do cartão

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/credit-cards/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/{id}", {
  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/credit-cards/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /credit-cards/:id

Atualizar cartão (campos parciais)

Parâmetros de rota: id

curl -X PATCH "https://api.nivesistemas.com.br/credit-cards/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/{id}", {
  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/credit-cards/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /credit-cards/:id

Excluir cartão

Parâmetros de rota: id

curl -X DELETE "https://api.nivesistemas.com.br/credit-cards/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/{id}", {
  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/credit-cards/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /credit-cards/:id/purchases

Compras lançadas no cartão

Parâmetros de rota: id

curl -X GET "https://api.nivesistemas.com.br/credit-cards/{id}/purchases" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/{id}/purchases", {
  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/credit-cards/{id}/purchases",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /credit-cards/purchases/preview

Simular parcelas e faturas de uma compra (não grava)

curl -X POST "https://api.nivesistemas.com.br/credit-cards/purchases/preview" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/purchases/preview", {
  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/credit-cards/purchases/preview",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /credit-cards/purchases

Lançar compra no cartão

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`creditCardId`	uuid	sim	Cartão
`purchasedAt`	string	sim	Data da compra
`description`	string	sim	Descrição
`totalAmount`	number	sim	Valor total
`installmentCount`	integer	sim	Parcelas (1–48)
`supplierId`	uuid	não	Fornecedor
`documentNumber`	string	não	Número do documento
`categoryId`	string	não	Categoria financeira
`costCenterId`	string	não	Centro de custo

Resposta: 201 Created

curl -X POST "https://api.nivesistemas.com.br/credit-cards/purchases" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"creditCardId":"00000000-0000-0000-0000-000000000000","purchasedAt":"","description":"","totalAmount":0,"installmentCount":1,"supplierId":"00000000-0000-0000-0000-000000000000","documentNumber":"","categoryId":"","costCenterId":""}'

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/purchases", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "creditCardId": "00000000-0000-0000-0000-000000000000",
    "purchasedAt": "",
    "description": "",
    "totalAmount": 0,
    "installmentCount": 1,
    "supplierId": "00000000-0000-0000-0000-000000000000",
    "documentNumber": "",
    "categoryId": "",
    "costCenterId": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/credit-cards/purchases",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "creditCardId": "00000000-0000-0000-0000-000000000000",
      "purchasedAt": "",
      "description": "",
      "totalAmount": 0,
      "installmentCount": 1,
      "supplierId": "00000000-0000-0000-0000-000000000000",
      "documentNumber": "",
      "categoryId": "",
      "costCenterId": ""
    },
)
print(res.json())

GET /credit-cards/purchases/:purchaseId

Detalhe da compra

Parâmetros de rota: purchaseId

curl -X GET "https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}", {
  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/credit-cards/purchases/{purchaseId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

PATCH /credit-cards/purchases/:purchaseId

Editar compra (mesmo corpo do lançamento)

Parâmetros de rota: purchaseId

curl -X PATCH "https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}", {
  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/credit-cards/purchases/{purchaseId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /credit-cards/purchases/:purchaseId/cancel

Cancelar compra

Parâmetros de rota: purchaseId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`reason`	string	não	Motivo

curl -X POST "https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}/cancel" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"reason":""}'

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}/cancel", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reason": ""
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/credit-cards/purchases/{purchaseId}/cancel",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "reason": ""
    },
)
print(res.json())

GET /credit-cards/invoices/:invoiceId

Detalhe da fatura

Parâmetros de rota: invoiceId

curl -X GET "https://api.nivesistemas.com.br/credit-cards/invoices/{invoiceId}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/invoices/{invoiceId}", {
  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/credit-cards/invoices/{invoiceId}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /credit-cards/invoices/:invoiceId/pay

Pagar fatura

Parâmetros de rota: invoiceId

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
`amount`	number	sim	Valor pago
`…`	—	não	Demais campos iguais ao pagamento de conta a pagar (data, conta, juros, multa, desconto)

curl -X POST "https://api.nivesistemas.com.br/credit-cards/invoices/{invoiceId}/pay" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"amount":0,"…":null}'

const res = await fetch("https://api.nivesistemas.com.br/credit-cards/invoices/{invoiceId}/pay", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "amount": 0,
    "…": null
  }),
});
const data = await res.json();

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/credit-cards/invoices/{invoiceId}/pay",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "amount": 0,
      "…": None
    },
)
print(res.json())