Extrato

Os lançamentos do saldo do parceiro, um a um.

GET/v1/financeiro/extrato

Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`limite`	número	50	Itens por página, de 1 a 100.
`cursor`	texto	—	O `proximoCursor` da resposta anterior.
`de`	data	—	Lançamentos a partir desta data (com fuso).
`ate`	data	—	Lançamentos até esta data (com fuso).

Exemplo

curl "https://api.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl "https://api-sandbox.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00', {
  headers: {
    Authorization: 'Bearer otl_prod_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

const resposta = await fetch('https://api-sandbox.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00', {
  headers: {
    Authorization: 'Bearer otl_sbx_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

<?php
$ch = curl_init('https://api.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_prod_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

<?php
$ch = curl_init('https://api-sandbox.otlshoes.com.br/v1/financeiro/extrato?de=2026-09-01T00%3A00%3A00-03%3A00');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_sbx_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

import requests

resposta = requests.get(
    "https://api.otlshoes.com.br/v1/financeiro/extrato",
    headers={
        "Authorization": "Bearer otl_prod_SEU_TOKEN",
    },
    params={
        "de": "2026-09-01T00:00:00-03:00"
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

import requests

resposta = requests.get(
    "https://api-sandbox.otlshoes.com.br/v1/financeiro/extrato",
    headers={
        "Authorization": "Bearer otl_sbx_SEU_TOKEN",
    },
    params={
        "de": "2026-09-01T00:00:00-03:00"
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

Testar agora no ambiente de testes

A chamada é feita de verdade, do seu navegador para a API de testes (https://api-sandbox.otlshoes.com.br/v1). Use um token otl_sbx_…: ele fica só nesta aba, e some ao fechá-la. Token de produção não é aceito aqui.

Token de testeGET

Resposta

{
  "dados": [
    {
      "id": "cmg9a2b3c0002",
      "tipo": "DEBITO",
      "valor": "-40.50",
      "descricao": "Ajuste de frete",
      "pedido": null,
      "criadoEm": "2026-09-27T10:30:00-03:00"
    },
    {
      "id": "cmg9a2b3c0001",
      "tipo": "CREDITO",
      "valor": "150.00",
      "descricao": "Devolução do pedido #12",
      "pedido": {
        "id": "cmg8k1p2a0007",
        "numero": 12
      },
      "criadoEm": "2026-09-25T09:00:00-03:00"
    }
  ],
  "paginacao": {
    "proximoCursor": null,
    "temMais": false
  }
}

Campo	Tipo	Descrição
`dados[].id`	texto	Identificador do lançamento. Não muda.
`dados[].tipo`	texto	`CREDITO` (a favor do parceiro) ou `DEBITO`.
`dados[].valor`	dinheiro	Com sinal: débito é negativo (`"-40.50"`). Somar os valores dá o saldo.
`dados[].descricao`	texto	O motivo, escrito pela equipe OTL.
`dados[].pedido`	objeto ou null	O pedido que originou o lançamento (`id` e `numero`), quando há um.
`dados[].criadoEm`	data	Quando foi lançado.
`paginacao`	objeto	Veja Paginação.

Regras que não se leem no JSON

A ordem é do lançamento mais recente para o mais antigo.
O extrato só cresce. Lançamento não é alterado nem removido — para sincronizar, basta guardar a data do último que você já tem e pedir de a partir dela (e ignorar os id repetidos).

Erros possíveis

HTTP	`codigo`	Quando
400	`PARAMETRO_INVALIDO`	`limite` fora de 1–100 ou data sem fuso
400	`CURSOR_INVALIDO`	Cursor alterado, ou de outra consulta
403	`ESCOPO_INSUFICIENTE`	A integração não tem `financeiro:ler`

Ver também

Saldo