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
Moeda do saldo. Atualmente apenas BRL (Real Brasileiro) e suportado.
Informacoes do saldo atual da conta. Mostrar Atributos do balance
Saldo disponivel para saque em centavos. Este valor pode ser transferido para sua conta bancaria.
Saldo pendente em centavos. Pagamentos aguardando confirmacao ou em periodo de liquidacao.
Saldo reservado em centavos. Valores bloqueados para saques em processamento ou disputas.
Saldo total em centavos. Soma de available + pending + reserved.
Totais acumulados desde a criacao da conta. Mostrar Atributos dos totals
Volume total processado em centavos desde a criacao da conta.
Total de saques realizados em centavos desde a criacao da conta.
Total de estornos em centavos desde a criacao da conta.
Volume processado por periodo. Mostrar Atributos do period
Volume processado hoje em centavos.
Volume processado nesta semana em centavos.
Volume processado neste mes em centavos.
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 Centavos Valor em Reais 100R$ 1,00 1500R$ 15,00 15000R$ 150,00 150000R$ 1.500,00 1500000R$ 15.000,00
Endpoints
Metodo Endpoint Descricao GET/v1/balanceConsultar saldo