Aller au contenu
memberfy
FR

Simula a taxa e os juros de parcelamento de uma venda da comunidade

POST/api/fees/simulate

Auth
Jeton requis
Clé d’API:
finance:write
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.

Mesmo cálculo do checkout (`calculateFees`). Com `installments` > 1 no cartão, a resposta traz os juros de parcelamento da Memberfy: `installmentInterestPayer`, `installmentInterestPercent`, `installmentInterest` (o que o comprador paga de juros; `0.00` quando a comunidade absorve), `totalWithInterest` e `installmentAmount`, além do objeto `installmentInterest` dentro do cálculo. `feePayer` e `installmentInterestPayer` aceitam `ORGANIZATION`/`BUYER` (e os nomes antigos `COMMUNITY`/`CUSTOMER`); o padrão dos dois é `BUYER`, como num produto. Nunca traz custo do provedor.

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.

Corps de la requête application/json

NomTypeDescription
amountobligatoirenumberAmount must be greater than 0
paymentMethodobligatoirePIX | CREDIT_CARD | DEBIT_CARD | BOLETOInvalid payment method
installmentsfacultatifintegerInstallments must be between 1 and 12
feePayerfacultatifORGANIZATION | BUYER | COMMUNITY | CUSTOMERQuem paga a taxa da plataforma; padrão BUYER
installmentInterestPayerfacultatifORGANIZATION | BUYER | COMMUNITY | CUSTOMERQuem paga os juros de parcelamento; padrão BUYER
currencyfacultatifBRL | USD | EURInvalid currency
countryCodefacultatifstringCountry code must be 2 characters · min 2, max 2

Réponses

StatutDescription
201Operaçã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 POST "https://api.memberfy.net/api/fees/simulate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"amount":10,"paymentMethod":"PIX"}'