Saldo

Quanto o parceiro tem a receber da OTL (ou deve), somando todos os lançamentos.

GET/v1/financeiro/saldo

Quando usar

Para mostrar no seu sistema o saldo do parceiro com a OTL. Os lançamentos são feitos pela equipe OTL — uma devolução que vira crédito, um ajuste, um bônus.

Exemplo

curl "https://api.otlshoes.com.br/v1/financeiro/saldo" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl "https://api-sandbox.otlshoes.com.br/v1/financeiro/saldo" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/financeiro/saldo', {
  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/saldo', {
  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/saldo');
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/saldo');
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/saldo",
    headers={
        "Authorization": "Bearer otl_prod_SEU_TOKEN",
    },
    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/saldo",
    headers={
        "Authorization": "Bearer otl_sbx_SEU_TOKEN",
    },
    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

{
  "saldo": "109.50",
  "creditos": "150.00",
  "debitos": "40.50"
}

Campo	Tipo	Descrição
`saldo`	dinheiro	`creditos` − `debitos`. Positivo = a favor do parceiro. Pode ser negativo (`"-25.00"`).
`creditos`	dinheiro	Soma de tudo que foi creditado.
`debitos`	dinheiro	Soma de tudo que foi debitado, sem sinal.

O saldo é informativo

O saldo não é descontado automaticamente do total de um pedido. O acerto é combinado com a equipe OTL no pagamento. Não use o saldo para abater valores no seu sistema por conta própria.

Regras que não se leem no JSON

É acumulado, desde o primeiro lançamento — não há saldo “do mês”. Para um período, some o extrato.
Lançamento nunca é editado nem apagado: um erro é corrigido com um lançamento contrário. O saldo só muda quando entra um lançamento novo.

Erros possíveis

HTTP	`codigo`	Quando
403	`ESCOPO_INSUFICIENTE`	A integração não tem `financeiro:ler`