Conta

Consultar saldo

Retorna o saldo atual da conta em três baldes, sempre em centavos. O valor é lido do saldo materializado, consistente e barato de consultar.

GET/v1/balance

Headers

x-api-keystringobrigatório

Sua chave de API com escopo balance:read.

availableintegeropcional

Saldo gastável (em centavos). É o que pode ser usado em pagamentos agora.

restrictedintegeropcional

Retido por política/risco ou PIX em trânsito. Não disponível para uso.

pendingintegeropcional

Entrou mas ainda não liberou (liquidação futura). Zero hoje no MVP.

totalintegeropcional

available + restricted + pending.

currencystringopcional

Sempre BRL.

Valores em centavos

95189 equivale a R$ 951,89. Divida por 100 para exibir.

Requisição

curl https://apiv2.onnixpay.com/v1/balance \
  -H "x-api-key: sk_live_sua_chave_aqui"

Resposta

{
  "object": "balance",
  "currency": "BRL",
  "available": 95189,
  "restricted": 0,
  "pending": 0,
  "total": 95189
}