Aller au contenu

Taxas da comunidade

GET/api/fees

Auth
Jeton requis
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.

A taxa da plataforma que vale para a comunidade (o override dela, campo a campo sobre a regra da plataforma), limites de saque, métodos de pagamento e exemplos. `installmentRates` traz os juros de parcelamento da Memberfy no cartão, % total sobre o valor por número de parcelas (`{ "2": "4.29", ..., "12": "6.00" }`; 1× é 0). `examples` traz "PIX R$ 100", "Cartão 1x R$ 300" e, com juros pagos pelo comprador, "Cartão 6x R$ 300" e "Cartão 12x R$ 300" (estes com `installments`, `installmentInterestPercent`, `installmentInterest`, `totalWithInterest` e `installmentAmount`).

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
200Operação realizada com sucesso.
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`).
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

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