Saltar para o conteúdo

Consulta balance

GET/api/ledger/balance

Auth
Exige token
Quem pode:
owner
admin
finance
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Exige autenticação e papel financeiro (owner, admin ou finance) na comunidade do X-CommunityId. Além do saldo, devolve a taxa de saque vigente (`transferFee`, cobrada por cima do valor pedido) e o maior valor que pode ser sacado agora (`maxPayoutAmount` = available − transferFee, mínimo 0), para a tela mostrar a taxa antes de confirmar (FIN-45).

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respostas

CódigoDescrição
200Saldo e taxa de saque.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
500Erro interno do servidor.

Exemplo com curl

curl -X GET "https://api.memberfy.net/api/ledger/balance" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"