Consulta balance
GET/api/payouts/balance
- Auth
- Exige token
- Quem pode:
- owner
- admin
- finance
- X-CommunityId
X-CommunityIdEnvie 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 de total, available, retained, pending e currency, devolve a taxa de saque vigente (`transferFee`) e o maior valor que pode ser pedido agora (`maxPayoutAmount` = available − transferFee, nunca negativo). A taxa de saque é cobrada por cima do valor pedido (FIN-45).
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
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. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/payouts/balance" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"