Saltar al contenido

Consulta balance

GET/api/ledger/balance

Auth
Requiere token
Quién puede:
owner
admin
finance
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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

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

Respuestas

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

Ejemplo con curl

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