Pular para o conteúdo principal

Vendas

GET/v1/sales

As vendas de cartão do cliente, em todas as adquirentes conectadas, criadas ou alteradas a partir de uma data, em páginas numeradas.

Autenticação: Authorization: Bearer <access_token> e X-Company-Token: <company_token>.

Parâmetros de consulta​

ParâmetroTipoPadrãoDescrição
updated_sincedata e hora ISO 8601Traz as vendas criadas ou alteradas a partir deste instante (inclusive). Sem ele, vêm todas as vendas dos últimos 90 dias. Não pode estar mais de 5 minutos no futuro. Ex.: 2026-10-01T00:00:00Z.
pageinteiro1Número da página, de 1 a 10000.
page_sizeinteiro500Itens por página, de 1 a 1000.
acquirerstringSó uma adquirente: REDE, STONE, PAGBANK ou CIELO.
merchant_codestringSó um estabelecimento (PV, StoneCode etc.). Até 60 caracteres.
date_fromdata YYYY-MM-DD90 dias atrásVendas com sale_date a partir deste dia. Não pode ser anterior a 90 dias atrás.
date_todata YYYY-MM-DDVendas com sale_date até este dia. Não pode ser anterior a 90 dias atrás.

:::info Últimos 90 dias A API entrega só vendas e recebimentos com data de até 90 dias atrás (no horário de Brasília). Recebimentos com crédito previsto para o futuro aparecem normalmente. date_from ou date_to antes desse limite dão 400. :::

:::info Mesmos parâmetros em todas as páginas Ao passar de uma página para a outra, mude só o page. O updated_since, o page_size e os filtros devem ser os mesmos da página 1. :::

:::tip Todas as vendas de um dia Sem updated_since e com date_from e date_to, vêm todas as vendas do período, novas ou antigas. Veja Consultar um dia ou período. :::

curl "$BASE_URL/v1/sales?updated_since=2026-10-01T00:00:00Z&page=1&page_size=1000" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Company-Token: $COMPANY_TOKEN"

curl "$BASE_URL/v1/sales?updated_since=2026-10-01T00:00:00Z&page=2&page_size=1000" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Company-Token: $COMPANY_TOKEN"

Resposta 200​

{
  "message": "Vendas",
  "result": true,
  "data": {
    "items": [
      {
        "id": "84213",
        "acquirer": "REDE",
        "merchant_code": "12345678",
        "nsu": "000123456",
        "authorization_code": "A1B2C3",
        "tid": "10017372230206210001",
        "order_number": "PED-2026-0042",
        "sale_date": "2026-10-01",
        "sale_hour": "14:22:05",
        "brand_code": "1",
        "modality": "CREDIT",
        "installments": 3,
        "capture_type": "POS",
        "card_number": "532930******7894",
        "status": "APPROVED",
        "gross_amount": "150.000000",
        "mdr_amount": "3.750000",
        "net_amount": "146.250000",
        "updated_at": "2026-10-02T06:15:03.482915Z"
      }
    ],
    "page": 1,
    "page_size": 1000,
    "has_more": false,
    "next_updated_since": "2026-10-21T15:42:10.000Z"
  },
  "error": null
}

Página​

Campo de dataTipoDescrição
itemsarrayVendas da página, em ordem de id.
pagenumberNúmero desta página.
page_sizenumberItens por página pedidos.
has_morebooleantrue: há mais páginas, peça page + 1. false: esta foi a última.
next_updated_sincestring ISO 8601 ou nullSó na página 1 (nas outras, null). É o horário da consulta menos 30 segundos. Use como updated_since na próxima rodada.

Venda​

Campos que podem vir null estão marcados como "ou null": nem toda adquirente informa todos eles.

CampoTipoDescrição
idstringIdentificador da venda no Concilia+. Estável. Use para deduplicar.
acquirerstringAdquirente: REDE, STONE, PAGBANK ou CIELO.
merchant_codestringCódigo do estabelecimento na adquirente (PV, StoneCode etc.).
nsustringNSU da transação na adquirente.
authorization_codestring ou nullCódigo de autorização.
tidstring ou nullIdentificador da transação (TID).
order_numberstring ou nullNúmero do pedido no e-commerce. Bom para cruzar com o pedido no seu sistema.
sale_datestring YYYY-MM-DDData da venda.
sale_hourstring HH:MM:SS ou nullHora da venda, no horário informado pela adquirente.
brand_codestring ou nullCódigo da bandeira, como informado pela adquirente.
modalitystring ou nullModalidade, por exemplo CREDIT ou DEBIT.
installmentsnumberQuantidade de parcelas (1 = à vista).
capture_typestring ou nullForma de captura, por exemplo POS ou ECOMMERCE.
card_numberstring ou nullNúmero do cartão mascarado (ex.: 532930******7894). O número completo nunca é guardado.
statusstringSituação da venda, por exemplo APPROVED ou CANCELED.
gross_amountstring decimalValor bruto da venda, em reais.
mdr_amountstring decimal ou nullTaxa (MDR) cobrada pela adquirente, em reais.
net_amountstring decimal ou nullValor líquido, em reais.
updated_atstring ISO 8601Última alteração da venda no Concilia+ (UTC, com microssegundos).

Comportamento importante​

  • Uma venda alterada volta a aparecer. Um cancelamento, por exemplo, muda o status e o updated_at, e a venda reaparece na próxima rodada. Faça upsert pelo id: atualize se já existe, insira se não.
  • Pode haver repetição. Se uma venda for alterada enquanto você pagina, ela pode vir em duas páginas seguidas. E como o next_updated_since começa 30 segundos antes da consulta, as vendas alteradas nesses 30 segundos voltam na rodada seguinte. O upsert pelo id resolve. Nenhuma venda é pulada.
  • Nada é apagado. Cancelamento é mudança de status, não exclusão.

O passo a passo está em Sincronização incremental.

Erros​

CódigoQuando
400updated_since mais de 5 minutos no futuro; page fora de 1–10000; page_size fora de 1–1000; acquirer desconhecida; data fora do formato YYYY-MM-DD; date_from ou date_to antes de 90 dias atrás; date_from depois de date_to; intervalo entre date_from e date_to acima de 366 dias; parâmetro desconhecido.
401Token de acesso ou company_token ausente, vencido, revogado ou inválido. Veja Quando dá 401.
429Limite por minuto excedido.