Consultar saldo da conta

Consulte o saldo disponível da mesma carteira exibida no painel, usando uma chave vinculada à sua loja.

Leitura de 3 min

GET/api/v1/balancebalance:read

#Consulte o saldo disponível

A operação é somente leitura. A loja é identificada pela chave de acesso; você não precisa enviar parâmetros, conta bancária ou corpo JSON.

Consultar saldocURL

curl --fail-with-body "https://api.mivy.com.br/api/v1/balance" \
  -H "Authorization: Bearer $MIVY_API_KEY"

Resposta ilustrativaJSON

{
  "data": {
    "availableBalance": 98.65,
    "currency": "BRL"
  }
}

Consultar no servidor — Node.js 20+JavaScript

import { MivyClient } from './mivy-client.mjs';

const mivy = new MivyClient(process.env.MIVY_API_KEY);
const balance = await mivy.getBalance();
console.log(balance.availableBalance, balance.currency);

#Como interpretar o retorno

O resultado corresponde à carteira da loja vinculada à chave, incluindo os créditos já confirmados. Um Pix criado e ainda não pago não aumenta esse saldo. Esta consulta não retorna o saldo bancário global da plataforma.

Campo	Tipo	Significado
availableBalance	number	Saldo disponível em reais, já descontando saques aprovados e valores reservados em solicitações pendentes.
currency	string	Moeda BRL.

#Permissões e atualização

Uma chave sem balance:read recebe 403. Uma chave inválida, excluída, revogada ou expirada recebe 401. Para atualizar o saldo após um recebimento, consulte novamente quando receber a confirmação autenticada por webhook ou WebSocket.

Gerenciar chave da API Abrir carteira da Mivy

AnteriorCriar depósito Pix Próximo Webhooks

Encontrou algo que pode ser melhorado? Consulte a central de ajuda.