Aller au contenu

Consulta balance

GET/api/ledger/balance

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
finance
Clé d’API:
finance:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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` = withdrawableBalance − transferFee, mínimo 0), para a tela mostrar a taxa antes de confirmar. O saldo é por moeda e por data. `total` é a soma dos lançamentos que movem dinheiro (venda líquida, reserva, reembolso, chargeback, saque, ajuste; não soma mais bruto e líquido). `pending` é o líquido de venda que ainda não chegou à data de liberação (30 dias por padrão, regra no banco; parcela k de cartão parcelado no maior entre o prazo e k meses), `retained` é a reserva de chargeback ainda retida (4% do bruto de toda venda, cartão, PIX ou boleto, por 60 dias), `available` é o resto e não é cortado em 0: abaixo de zero, `owed` diz quanto a comunidade deve. Os campos de cima são os da moeda de `?currency=` (BRL por padrão); `balances` traz um saldo por moeda em que a comunidade tem lançamentos (BRL sempre). `minPayoutAmount` é o menor saque aceito (o maior entre o mínimo do produto e o do provedor). `pendingRefunds` é a parte da comunidade nos reembolsos aguardando saldo (`AWAITING_BALANCE`); ela sai antes de qualquer saque, então `withdrawableBalance` = menor entre `available` e o saldo da conta de recebimento, menos `pendingRefunds` (nunca negativo), e `maxPayoutAmount` = `withdrawableBalance` − `transferFee`.

Paramètres

NomEmplacementTypeDescription
currencyfacultatifqueryBRL | USD | EUR | GBP | MXN | ARSA moeda dos campos de cima (BRL por padrão); `balances` traz todas.

En-têtes

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

Réponses

StatutDescription
200Saldo e taxa de saque.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
500Erro interno do servidor.

Exemple curl

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