Saldo e saques

Os saldos

Seu dinheiro fica separado em baldes. A diferença entre eles importa:

• A liberar (pending) — recebido, mas ainda dentro do prazo de liquidação.
• Disponível (available) — liberado. É o que pode ser sacado.
• Reserva (reserve) — percentual retido conforme o plano da conta, liberado depois da janela de retenção.
• Em saque (payout_hold) — valor reservado em um saque em andamento.

Os prazos de liquidação e o percentual de reserva ficam no painel. Veja Taxas e liquidação.

Consultar o saldo

Requer o escopo balance:read. Base URL: https://app.slimpay.com.br/api/v1.

{
  "available": 1284350,
  "pending": 349900,
  "reserve": 64217,
  "payout_hold": 0,
  "total": 1697567,
  "currency": "BRL"
}

Extrato

Cada linha é um lançamento imutável do ledger. Nada é editado ou apagado: uma correção entra como um novo lançamento.

{
  "id": "ltx_01j9x4r9p3m6s8t5v7x1z4b6",
  "kind": "charge_paid",
  "description": "Pedido #1042",
  "metadata": { "charge_id": "chg_01j9x2m4k8p3q7r5t1v6w8y0" },
  "created_at": "2026-07-25T14:32:11Z"
}

Kinds comuns: charge_paid, settlement, reserve_release, payout_hold, payout_paid, payout_reversed, manual_adjustment.

Solicitar um saque

Requer o escopo payouts:write. O valor sai do saldo disponível no instante da solicitação (hold). A chave precisa estar cadastrada no painel.

curl https://app.slimpay.com.br/api/v1/payouts \
  -H "Authorization: Bearer ax_sua_chave" \
  -H "Idempotency-Key: saque-2026-07-25" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500000,
    "pix_key": "financeiro@minhaloja.com.br",
    "pix_key_type": "email"
  }'

Restrição de destino

Só entram chaves da whitelist da conta. Chaves CPF/CNPJ precisam coincidir com o documento verificado da conta. Chaves de terceiros são recusadas.

Status do saque

• awaiting_approval — aguardando confirmação ou análise.
• processing — enviado ao provedor.
• completed — o valor chegou à conta de destino.
• rejected — recusado. O valor volta ao disponível.
• failed — falha na transferência. Motivo em failure_reason.

Acompanhe pelos eventos payout.completed e payout.failed.

Consultar e listar saques