Pular para o conteúdo
LeztyPay docs
Painel

Saques

Cobrança paga vira saldo. Saldo vira dinheiro na sua conta por meio de um saque para uma chave PIX.

#!/usr/bin/env bash
# Saldo do ambiente da chave. Todos os valores são inteiros em centavos.
set -euo pipefail

curl --fail-with-body -sS "$LM_API_URL/v1/balance" \
  -H "Authorization: Bearer $LM_API_KEY"

Todos os números do saldo são inteiros em centavos, e valem para o ambiente da chave que você usou.

O que cada número quer dizer

  • available é o que você pode sacar agora. É o único número que importa na hora de pedir um saque.
  • reserve é o líquido retido, que ainda não virou disponível. Sai automaticamente, no prazo.
  • pending_withdraw é o que já está preso num saque em andamento. Saiu de available e ainda não saiu da conta.
  • gross, fees, refunds, chargebacks e withdrawn são acumulados históricos, para conferência, não para decisão.

available pode ficar negativo. Um estorno ou uma contestação de uma venda cujo dinheiro já foi sacado tira do saldo o que não está mais lá. Enquanto estiver negativo, nenhum saque passa.

Por que existe reserva

Uma parte do líquido de cada venda paga fica retida por alguns dias. Ela cobre estorno e contestação, que chegam depois da venda.

A regra é simples:

  • A reserva é calculada sobre o líquido da cobrança, na criação, com o mesmo percentual e o mesmo prazo congelados na taxa daquela cobrança.
  • O prazo conta a partir do pagamento, não da criação.
  • Quando vence, o valor vira available sozinho e você recebe o evento transaction.reserve_released.

Se o percentual de reserva da sua conta mudar, cobranças antigas continuam com o percentual delas. Nada é recalculado.

Quando o dinheiro fica disponível

Em ordem, para uma venda:

  1. A cobrança é paga. net entra, sendo que a parte reserve entra retida.
  2. A diferença entre net e reserve já é available, imediatamente.
  3. Passado o prazo da reserva, o restante vira available.

Não existe janela de fechamento nem dia de repasse: assim que o valor está em available, o saque pode ser pedido.

Acompanhar pelo evento, não pelo relógio

Para saber que a reserva saiu, escute transaction.reserve_released em vez de calcular a data. A liberação roda em ciclos, então ela acontece pouco depois do vencimento, não no segundo exato.

Próximo passo

Chave PIX: você só saca para uma chave verificada, e ela tem uma regra que surpreende.

Referência: Saldo e agregados do seller no mode da API key.