Consulta balance
GET/api/ledger/balance
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | Saldo e taxa de saque. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
500 | Erro interno do servidor. |
curl example
curl -X GET "https://api.memberfy.net/api/ledger/balance" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"