Skip to main content
GET
Consultar saldo
provider e withdrawable vêm null quando a consulta ao provedor falha. null não é zero: zero diria que não há dinheiro, quando o que houve foi uma consulta que não respondeu. Ver Saldo do vendedor.

Authorizations

Authorization
string
header
required

Chave secreta do vendedor, criada no painel em Desenvolvedores.

O valor em claro existe uma única vez, na criação. Guardamos só o hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto: um dump do nosso banco não permite cobrar em nome de ninguém.

A chave vai no servidor. Colocá-la no navegador do comprador a entrega a qualquer pessoa que abra a página.

Response

Saldo da conta.

object
string
required
Allowed value: "balance"
currency
string
required
Allowed value: "BRL"
balance
integer<int64>
required

Saldo do extrato, em centavos inteiros. Pode ser NEGATIVO - acontece quando um estorno chega depois do saque.

available
integer<int64>
required

O que já pode sair pelo nosso extrato, em centavos inteiros. Nunca negativo: veja debt.

reserved
integer<int64>
required

Retido pela reserva rolante, em centavos inteiros. É dinheiro do vendedor que ainda não pode sair - sem este campo, a diferença entre balance e available pareceria erro do sistema.

debt
integer<int64>
required

Quanto o vendedor deve, em centavos inteiros. Estado próprio, e não "saldo zero": as próximas vendas cobrem automaticamente e só o saque fica bloqueado até lá.

withdrawable
integer<int64> | null

O que dá para sacar AGORA, em centavos inteiros. null quando a consulta ao provedor falhou.

provider
object | null

null quando a consulta ao provedor falhou. Diferente de zero.