Simula a taxa e os juros de parcelamento de uma venda da comunidade
POST/api/fees/simulate
- Auth
- Richiede un token
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Mesmo cálculo do checkout (`calculateFees`). Com `installments` > 1 no cartão, a resposta traz os juros de parcelamento da Memberfy (F-43): `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.
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
amountobbligatorio | number | Amount must be greater than 0 |
paymentMethodobbligatorio | PIX | CREDIT_CARD | DEBIT_CARD | BOLETO | Invalid payment method |
installmentsfacoltativo | integer | Installments must be between 1 and 12 |
feePayerfacoltativo | ORGANIZATION | BUYER | COMMUNITY | CUSTOMER | Quem paga a taxa da plataforma; padrão BUYER |
installmentInterestPayerfacoltativo | ORGANIZATION | BUYER | COMMUNITY | CUSTOMER | Quem paga os juros de parcelamento; padrão BUYER |
currencyfacoltativo | BRL | USD | EUR | Invalid currency |
countryCodefacoltativo | string | Country code must be 2 characters · min 2, max 2 |
Risposte
| Codice | Descrizione |
|---|---|
201 | Operação realizada com sucesso. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Esempio con 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"}'