Pular para o conteúdo principal
O objeto Saldo (Balance) representa o estado financeiro atual da sua conta Safefy. Ele fornece informacoes sobre saldo disponivel, pendente, reservado e totais acumulados.

Estrutura

{
  "currency": "BRL",
  "balance": {
    "available": 1500000,
    "pending": 250000,
    "reserved": 50000,
    "total": 1800000
  },
  "totals": {
    "lifetimeVolume": 50000000,
    "lifetimePayouts": 35000000,
    "lifetimeRefunds": 500000
  },
  "period": {
    "volumeToday": 500000,
    "volumeThisWeek": 2500000,
    "volumeThisMonth": 10000000
  },
  "updatedAt": "2024-01-15T10:30:00Z"
}

Atributos

currency
string
obrigatório
Moeda do saldo. Atualmente apenas BRL (Real Brasileiro) e suportado.
balance
object
obrigatório
Informacoes do saldo atual da conta.
totals
object
obrigatório
Totais acumulados desde a criacao da conta.
period
object
obrigatório
Volume processado por periodo.
updatedAt
string
obrigatório
Data e hora da ultima atualizacao do saldo no formato ISO 8601.

Entendendo o Saldo

Saldo Disponivel (available)

O valor que voce pode sacar imediatamente para sua conta bancaria. Este saldo ja foi confirmado e esta livre para uso.

Saldo Pendente (pending)

Pagamentos que foram recebidos mas ainda estao em periodo de processamento ou liquidacao. Apos a confirmacao, esse valor sera movido para o saldo disponivel.

Saldo Reservado (reserved)

Valores temporariamente bloqueados para:
  • Saques em processamento
  • Disputas em andamento
  • Garantias de chargebacks

Saldo Total (total)

A soma de todos os saldos: available + pending + reserved.

Fluxo do Saldo

Pagamento Recebido

   [Pending]

  Confirmado

  [Available]

   Saque Solicitado

  [Reserved]

  Saque Concluido

  Conta Bancaria

Exemplos de Valores

Valor em CentavosValor em Reais
100R$ 1,00
1500R$ 15,00
15000R$ 150,00
150000R$ 1.500,00
1500000R$ 15.000,00

Endpoints

MetodoEndpointDescricao
GET/v1/balanceConsultar saldo